From b58e76b3777a8a3b9065c50688c22e34a165c18d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:56 +0000 Subject: [PATCH 01/84] chore: update docs/dyn/index.md --- docs/dyn/index.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/dyn/index.md b/docs/dyn/index.md index dc4fca983d..bc55431ed6 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -50,6 +50,18 @@ * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/advisorynotifications_v1.html) +## agentidentity +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/agentidentity_v1.html) +* [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/agentidentity_v1alpha.html) +* [v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/agentidentity_v1beta.html) + + +## agentidentitycredentials +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/agentidentitycredentials_v1.html) +* [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/agentidentitycredentials_v1alpha.html) +* [v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/agentidentitycredentials_v1beta.html) + + ## agentregistry * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/agentregistry_v1.html) * [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/agentregistry_v1alpha.html) From 6283f12e5f9f47ade2247cdc97816ae46867fa0d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:56 +0000 Subject: [PATCH 02/84] feat(accesscontextmanager): update the api #### accesscontextmanager:v1 The following keys were added: - schemas.GcpUserAccessBinding.properties.principal.$ref (Total Keys: 1) - schemas.GcpUserAccessBinding.properties.restrictedClientApplications.deprecated (Total Keys: 1) - schemas.Principal (Total Keys: 4) --- ...1.organizations.gcpUserAccessBindings.html | 24 +++++++++++++++---- .../documents/accesscontextmanager.v1.json | 24 +++++++++++++++++-- 2 files changed, 42 insertions(+), 6 deletions(-) diff --git a/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html b/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html index bde399dcf6..7291bb9da5 100644 --- a/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html +++ b/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html @@ -119,7 +119,11 @@

Method Details

], "groupKey": "A String", # Optional. Immutable. Google Group id whose users are subject to this binding's restrictions. See "id" in the [Google Workspace Directory API's Group Resource] (https://developers.google.com/admin-sdk/directory/v1/reference/groups#resource). If a group's email address/alias is changed, this resource will continue to point at the changed group. This field does not accept group email addresses or aliases. Example: "01d520gv4vjcrht" "name": "A String", # Immutable. Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N" - "restrictedClientApplications": [ # Optional. 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. + "principal": { # The comprehensive identity container supporting identities including groups, service accounts and federated identities. Only one of them can be set to create an access binding. # Optional. Immutable. The principal that is subject to the access policies in this policy binding. + "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 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" @@ -257,7 +261,11 @@

Method Details

], "groupKey": "A String", # Optional. Immutable. Google Group id whose users are subject to this binding's restrictions. See "id" in the [Google Workspace Directory API's Group Resource] (https://developers.google.com/admin-sdk/directory/v1/reference/groups#resource). If a group's email address/alias is changed, this resource will continue to point at the changed group. This field does not accept group email addresses or aliases. Example: "01d520gv4vjcrht" "name": "A String", # Immutable. Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N" - "restrictedClientApplications": [ # Optional. 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. + "principal": { # The comprehensive identity container supporting identities including groups, service accounts and federated identities. Only one of them can be set to create an access binding. # Optional. Immutable. The principal that is subject to the access policies in this policy binding. + "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 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" @@ -336,7 +344,11 @@

Method Details

], "groupKey": "A String", # Optional. Immutable. Google Group id whose users are subject to this binding's restrictions. See "id" in the [Google Workspace Directory API's Group Resource] (https://developers.google.com/admin-sdk/directory/v1/reference/groups#resource). If a group's email address/alias is changed, this resource will continue to point at the changed group. This field does not accept group email addresses or aliases. Example: "01d520gv4vjcrht" "name": "A String", # Immutable. Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N" - "restrictedClientApplications": [ # Optional. 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. + "principal": { # The comprehensive identity container supporting identities including groups, service accounts and federated identities. Only one of them can be set to create an access binding. # Optional. Immutable. The principal that is subject to the access policies in this policy binding. + "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 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" @@ -423,7 +435,11 @@

Method Details

], "groupKey": "A String", # Optional. Immutable. Google Group id whose users are subject to this binding's restrictions. See "id" in the [Google Workspace Directory API's Group Resource] (https://developers.google.com/admin-sdk/directory/v1/reference/groups#resource). If a group's email address/alias is changed, this resource will continue to point at the changed group. This field does not accept group email addresses or aliases. Example: "01d520gv4vjcrht" "name": "A String", # Immutable. Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N" - "restrictedClientApplications": [ # Optional. 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. + "principal": { # The comprehensive identity container supporting identities including groups, service accounts and federated identities. Only one of them can be set to create an access binding. # Optional. Immutable. The principal that is subject to the access policies in this policy binding. + "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 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" diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index 96488cc53e..b03b535f3e 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1331,7 +1331,7 @@ } } }, -"revision": "20260707", +"revision": "20260722", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1975,8 +1975,13 @@ "description": "Immutable. Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: \"organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N\"", "type": "string" }, +"principal": { +"$ref": "Principal", +"description": "Optional. Immutable. The principal that is subject to the access policies in this policy binding." +}, "restrictedClientApplications": { -"description": "Optional. 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.", +"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" }, @@ -2408,6 +2413,21 @@ }, "type": "object" }, +"Principal": { +"description": "The comprehensive identity container supporting identities including groups, service accounts and federated identities. Only one of them can be set to create an access binding.", +"id": "Principal", +"properties": { +"serviceAccount": { +"description": "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 policy will be used for the enforcement.", +"type": "string" +}, +"serviceAccountProjectNumber": { +"description": "Immutable. Cloud project number used to assign policies to all service accounts owned by the project.", +"type": "string" +} +}, +"type": "object" +}, "PrivateServiceConnectEndpoint": { "description": "Specifies the Private Service Connect endpoint that an API call refers to.", "id": "PrivateServiceConnectEndpoint", From 2859520c7371ae25cb3f61e63bc81573d0ed9f22 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:56 +0000 Subject: [PATCH 03/84] feat(admin): update the api #### admin:directory_v1 The following keys were added: - schemas.ExternalId (Total Keys: 4) - schemas.Group.properties.externalIds (Total Keys: 2) #### admin:reports_v1 The following keys were added: - resources.activities.methods.list.parameters.agentInfoFilter (Total Keys: 2) - resources.activities.methods.list.parameters.deviceFilter (Total Keys: 2) - schemas.Activity.properties.actor.properties.agentAttributionInfo.$ref (Total Keys: 1) - schemas.Activity.properties.isAgenticAction.type (Total Keys: 1) - schemas.Activity.properties.userDeviceInfo.$ref (Total Keys: 1) - schemas.ActivityUserDeviceInfo (Total Keys: 8) - schemas.AgentAttributionInfo (Total Keys: 9) The following keys were changed: - resources.activities.methods.list.parameters.applicationName.pattern (Total Keys: 1) --- docs/dyn/admin_directory_v1.groups.html | 48 ++++++++++ docs/dyn/admin_reports_v1.activities.html | 21 ++++- .../documents/admin.directory_v1.json | 24 ++++- .../documents/admin.reports_v1.json | 88 ++++++++++++++++++- 4 files changed, 174 insertions(+), 7 deletions(-) diff --git a/docs/dyn/admin_directory_v1.groups.html b/docs/dyn/admin_directory_v1.groups.html index 4351ded25c..4b23a6004b 100644 --- a/docs/dyn/admin_directory_v1.groups.html +++ b/docs/dyn/admin_directory_v1.groups.html @@ -145,6 +145,12 @@

Method Details

"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. "etag": "A String", # ETag of the resource. + "externalIds": [ # Optional. The list of external IDs for the group, such as an immutable identifier from an external identity provider or directory sync client. Each entry contains a namespace and an ID value. + { # External identifier used to link and identify this group across external directory systems. + "id": "A String", # The unique identifier string assigned by the external provider. + "namespace": "A String", # The system or identity provider managing this ID. + }, + ], "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. "name": "A String", # The group's display name. @@ -171,6 +177,12 @@

Method Details

"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. "etag": "A String", # ETag of the resource. + "externalIds": [ # Optional. The list of external IDs for the group, such as an immutable identifier from an external identity provider or directory sync client. Each entry contains a namespace and an ID value. + { # External identifier used to link and identify this group across external directory systems. + "id": "A String", # The unique identifier string assigned by the external provider. + "namespace": "A String", # The system or identity provider managing this ID. + }, + ], "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. "name": "A String", # The group's display name. @@ -196,6 +208,12 @@

Method Details

"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. "etag": "A String", # ETag of the resource. + "externalIds": [ # Optional. The list of external IDs for the group, such as an immutable identifier from an external identity provider or directory sync client. Each entry contains a namespace and an ID value. + { # External identifier used to link and identify this group across external directory systems. + "id": "A String", # The unique identifier string assigned by the external provider. + "namespace": "A String", # The system or identity provider managing this ID. + }, + ], "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. "name": "A String", # The group's display name. @@ -243,6 +261,12 @@

Method Details

"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. "etag": "A String", # ETag of the resource. + "externalIds": [ # Optional. The list of external IDs for the group, such as an immutable identifier from an external identity provider or directory sync client. Each entry contains a namespace and an ID value. + { # External identifier used to link and identify this group across external directory systems. + "id": "A String", # The unique identifier string assigned by the external provider. + "namespace": "A String", # The system or identity provider managing this ID. + }, + ], "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. "name": "A String", # The group's display name. @@ -288,6 +312,12 @@

Method Details

"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. "etag": "A String", # ETag of the resource. + "externalIds": [ # Optional. The list of external IDs for the group, such as an immutable identifier from an external identity provider or directory sync client. Each entry contains a namespace and an ID value. + { # External identifier used to link and identify this group across external directory systems. + "id": "A String", # The unique identifier string assigned by the external provider. + "namespace": "A String", # The system or identity provider managing this ID. + }, + ], "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. "name": "A String", # The group's display name. @@ -313,6 +343,12 @@

Method Details

"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. "etag": "A String", # ETag of the resource. + "externalIds": [ # Optional. The list of external IDs for the group, such as an immutable identifier from an external identity provider or directory sync client. Each entry contains a namespace and an ID value. + { # External identifier used to link and identify this group across external directory systems. + "id": "A String", # The unique identifier string assigned by the external provider. + "namespace": "A String", # The system or identity provider managing this ID. + }, + ], "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. "name": "A String", # The group's display name. @@ -340,6 +376,12 @@

Method Details

"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. "etag": "A String", # ETag of the resource. + "externalIds": [ # Optional. The list of external IDs for the group, such as an immutable identifier from an external identity provider or directory sync client. Each entry contains a namespace and an ID value. + { # External identifier used to link and identify this group across external directory systems. + "id": "A String", # The unique identifier string assigned by the external provider. + "namespace": "A String", # The system or identity provider managing this ID. + }, + ], "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. "name": "A String", # The group's display name. @@ -365,6 +407,12 @@

Method Details

"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. "etag": "A String", # ETag of the resource. + "externalIds": [ # Optional. The list of external IDs for the group, such as an immutable identifier from an external identity provider or directory sync client. Each entry contains a namespace and an ID value. + { # External identifier used to link and identify this group across external directory systems. + "id": "A String", # The unique identifier string assigned by the external provider. + "namespace": "A String", # The system or identity provider managing this ID. + }, + ], "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. "name": "A String", # The group's display name. diff --git a/docs/dyn/admin_reports_v1.activities.html b/docs/dyn/admin_reports_v1.activities.html index 12fc870483..bf07eaa9a3 100644 --- a/docs/dyn/admin_reports_v1.activities.html +++ b/docs/dyn/admin_reports_v1.activities.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- list(userKey, applicationName, actorIpAddress=None, applicationInfoFilter=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, includeSensitiveData=None, maxResults=None, networkInfoFilter=None, orgUnitID=None, pageToken=None, resourceDetailsFilter=None, startTime=None, statusFilter=None, x__xgafv=None)

+ list(userKey, applicationName, actorIpAddress=None, agentInfoFilter=None, applicationInfoFilter=None, customerId=None, deviceFilter=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, includeSensitiveData=None, maxResults=None, networkInfoFilter=None, orgUnitID=None, pageToken=None, resourceDetailsFilter=None, startTime=None, statusFilter=None, x__xgafv=None)

Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides.

list_next()

@@ -93,7 +93,7 @@

Method Details

- list(userKey, applicationName, actorIpAddress=None, applicationInfoFilter=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, includeSensitiveData=None, maxResults=None, networkInfoFilter=None, orgUnitID=None, pageToken=None, resourceDetailsFilter=None, startTime=None, statusFilter=None, x__xgafv=None) + list(userKey, applicationName, actorIpAddress=None, agentInfoFilter=None, applicationInfoFilter=None, customerId=None, deviceFilter=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, includeSensitiveData=None, maxResults=None, networkInfoFilter=None, orgUnitID=None, pageToken=None, resourceDetailsFilter=None, startTime=None, statusFilter=None, x__xgafv=None)
Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides. 
 
 Args:
@@ -140,9 +140,12 @@ 

Method Details

graduation - The Graduation application's activity reports return information about various types of Graduation activity events. voice - The Voice application's activity reports return information about various types of Voice activity events. chrome_sync - The Chrome Sync application's activity reports return information about various types of Chrome Sync activity events. + workspace_studio - The Workspace Studio application's activity reports return information about various types of Workspace Studio activity events. actorIpAddress: string, The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions. + agentInfoFilter: string, Optional. Filters on agent info fields in the activity. This filter gets applied in conjunction(AND) with other filters. Example: "agentInfoFilter=agentId=\"agent-id\" AND agentName=\"agent-name\" AND agentOwnerEmail=\"agent-owner-email\"" applicationInfoFilter: string, Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId="clientId" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ``` customerId: string, The unique ID of the customer to retrieve data for. + deviceFilter: string, Optional. Used to filter on the fields present in [`UserDeviceInfo`](#userdeviceinfo) message like `deviceId`, `deviceType`, and `deviceOsVersion`. **Usage** ``` GET...&deviceFilter=deviceId="123" GET...&deviceFilter=deviceType="ANDROID" GET...&deviceFilter=deviceOsVersion="14.0" ``` endTime: string, Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past. For Gmail requests, `startTime` and `endTime` must be provided and the difference must not be greater than 30 days. eventName: string, The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`. filters: string, The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form `{parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` These event parameters are associated with a specific `eventName`. An empty report is returned if the request's parameter doesn't belong to the `eventName`. For more information about the available `eventName` fields for each application and their associated parameters, go to the [ApplicationName](#applicationname) table, then click through to the Activity Events page in the Appendix for the application you want. In the following Drive activity examples, the returned list consists of all `edit` events where the `doc_id` parameter value matches the conditions defined by the relational operator. In the first example, the request returns all edited documents with a `doc_id` value equal to `12345`. In the second example, the report returns any edited documents where the `doc_id` value is not equal to `98765`. The `<>` operator is URL-encoded in the request's query string (`%3C%3E`): ``` GET...&eventName=edit&filters=doc_id==12345 GET...&eventName=edit&filters=doc_id%3C%3E98765 ``` A `filters` query supports these relational operators: * `==`—'equal to'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'greater than or equal to'. Must be URL-encoded (%3E=). **Note:** The API doesn't accept multiple values of the same parameter. If a parameter is supplied more than once in the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned. @@ -168,6 +171,14 @@

Method Details

"items": [ # Each activity record in the response. { # JSON template for the activity resource. "actor": { # User doing the action. + "agentAttributionInfo": { # Details of the AI agent that was the actor for the activity. # Details of the AI agent that was the actor for the activity. + "agentId": "A String", # The ID of the agent. + "agentName": "A String", # The user visible name of the agent. + "agentOwner": { # Details of the owner of the AI agent. # The owner of the agent. + "email": "A String", # The email of the agent owner. + }, + "agentType": "A String", # Type of the agent. + }, "applicationInfo": { # Details of the application that was the actor for the activity. "applicationName": "A String", # Name of the application used to perform the action. "impersonation": True or False, # Whether the application was impersonating a user. @@ -309,6 +320,7 @@

Method Details

"uniqueQualifier": "A String", # Unique qualifier if multiple events have the same time. }, "ipAddress": "A String", # IP address of the user doing the action. This is the Internet Protocol (IP) address of the user when logging into Google Workspace, which may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. The API supports IPv4 and IPv6. + "isAgenticAction": True or False, # Whether the activity was performed by an agent. "kind": "admin#reports#activity", # The type of API resource. For an activity report, the value is `audit#activity`. "networkInfo": { # Network information of the user doing the action. # Network information of the user doing the action. "ipAsn": [ # IP Address of the user doing the action. @@ -401,6 +413,11 @@

Method Details

"type": "A String", # Type of the resource - document, email, chat message }, ], + "userDeviceInfo": { # Device details of the user doing the action. # Device details of the user doing the action. + "deviceId": "A String", # Output only. Device ID of the user's device. + "deviceOsVersion": "A String", # Output only. Device OS version of the user's device. + "deviceType": "A String", # Output only. The type of the user's device. + }, }, ], "kind": "admin#reports#activities", # The type of API resource. For an activity report, the value is `reports#activities`. diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index 9af2e37c47..1280a8cd6b 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -4729,7 +4729,7 @@ } } }, -"revision": "20260531", +"revision": "20260729", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -6570,6 +6570,21 @@ false "properties": {}, "type": "object" }, +"ExternalId": { +"description": "External identifier used to link and identify this group across external directory systems.", +"id": "ExternalId", +"properties": { +"id": { +"description": "The unique identifier string assigned by the external provider.", +"type": "string" +}, +"namespace": { +"description": "The system or identity provider managing this ID.", +"type": "string" +} +}, +"type": "object" +}, "FailureInfo": { "description": "Info about failures", "id": "FailureInfo", @@ -6759,6 +6774,13 @@ false "description": "ETag of the resource.", "type": "string" }, +"externalIds": { +"description": "Optional. The list of external IDs for the group, such as an immutable identifier from an external identity provider or directory sync client. Each entry contains a namespace and an ID value.", +"items": { +"$ref": "ExternalId" +}, +"type": "array" +}, "id": { "description": "Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/admin.reports_v1.json b/googleapiclient/discovery_cache/documents/admin.reports_v1.json index affdac3c76..b18ee672ef 100644 --- a/googleapiclient/discovery_cache/documents/admin.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.reports_v1.json @@ -126,6 +126,11 @@ "location": "query", "type": "string" }, +"agentInfoFilter": { +"description": "Optional. Filters on agent info fields in the activity. This filter gets applied in conjunction(AND) with other filters. Example: \"agentInfoFilter=agentId=\\\"agent-id\\\" AND agentName=\\\"agent-name\\\" AND agentOwnerEmail=\\\"agent-owner-email\\\"\"", +"location": "query", +"type": "string" +}, "applicationInfoFilter": { "description": "Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId=\"clientId\" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ```", "location": "query", @@ -173,7 +178,8 @@ "takeout", "graduation", "voice", -"chrome_sync" +"chrome_sync", +"workspace_studio" ], "enumDescriptions": [ "The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.", @@ -215,10 +221,11 @@ "The Takeout application's activity reports return information about various types of Takeout activity events.", "The Graduation application's activity reports return information about various types of Graduation activity events.", "The Voice application's activity reports return information about various types of Voice activity events.", -"The Chrome Sync application's activity reports return information about various types of Chrome Sync activity events." +"The Chrome Sync application's activity reports return information about various types of Chrome Sync activity events.", +"The Workspace Studio application's activity reports return information about various types of Workspace Studio activity events." ], "location": "path", -"pattern": "(access_evaluation)|(access_transparency)|(admin)|(admin_data_action)|(assignments)|(calendar)|(chat)|(chrome)|(classroom)|(cloud_search)|(contacts)|(context_aware_access)|(data_studio)|(data_migration)|(directory_sync)|(drive)|(gcp)|(gmail)|(gplus)|(graduation)|(groups)|(groups_enterprise)|(jamboard)|(keep)|(ldap)|(login)|(meet)|(meet_hardware)|(mobile)|(profile)|(rules)|(saml)|(token)|(user_accounts)|(vault)|(gemini_in_workspace_apps)|(tasks)|(takeout)|(voice)|(chrome_sync)", +"pattern": "(access_evaluation)|(access_transparency)|(admin)|(admin_data_action)|(assignments)|(calendar)|(chat)|(chrome)|(classroom)|(cloud_search)|(contacts)|(context_aware_access)|(data_studio)|(data_migration)|(directory_sync)|(drive)|(gcp)|(gmail)|(gplus)|(graduation)|(groups)|(groups_enterprise)|(jamboard)|(keep)|(ldap)|(login)|(meet)|(meet_hardware)|(mobile)|(profile)|(rules)|(saml)|(token)|(user_accounts)|(vault)|(gemini_in_workspace_apps)|(tasks)|(takeout)|(voice)|(chrome_sync)|(workspace_studio)", "required": true, "type": "string" }, @@ -228,6 +235,11 @@ "pattern": "C.+|my_customer", "type": "string" }, +"deviceFilter": { +"description": "Optional. Used to filter on the fields present in [`UserDeviceInfo`](#userdeviceinfo) message like `deviceId`, `deviceType`, and `deviceOsVersion`. **Usage** ``` GET...&deviceFilter=deviceId=\"123\" GET...&deviceFilter=deviceType=\"ANDROID\" GET...&deviceFilter=deviceOsVersion=\"14.0\" ```", +"location": "query", +"type": "string" +}, "endTime": { "description": "Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past. For Gmail requests, `startTime` and `endTime` must be provided and the difference must not be greater than 30 days.", "location": "query", @@ -690,7 +702,7 @@ } } }, -"revision": "20260504", +"revision": "20260729", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { @@ -727,6 +739,10 @@ "actor": { "description": "User doing the action.", "properties": { +"agentAttributionInfo": { +"$ref": "AgentAttributionInfo", +"description": "Details of the AI agent that was the actor for the activity." +}, "applicationInfo": { "description": "Details of the application that was the actor for the activity.", "properties": { @@ -964,6 +980,10 @@ "description": "IP address of the user doing the action. This is the Internet Protocol (IP) address of the user when logging into Google Workspace, which may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. The API supports IPv4 and IPv6.", "type": "string" }, +"isAgenticAction": { +"description": "Whether the activity was performed by an agent.", +"type": "boolean" +}, "kind": { "default": "admin#reports#activity", "description": "The type of API resource. For an activity report, the value is `audit#activity`.", @@ -983,6 +1003,10 @@ "$ref": "ResourceDetails" }, "type": "array" +}, +"userDeviceInfo": { +"$ref": "ActivityUserDeviceInfo", +"description": "Device details of the user doing the action." } }, "type": "object" @@ -1034,6 +1058,62 @@ }, "type": "object" }, +"ActivityUserDeviceInfo": { +"description": "Device details of the user doing the action.", +"id": "ActivityUserDeviceInfo", +"properties": { +"deviceId": { +"description": "Output only. Device ID of the user's device.", +"readOnly": true, +"type": "string" +}, +"deviceOsVersion": { +"description": "Output only. Device OS version of the user's device.", +"readOnly": true, +"type": "string" +}, +"deviceType": { +"description": "Output only. The type of the user's device.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AgentAttributionInfo": { +"description": "Details of the AI agent that was the actor for the activity.", +"id": "AgentAttributionInfo", +"properties": { +"agentId": { +"description": "The ID of the agent.", +"type": "string" +}, +"agentName": { +"description": "The user visible name of the agent.", +"type": "string" +}, +"agentOwner": { +"$ref": "AgentAttributionInfoAgentOwner", +"description": "The owner of the agent." +}, +"agentType": { +"description": "Type of the agent.", +"type": "string" +} +}, +"type": "object" +}, +"AgentAttributionInfoAgentOwner": { +"description": "Details of the owner of the AI agent.", +"id": "AgentAttributionInfoAgentOwner", +"properties": { +"email": { +"description": "The email of the agent owner.", +"type": "string" +} +}, +"type": "object" +}, "AppliedLabel": { "description": "Details of the label applied on the resource.", "id": "AppliedLabel", From d263c63a25d58138c526bab514e88e11fc345798 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:56 +0000 Subject: [PATCH 04/84] feat(agentregistry): update the api #### agentregistry:v1alpha The following keys were added: - resources.projects.resources.locations.resources.publishers.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.publishers.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.skills.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.skills.methods.delete (Total Keys: 15) - resources.projects.resources.locations.resources.skills.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.skills.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.skills.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.skills.methods.search (Total Keys: 22) - schemas.ArchiveUploadSource (Total Keys: 4) - schemas.Frontmatter (Total Keys: 7) - schemas.GcsSource (Total Keys: 5) - schemas.ListPublishersResponse (Total Keys: 5) - schemas.ListSkillsResponse (Total Keys: 7) - schemas.Publisher (Total Keys: 8) - schemas.SearchSkillsResponse (Total Keys: 5) - schemas.Skill (Total Keys: 21) --- ...ntregistry_v1alpha.projects.locations.html | 10 + ...v1alpha.projects.locations.publishers.html | 164 ++++ ...try_v1alpha.projects.locations.skills.html | 571 +++++++++++ ...a.projects.locations.skills.revisions.html | 323 +++++++ .../documents/agentregistry.v1alpha.json | 889 +++++++++++++++++- 5 files changed, 1936 insertions(+), 21 deletions(-) create mode 100644 docs/dyn/agentregistry_v1alpha.projects.locations.publishers.html create mode 100644 docs/dyn/agentregistry_v1alpha.projects.locations.skills.html create mode 100644 docs/dyn/agentregistry_v1alpha.projects.locations.skills.revisions.html diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.html b/docs/dyn/agentregistry_v1alpha.projects.locations.html index c2231a4eb2..ed5e77f017 100644 --- a/docs/dyn/agentregistry_v1alpha.projects.locations.html +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.html @@ -99,11 +99,21 @@

Instance Methods

Returns the operations Resource.

+

+ publishers() +

+

Returns the publishers Resource.

+

services()

Returns the services Resource.

+

+ skills() +

+

Returns the skills Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.publishers.html b/docs/dyn/agentregistry_v1alpha.projects.locations.publishers.html new file mode 100644 index 0000000000..d60085930c --- /dev/null +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.publishers.html @@ -0,0 +1,164 @@ + + + +

Agent Registry API . projects . locations . publishers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Fetches details of a specific Publisher.

+

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

+

Lists all Publishers in a location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Fetches details of a specific Publisher.
+
+Args:
+  name: string, Required. Target publisher resource name. Format: `projects/{project}/locations/{location}/publishers/{publisher}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a verified Publisher of Skills. Prepopulated publishers include `publishers/cloud.google.com` and `publishers/workspace.google.com`.
+  "displayName": "A String", # Optional. Human readable display name of the publisher.
+  "documentationUri": "A String", # Optional. URI pointing to official publisher documentation.
+  "name": "A String", # Identifier. Resource name of the publisher. Format: `projects/{project}/locations/{location}/publishers/{publisher}`
+  "publisherTier": "A String", # Output only. The curation tier of the publisher.
+  "supportUri": "A String", # Optional. URI pointing to the support portal or email.
+  "verifiedPrefix": "A String", # Required. The verified prefix (e.g. "snowflake-", "google-") associated with this publisher. The system uses this prefix to enforce name-squatting rules during Skill registration. Must be globally unique across all publishers.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all Publishers in a location.
+
+Args:
+  parent: string, Required. Parent location to query. Format: `projects/{project}/locations/{location}` (required)
+  pageSize: integer, Optional. Page limit size.
+  pageToken: string, Optional. Page offset token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response listing Publishers.
+  "nextPageToken": "A String", # Page offset continuation token.
+  "publishers": [ # The returned list of Publishers.
+    { # Represents a verified Publisher of Skills. Prepopulated publishers include `publishers/cloud.google.com` and `publishers/workspace.google.com`.
+      "displayName": "A String", # Optional. Human readable display name of the publisher.
+      "documentationUri": "A String", # Optional. URI pointing to official publisher documentation.
+      "name": "A String", # Identifier. Resource name of the publisher. Format: `projects/{project}/locations/{location}/publishers/{publisher}`
+      "publisherTier": "A String", # Output only. The curation tier of the publisher.
+      "supportUri": "A String", # Optional. URI pointing to the support portal or email.
+      "verifiedPrefix": "A String", # Required. The verified prefix (e.g. "snowflake-", "google-") associated with this publisher. The system uses this prefix to enforce name-squatting rules during Skill registration. Must be globally unique across all publishers.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html b/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html new file mode 100644 index 0000000000..583af19843 --- /dev/null +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html @@ -0,0 +1,571 @@ + + + +

Agent Registry API . projects . locations . skills

+

Instance Methods

+

+ revisions() +

+

Returns the revisions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, requestId=None, skillId=None, x__xgafv=None)

+

========================================================================= # Skills Collection APIs Creates a Skill resource container, optionally publishing the initial SkillRevision inline in a single, atomic CRUD roundtrip.

+

+ delete(name, force=None, requestId=None, x__xgafv=None)

+

Deletes a Skill container along with all its revisions.

+

+ get(name, x__xgafv=None)

+

Fetches the active configuration and metadata of a Skill.

+

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

+

Lists logical Skills available in a project.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates Skill metadata or overrides active pointers/state using REST standard PATCH.

+

+ search(parent, filter=None, pageSize=None, pageToken=None, searchString=None, searchType=None, x__xgafv=None)

+

Custom deep-search method to filter by frontmatter or query SKILL.md text blobs.

+

+ search_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, requestId=None, skillId=None, x__xgafv=None) +
========================================================================= # Skills Collection APIs Creates a Skill resource container, optionally publishing the initial SkillRevision inline in a single, atomic CRUD roundtrip.
+
+Args:
+  parent: string, Required. The project and location location to bootstrap. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents an Executable Agent Skill or a Composite Tool Suite (Bundle). Sibling resource with Agent and McpServer under agentregistry.googleapis.com.
+  "createTime": "A String", # Output only. Create time.
+  "defaultRevision": "A String", # Optional. The full resource name of the revision currently served by default (floating track). Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`
+  "description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters.
+  "displayName": "A String", # Required. Human-readable display name of the skill. Maximum length is 128 characters.
+  "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision.
+    "compatibility": "A String", # Optional. Environmental dependencies or local sidecars.
+    "description": "A String", # Required. Functional description.
+    "license": "A String", # Optional. License.
+    "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
+      "a_key": "A String",
+    },
+    "name": "A String", # Required. The name of the skill.
+  },
+  "initialRevision": { # Represents an immutable, versioned snapshot of a Skill package. # Optional. Input only. Optional nested initial revision payload to support standard one-shot creation. The server processes this field on input during creation but must never return it in responses.
+    "archiveUploadSource": { # Direct write-only raw archive payload upload. # Optional. Immutable. Direct write-only raw archive upload source.
+      "archiveContent": "A String", # Required. Input only. Write-only raw ZIP/TAR archive payload bytes containing the skill package.
+    },
+    "createTime": "A String", # Output only. Revision creation timestamp.
+    "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot.
+      "compatibility": "A String", # Optional. Environmental dependencies or local sidecars.
+      "description": "A String", # Required. Functional description.
+      "license": "A String", # Optional. License.
+      "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
+        "a_key": "A String",
+      },
+      "name": "A String", # Required. The name of the skill.
+    },
+    "gcsSource": { # Specifications for Cloud Storage objects. # Optional. Immutable. Cloud Storage object generation URI.
+      "generation": "A String", # Optional. Cloud Storage object generation ID. If not specified, the latest generation is used.
+      "uri": "A String", # Required. Cloud Storage object URI. Format: `gs://{bucket_name}/{object_name}`
+    },
+    "name": "A String", # Identifier. Resource name of the SkillRevision. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`
+    "sha256Hash": "A String", # Output only. Cryptographic SHA-256 integrity and deduplication digest of the payload zip.
+    "sizeBytes": "A String", # Output only. Size of the compiled zip payload in bytes (assists client download progress).
+    "state": "A String", # Output only. The system-managed lifecycle state of this revision.
+    "uid": "A String", # Output only. Universally unique identifier (UUID4) for the skill revision.
+  },
+  "name": "A String", # Identifier. Resource name of the Skill. Format: `projects/{project}/locations/{location}/skills/{skill}` The `{skill}` segment acts as the resource ID. If the skill is associated with a Publisher, this segment typically uses a hyphenated namespace prefix corresponding to the publisher (e.g., `google-workspace-create-docs`).
+  "publisher": "A String", # Optional. The publisher resource associated with this skill. Format: `projects/{project}/locations/{location}/publishers/{publisher}` The publisher dictates the allowed namespace prefixes for the skill's name and logical `skill_id` (e.g., Publisher `google` authorizes the `google-*` prefix).
+  "skillId": "A String", # Output only. A stable, globally unique logical identifier for the skill. It is securely constructed by the backend by combining the associated `publisher`'s verified namespace and the skill's resource ID to enforce strict ownership. For example, the prefix `google-` is reserved exclusively for first-party Google publishers to prevent namespace squatting. Example: `urn:skill:google-workspace:create-docs`
+  "state": "A String", # Output only. The system-managed state of the skill.
+  "targetState": "A String", # Required. User-managed target state of the skill.
+  "type": "A String", # Required. Structural deployment type (SIMPLE leaf vs COMPOSITE bundle).
+  "uid": "A String", # Output only. Universally unique identifier (UUID4) for the logical container.
+  "updateTime": "A String", # Output only. Update time.
+}
+
+  requestId: string, Optional. Signed UUID request idempotency token.
+  skillId: string, Required. Custom, user-defined unique container identifier. Must be unique within the parent project and location. This value should be 4-63 characters, and valid characters are `/a-z-/`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, force=None, requestId=None, x__xgafv=None) +
Deletes a Skill container along with all its revisions.
+
+Args:
+  name: string, Required. Target Skill container name to remove. (required)
+  force: boolean, Optional. If set to true, any child SkillRevisions under this Skill will also be deleted. Otherwise, the request will only succeed if the Skill has no child SkillRevisions.
+  requestId: string, Optional. Signed UUID request idempotency token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Fetches the active configuration and metadata of a Skill.
+
+Args:
+  name: string, Required. Target resource container name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Executable Agent Skill or a Composite Tool Suite (Bundle). Sibling resource with Agent and McpServer under agentregistry.googleapis.com.
+  "createTime": "A String", # Output only. Create time.
+  "defaultRevision": "A String", # Optional. The full resource name of the revision currently served by default (floating track). Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`
+  "description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters.
+  "displayName": "A String", # Required. Human-readable display name of the skill. Maximum length is 128 characters.
+  "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision.
+    "compatibility": "A String", # Optional. Environmental dependencies or local sidecars.
+    "description": "A String", # Required. Functional description.
+    "license": "A String", # Optional. License.
+    "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
+      "a_key": "A String",
+    },
+    "name": "A String", # Required. The name of the skill.
+  },
+  "initialRevision": { # Represents an immutable, versioned snapshot of a Skill package. # Optional. Input only. Optional nested initial revision payload to support standard one-shot creation. The server processes this field on input during creation but must never return it in responses.
+    "archiveUploadSource": { # Direct write-only raw archive payload upload. # Optional. Immutable. Direct write-only raw archive upload source.
+      "archiveContent": "A String", # Required. Input only. Write-only raw ZIP/TAR archive payload bytes containing the skill package.
+    },
+    "createTime": "A String", # Output only. Revision creation timestamp.
+    "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot.
+      "compatibility": "A String", # Optional. Environmental dependencies or local sidecars.
+      "description": "A String", # Required. Functional description.
+      "license": "A String", # Optional. License.
+      "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
+        "a_key": "A String",
+      },
+      "name": "A String", # Required. The name of the skill.
+    },
+    "gcsSource": { # Specifications for Cloud Storage objects. # Optional. Immutable. Cloud Storage object generation URI.
+      "generation": "A String", # Optional. Cloud Storage object generation ID. If not specified, the latest generation is used.
+      "uri": "A String", # Required. Cloud Storage object URI. Format: `gs://{bucket_name}/{object_name}`
+    },
+    "name": "A String", # Identifier. Resource name of the SkillRevision. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`
+    "sha256Hash": "A String", # Output only. Cryptographic SHA-256 integrity and deduplication digest of the payload zip.
+    "sizeBytes": "A String", # Output only. Size of the compiled zip payload in bytes (assists client download progress).
+    "state": "A String", # Output only. The system-managed lifecycle state of this revision.
+    "uid": "A String", # Output only. Universally unique identifier (UUID4) for the skill revision.
+  },
+  "name": "A String", # Identifier. Resource name of the Skill. Format: `projects/{project}/locations/{location}/skills/{skill}` The `{skill}` segment acts as the resource ID. If the skill is associated with a Publisher, this segment typically uses a hyphenated namespace prefix corresponding to the publisher (e.g., `google-workspace-create-docs`).
+  "publisher": "A String", # Optional. The publisher resource associated with this skill. Format: `projects/{project}/locations/{location}/publishers/{publisher}` The publisher dictates the allowed namespace prefixes for the skill's name and logical `skill_id` (e.g., Publisher `google` authorizes the `google-*` prefix).
+  "skillId": "A String", # Output only. A stable, globally unique logical identifier for the skill. It is securely constructed by the backend by combining the associated `publisher`'s verified namespace and the skill's resource ID to enforce strict ownership. For example, the prefix `google-` is reserved exclusively for first-party Google publishers to prevent namespace squatting. Example: `urn:skill:google-workspace:create-docs`
+  "state": "A String", # Output only. The system-managed state of the skill.
+  "targetState": "A String", # Required. User-managed target state of the skill.
+  "type": "A String", # Required. Structural deployment type (SIMPLE leaf vs COMPOSITE bundle).
+  "uid": "A String", # Output only. Universally unique identifier (UUID4) for the logical container.
+  "updateTime": "A String", # Output only. Update time.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists logical Skills available in a project.
+
+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 | 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response structure listing logical Skills.
+  "nextPageToken": "A String", # Page continuation continuation token.
+  "skills": [ # Returned container list.
+    { # Represents an Executable Agent Skill or a Composite Tool Suite (Bundle). Sibling resource with Agent and McpServer under agentregistry.googleapis.com.
+      "createTime": "A String", # Output only. Create time.
+      "defaultRevision": "A String", # Optional. The full resource name of the revision currently served by default (floating track). Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`
+      "description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters.
+      "displayName": "A String", # Required. Human-readable display name of the skill. Maximum length is 128 characters.
+      "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision.
+        "compatibility": "A String", # Optional. Environmental dependencies or local sidecars.
+        "description": "A String", # Required. Functional description.
+        "license": "A String", # Optional. License.
+        "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
+          "a_key": "A String",
+        },
+        "name": "A String", # Required. The name of the skill.
+      },
+      "initialRevision": { # Represents an immutable, versioned snapshot of a Skill package. # Optional. Input only. Optional nested initial revision payload to support standard one-shot creation. The server processes this field on input during creation but must never return it in responses.
+        "archiveUploadSource": { # Direct write-only raw archive payload upload. # Optional. Immutable. Direct write-only raw archive upload source.
+          "archiveContent": "A String", # Required. Input only. Write-only raw ZIP/TAR archive payload bytes containing the skill package.
+        },
+        "createTime": "A String", # Output only. Revision creation timestamp.
+        "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot.
+          "compatibility": "A String", # Optional. Environmental dependencies or local sidecars.
+          "description": "A String", # Required. Functional description.
+          "license": "A String", # Optional. License.
+          "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
+            "a_key": "A String",
+          },
+          "name": "A String", # Required. The name of the skill.
+        },
+        "gcsSource": { # Specifications for Cloud Storage objects. # Optional. Immutable. Cloud Storage object generation URI.
+          "generation": "A String", # Optional. Cloud Storage object generation ID. If not specified, the latest generation is used.
+          "uri": "A String", # Required. Cloud Storage object URI. Format: `gs://{bucket_name}/{object_name}`
+        },
+        "name": "A String", # Identifier. Resource name of the SkillRevision. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`
+        "sha256Hash": "A String", # Output only. Cryptographic SHA-256 integrity and deduplication digest of the payload zip.
+        "sizeBytes": "A String", # Output only. Size of the compiled zip payload in bytes (assists client download progress).
+        "state": "A String", # Output only. The system-managed lifecycle state of this revision.
+        "uid": "A String", # Output only. Universally unique identifier (UUID4) for the skill revision.
+      },
+      "name": "A String", # Identifier. Resource name of the Skill. Format: `projects/{project}/locations/{location}/skills/{skill}` The `{skill}` segment acts as the resource ID. If the skill is associated with a Publisher, this segment typically uses a hyphenated namespace prefix corresponding to the publisher (e.g., `google-workspace-create-docs`).
+      "publisher": "A String", # Optional. The publisher resource associated with this skill. Format: `projects/{project}/locations/{location}/publishers/{publisher}` The publisher dictates the allowed namespace prefixes for the skill's name and logical `skill_id` (e.g., Publisher `google` authorizes the `google-*` prefix).
+      "skillId": "A String", # Output only. A stable, globally unique logical identifier for the skill. It is securely constructed by the backend by combining the associated `publisher`'s verified namespace and the skill's resource ID to enforce strict ownership. For example, the prefix `google-` is reserved exclusively for first-party Google publishers to prevent namespace squatting. Example: `urn:skill:google-workspace:create-docs`
+      "state": "A String", # Output only. The system-managed state of the skill.
+      "targetState": "A String", # Required. User-managed target state of the skill.
+      "type": "A String", # Required. Structural deployment type (SIMPLE leaf vs COMPOSITE bundle).
+      "uid": "A String", # Output only. Universally unique identifier (UUID4) for the logical container.
+      "updateTime": "A String", # Output only. Update time.
+    },
+  ],
+  "unreachable": [ # Unreachable locations or failures.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Updates Skill metadata or overrides active pointers/state using REST standard PATCH.
+
+Args:
+  name: string, Identifier. Resource name of the Skill. Format: `projects/{project}/locations/{location}/skills/{skill}` The `{skill}` segment acts as the resource ID. If the skill is associated with a Publisher, this segment typically uses a hyphenated namespace prefix corresponding to the publisher (e.g., `google-workspace-create-docs`). (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents an Executable Agent Skill or a Composite Tool Suite (Bundle). Sibling resource with Agent and McpServer under agentregistry.googleapis.com.
+  "createTime": "A String", # Output only. Create time.
+  "defaultRevision": "A String", # Optional. The full resource name of the revision currently served by default (floating track). Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`
+  "description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters.
+  "displayName": "A String", # Required. Human-readable display name of the skill. Maximum length is 128 characters.
+  "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision.
+    "compatibility": "A String", # Optional. Environmental dependencies or local sidecars.
+    "description": "A String", # Required. Functional description.
+    "license": "A String", # Optional. License.
+    "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
+      "a_key": "A String",
+    },
+    "name": "A String", # Required. The name of the skill.
+  },
+  "initialRevision": { # Represents an immutable, versioned snapshot of a Skill package. # Optional. Input only. Optional nested initial revision payload to support standard one-shot creation. The server processes this field on input during creation but must never return it in responses.
+    "archiveUploadSource": { # Direct write-only raw archive payload upload. # Optional. Immutable. Direct write-only raw archive upload source.
+      "archiveContent": "A String", # Required. Input only. Write-only raw ZIP/TAR archive payload bytes containing the skill package.
+    },
+    "createTime": "A String", # Output only. Revision creation timestamp.
+    "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot.
+      "compatibility": "A String", # Optional. Environmental dependencies or local sidecars.
+      "description": "A String", # Required. Functional description.
+      "license": "A String", # Optional. License.
+      "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
+        "a_key": "A String",
+      },
+      "name": "A String", # Required. The name of the skill.
+    },
+    "gcsSource": { # Specifications for Cloud Storage objects. # Optional. Immutable. Cloud Storage object generation URI.
+      "generation": "A String", # Optional. Cloud Storage object generation ID. If not specified, the latest generation is used.
+      "uri": "A String", # Required. Cloud Storage object URI. Format: `gs://{bucket_name}/{object_name}`
+    },
+    "name": "A String", # Identifier. Resource name of the SkillRevision. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`
+    "sha256Hash": "A String", # Output only. Cryptographic SHA-256 integrity and deduplication digest of the payload zip.
+    "sizeBytes": "A String", # Output only. Size of the compiled zip payload in bytes (assists client download progress).
+    "state": "A String", # Output only. The system-managed lifecycle state of this revision.
+    "uid": "A String", # Output only. Universally unique identifier (UUID4) for the skill revision.
+  },
+  "name": "A String", # Identifier. Resource name of the Skill. Format: `projects/{project}/locations/{location}/skills/{skill}` The `{skill}` segment acts as the resource ID. If the skill is associated with a Publisher, this segment typically uses a hyphenated namespace prefix corresponding to the publisher (e.g., `google-workspace-create-docs`).
+  "publisher": "A String", # Optional. The publisher resource associated with this skill. Format: `projects/{project}/locations/{location}/publishers/{publisher}` The publisher dictates the allowed namespace prefixes for the skill's name and logical `skill_id` (e.g., Publisher `google` authorizes the `google-*` prefix).
+  "skillId": "A String", # Output only. A stable, globally unique logical identifier for the skill. It is securely constructed by the backend by combining the associated `publisher`'s verified namespace and the skill's resource ID to enforce strict ownership. For example, the prefix `google-` is reserved exclusively for first-party Google publishers to prevent namespace squatting. Example: `urn:skill:google-workspace:create-docs`
+  "state": "A String", # Output only. The system-managed state of the skill.
+  "targetState": "A String", # Required. User-managed target state of the skill.
+  "type": "A String", # Required. Structural deployment type (SIMPLE leaf vs COMPOSITE bundle).
+  "uid": "A String", # Output only. Universally unique identifier (UUID4) for the logical container.
+  "updateTime": "A String", # Output only. Update time.
+}
+
+  requestId: string, Optional. Signed UUID request idempotency token.
+  updateMask: string, Optional. Standard update target mask mapping relative fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ search(parent, filter=None, pageSize=None, pageToken=None, searchString=None, searchType=None, x__xgafv=None) +
Custom deep-search method to filter by frontmatter or query SKILL.md text blobs.
+
+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 | 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 | | 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.
+      KEYWORD - Search for a keyword across all searchable fields.
+      SEMANTIC - Search based on the meaning and intent of a natural language query.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response listing searched Skills.
+  "nextPageToken": "A String", # Query page offset continuation token.
+  "skills": [ # Matched Skills list.
+    { # Represents an Executable Agent Skill or a Composite Tool Suite (Bundle). Sibling resource with Agent and McpServer under agentregistry.googleapis.com.
+      "createTime": "A String", # Output only. Create time.
+      "defaultRevision": "A String", # Optional. The full resource name of the revision currently served by default (floating track). Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`
+      "description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters.
+      "displayName": "A String", # Required. Human-readable display name of the skill. Maximum length is 128 characters.
+      "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision.
+        "compatibility": "A String", # Optional. Environmental dependencies or local sidecars.
+        "description": "A String", # Required. Functional description.
+        "license": "A String", # Optional. License.
+        "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
+          "a_key": "A String",
+        },
+        "name": "A String", # Required. The name of the skill.
+      },
+      "initialRevision": { # Represents an immutable, versioned snapshot of a Skill package. # Optional. Input only. Optional nested initial revision payload to support standard one-shot creation. The server processes this field on input during creation but must never return it in responses.
+        "archiveUploadSource": { # Direct write-only raw archive payload upload. # Optional. Immutable. Direct write-only raw archive upload source.
+          "archiveContent": "A String", # Required. Input only. Write-only raw ZIP/TAR archive payload bytes containing the skill package.
+        },
+        "createTime": "A String", # Output only. Revision creation timestamp.
+        "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot.
+          "compatibility": "A String", # Optional. Environmental dependencies or local sidecars.
+          "description": "A String", # Required. Functional description.
+          "license": "A String", # Optional. License.
+          "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
+            "a_key": "A String",
+          },
+          "name": "A String", # Required. The name of the skill.
+        },
+        "gcsSource": { # Specifications for Cloud Storage objects. # Optional. Immutable. Cloud Storage object generation URI.
+          "generation": "A String", # Optional. Cloud Storage object generation ID. If not specified, the latest generation is used.
+          "uri": "A String", # Required. Cloud Storage object URI. Format: `gs://{bucket_name}/{object_name}`
+        },
+        "name": "A String", # Identifier. Resource name of the SkillRevision. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`
+        "sha256Hash": "A String", # Output only. Cryptographic SHA-256 integrity and deduplication digest of the payload zip.
+        "sizeBytes": "A String", # Output only. Size of the compiled zip payload in bytes (assists client download progress).
+        "state": "A String", # Output only. The system-managed lifecycle state of this revision.
+        "uid": "A String", # Output only. Universally unique identifier (UUID4) for the skill revision.
+      },
+      "name": "A String", # Identifier. Resource name of the Skill. Format: `projects/{project}/locations/{location}/skills/{skill}` The `{skill}` segment acts as the resource ID. If the skill is associated with a Publisher, this segment typically uses a hyphenated namespace prefix corresponding to the publisher (e.g., `google-workspace-create-docs`).
+      "publisher": "A String", # Optional. The publisher resource associated with this skill. Format: `projects/{project}/locations/{location}/publishers/{publisher}` The publisher dictates the allowed namespace prefixes for the skill's name and logical `skill_id` (e.g., Publisher `google` authorizes the `google-*` prefix).
+      "skillId": "A String", # Output only. A stable, globally unique logical identifier for the skill. It is securely constructed by the backend by combining the associated `publisher`'s verified namespace and the skill's resource ID to enforce strict ownership. For example, the prefix `google-` is reserved exclusively for first-party Google publishers to prevent namespace squatting. Example: `urn:skill:google-workspace:create-docs`
+      "state": "A String", # Output only. The system-managed state of the skill.
+      "targetState": "A String", # Required. User-managed target state of the skill.
+      "type": "A String", # Required. Structural deployment type (SIMPLE leaf vs COMPOSITE bundle).
+      "uid": "A String", # Output only. Universally unique identifier (UUID4) for the logical container.
+      "updateTime": "A String", # Output only. Update time.
+    },
+  ],
+}
+
+ +
+ search_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.skills.revisions.html b/docs/dyn/agentregistry_v1alpha.projects.locations.skills.revisions.html new file mode 100644 index 0000000000..838ade25b4 --- /dev/null +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.skills.revisions.html @@ -0,0 +1,323 @@ + + + +

Agent Registry API . projects . locations . skills . revisions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, requestId=None, skillRevisionId=None, x__xgafv=None)

+

Creates a new immutable revision and triggers validation pipelines.

+

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

+

Deletes a specific revision (restricted to admins to purge accidentally committed secrets).

+

+ get(name, x__xgafv=None)

+

Gets details of a single immutable Revision.

+

+ get_media(name, x__xgafv=None)

+

Gets details of a single immutable Revision.

+

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

+

Lists all revisions belonging to a parent Skill.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, requestId=None, skillRevisionId=None, x__xgafv=None) +
Creates a new immutable revision and triggers validation pipelines.
+
+Args:
+  parent: string, Required. Parent logical container name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents an immutable, versioned snapshot of a Skill package.
+  "archiveUploadSource": { # Direct write-only raw archive payload upload. # Optional. Immutable. Direct write-only raw archive upload source.
+    "archiveContent": "A String", # Required. Input only. Write-only raw ZIP/TAR archive payload bytes containing the skill package.
+  },
+  "createTime": "A String", # Output only. Revision creation timestamp.
+  "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot.
+    "compatibility": "A String", # Optional. Environmental dependencies or local sidecars.
+    "description": "A String", # Required. Functional description.
+    "license": "A String", # Optional. License.
+    "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
+      "a_key": "A String",
+    },
+    "name": "A String", # Required. The name of the skill.
+  },
+  "gcsSource": { # Specifications for Cloud Storage objects. # Optional. Immutable. Cloud Storage object generation URI.
+    "generation": "A String", # Optional. Cloud Storage object generation ID. If not specified, the latest generation is used.
+    "uri": "A String", # Required. Cloud Storage object URI. Format: `gs://{bucket_name}/{object_name}`
+  },
+  "name": "A String", # Identifier. Resource name of the SkillRevision. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`
+  "sha256Hash": "A String", # Output only. Cryptographic SHA-256 integrity and deduplication digest of the payload zip.
+  "sizeBytes": "A String", # Output only. Size of the compiled zip payload in bytes (assists client download progress).
+  "state": "A String", # Output only. The system-managed lifecycle state of this revision.
+  "uid": "A String", # Output only. Universally unique identifier (UUID4) for the skill revision.
+}
+
+  requestId: string, Optional. Signed UUID request idempotency token.
+  skillRevisionId: string, Optional. Custom, user-defined unique revision identifier. Format: 4-63 characters, matching regex `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes a specific revision (restricted to admins to purge accidentally committed secrets).
+
+Args:
+  name: string, Required. Target revision name to remove. (required)
+  requestId: string, Optional. Signed UUID request idempotency token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single immutable Revision.
+
+Args:
+  name: string, Required. Target revision name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an immutable, versioned snapshot of a Skill package.
+  "archiveUploadSource": { # Direct write-only raw archive payload upload. # Optional. Immutable. Direct write-only raw archive upload source.
+    "archiveContent": "A String", # Required. Input only. Write-only raw ZIP/TAR archive payload bytes containing the skill package.
+  },
+  "createTime": "A String", # Output only. Revision creation timestamp.
+  "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot.
+    "compatibility": "A String", # Optional. Environmental dependencies or local sidecars.
+    "description": "A String", # Required. Functional description.
+    "license": "A String", # Optional. License.
+    "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
+      "a_key": "A String",
+    },
+    "name": "A String", # Required. The name of the skill.
+  },
+  "gcsSource": { # Specifications for Cloud Storage objects. # Optional. Immutable. Cloud Storage object generation URI.
+    "generation": "A String", # Optional. Cloud Storage object generation ID. If not specified, the latest generation is used.
+    "uri": "A String", # Required. Cloud Storage object URI. Format: `gs://{bucket_name}/{object_name}`
+  },
+  "name": "A String", # Identifier. Resource name of the SkillRevision. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`
+  "sha256Hash": "A String", # Output only. Cryptographic SHA-256 integrity and deduplication digest of the payload zip.
+  "sizeBytes": "A String", # Output only. Size of the compiled zip payload in bytes (assists client download progress).
+  "state": "A String", # Output only. The system-managed lifecycle state of this revision.
+  "uid": "A String", # Output only. Universally unique identifier (UUID4) for the skill revision.
+}
+
+ +
+ get_media(name, x__xgafv=None) +
Gets details of a single immutable Revision.
+
+Args:
+  name: string, Required. Target revision name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  The media object as a string.
+
+    
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all revisions belonging to a parent Skill.
+
+Args:
+  parent: string, Required. Parent logical container name to query. (required)
+  pageSize: integer, Optional. Page limit size.
+  pageToken: string, Optional. Page offset token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response listing Revisions.
+  "nextPageToken": "A String", # Page offset continuation token.
+  "skillRevisions": [ # Returned version snapshot list.
+    { # Represents an immutable, versioned snapshot of a Skill package.
+      "archiveUploadSource": { # Direct write-only raw archive payload upload. # Optional. Immutable. Direct write-only raw archive upload source.
+        "archiveContent": "A String", # Required. Input only. Write-only raw ZIP/TAR archive payload bytes containing the skill package.
+      },
+      "createTime": "A String", # Output only. Revision creation timestamp.
+      "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot.
+        "compatibility": "A String", # Optional. Environmental dependencies or local sidecars.
+        "description": "A String", # Required. Functional description.
+        "license": "A String", # Optional. License.
+        "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
+          "a_key": "A String",
+        },
+        "name": "A String", # Required. The name of the skill.
+      },
+      "gcsSource": { # Specifications for Cloud Storage objects. # Optional. Immutable. Cloud Storage object generation URI.
+        "generation": "A String", # Optional. Cloud Storage object generation ID. If not specified, the latest generation is used.
+        "uri": "A String", # Required. Cloud Storage object URI. Format: `gs://{bucket_name}/{object_name}`
+      },
+      "name": "A String", # Identifier. Resource name of the SkillRevision. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`
+      "sha256Hash": "A String", # Output only. Cryptographic SHA-256 integrity and deduplication digest of the payload zip.
+      "sizeBytes": "A String", # Output only. Size of the compiled zip payload in bytes (assists client download progress).
+      "state": "A String", # Output only. The system-managed lifecycle state of this revision.
+      "uid": "A String", # Output only. Universally unique identifier (UUID4) for the skill revision.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json b/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json index 98f2555b00..2f0e212167 100644 --- a/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json @@ -874,6 +874,77 @@ } } }, +"publishers": { +"methods": { +"get": { +"description": "Fetches details of a specific Publisher.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}", +"httpMethod": "GET", +"id": "agentregistry.projects.locations.publishers.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Target publisher resource name. Format: `projects/{project}/locations/{location}/publishers/{publisher}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Publisher" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"list": { +"description": "Lists all Publishers in a location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/publishers", +"httpMethod": "GET", +"id": "agentregistry.projects.locations.publishers.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Page limit size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page offset token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent location to query. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/publishers", +"response": { +"$ref": "ListPublishersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +} +}, "services": { "methods": { "create": { @@ -1011,9 +1082,395 @@ "type": "string" } }, -"path": "v1alpha/{+parent}/services", +"path": "v1alpha/{+parent}/services", +"response": { +"$ref": "ListServicesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"patch": { +"description": "Updates the parameters of a single Service.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", +"httpMethod": "PATCH", +"id": "agentregistry.projects.locations.services.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "Service" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +} +}, +"skills": { +"methods": { +"create": { +"description": "========================================================================= # Skills Collection APIs Creates a Skill resource container, optionally publishing the initial SkillRevision inline in a single, atomic CRUD roundtrip.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/skills", +"httpMethod": "POST", +"id": "agentregistry.projects.locations.skills.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The project and location location to bootstrap.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. Signed UUID request idempotency token.", +"location": "query", +"type": "string" +}, +"skillId": { +"description": "Required. Custom, user-defined unique container identifier. Must be unique within the parent project and location. This value should be 4-63 characters, and valid characters are `/a-z-/`.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+parent}/skills", +"request": { +"$ref": "Skill" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"delete": { +"description": "Deletes a Skill container along with all its revisions.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}", +"httpMethod": "DELETE", +"id": "agentregistry.projects.locations.skills.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, any child SkillRevisions under this Skill will also be deleted. Otherwise, the request will only succeed if the Skill has no child SkillRevisions.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. Target Skill container name to remove.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. Signed UUID request idempotency token.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"get": { +"description": "Fetches the active configuration and metadata of a Skill.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}", +"httpMethod": "GET", +"id": "agentregistry.projects.locations.skills.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Target resource container name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Skill" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"list": { +"description": "Lists logical Skills available in a project.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/skills", +"httpMethod": "GET", +"id": "agentregistry.projects.locations.skills.list", +"parameterOrder": [ +"parent" +], +"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 | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Hint for how to order the results", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListSkillsRequest", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/skills", +"response": { +"$ref": "ListSkillsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"patch": { +"description": "Updates Skill metadata or overrides active pointers/state using REST standard PATCH.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}", +"httpMethod": "PATCH", +"id": "agentregistry.projects.locations.skills.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Resource name of the Skill. Format: `projects/{project}/locations/{location}/skills/{skill}` The `{skill}` segment acts as the resource ID. If the skill is associated with a Publisher, this segment typically uses a hyphenated namespace prefix corresponding to the publisher (e.g., `google-workspace-create-docs`).", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. Signed UUID request idempotency token.", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Optional. Standard update target mask mapping relative fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "Skill" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"search": { +"description": "Custom deep-search method to filter by frontmatter or query SKILL.md text blobs.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/skills:search", +"httpMethod": "GET", +"id": "agentregistry.projects.locations.skills.search", +"parameterOrder": [ +"parent" +], +"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 | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "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.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "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.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for SearchSkillsRequest. Format: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"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 | | 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" +}, +"searchType": { +"description": "Optional. The type of search.", +"enum": [ +"SEARCH_TYPE_UNSPECIFIED", +"KEYWORD", +"SEMANTIC" +], +"enumDescriptions": [ +"Invalid search type.", +"Search for a keyword across all searchable fields.", +"Search based on the meaning and intent of a natural language query." +], +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+parent}/skills:search", +"response": { +"$ref": "SearchSkillsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +}, +"resources": { +"revisions": { +"methods": { +"create": { +"description": "Creates a new immutable revision and triggers validation pipelines.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/revisions", +"httpMethod": "POST", +"id": "agentregistry.projects.locations.skills.revisions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Parent logical container name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. Signed UUID request idempotency token.", +"location": "query", +"type": "string" +}, +"skillRevisionId": { +"description": "Optional. Custom, user-defined unique revision identifier. Format: 4-63 characters, matching regex `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+parent}/revisions", +"request": { +"$ref": "SkillRevision" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"delete": { +"description": "Deletes a specific revision (restricted to admins to purge accidentally committed secrets).", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/revisions/{revisionsId}", +"httpMethod": "DELETE", +"id": "agentregistry.projects.locations.skills.revisions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Target revision name to remove.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. Signed UUID request idempotency token.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", "response": { -"$ref": "ListServicesResponse" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/agentregistry.read-only", @@ -1022,40 +1479,67 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, -"patch": { -"description": "Updates the parameters of a single Service.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", -"httpMethod": "PATCH", -"id": "agentregistry.projects.locations.services.patch", +"get": { +"description": "Gets details of a single immutable Revision.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/revisions/{revisionsId}", +"httpMethod": "GET", +"id": "agentregistry.projects.locations.skills.revisions.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`.", +"description": "Required. Target revision name.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/revisions/[^/]+$", "required": true, "type": "string" +} }, -"requestId": { -"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"path": "v1alpha/{+name}", +"response": { +"$ref": "SkillRevision" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-only", +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +], +"supportsMediaDownload": true, +"useMediaDownloadService": true +}, +"list": { +"description": "Lists all revisions belonging to a parent Skill.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/revisions", +"httpMethod": "GET", +"id": "agentregistry.projects.locations.skills.revisions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Page limit size.", +"format": "int32", "location": "query", -"type": "string" +"type": "integer" }, -"updateMask": { -"description": "Optional. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.", -"format": "google-fieldmask", +"pageToken": { +"description": "Optional. Page offset token.", "location": "query", "type": "string" -} }, -"path": "v1alpha/{+name}", -"request": { -"$ref": "Service" +"parent": { +"description": "Required. Parent logical container name to query.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", +"required": true, +"type": "string" +} }, +"path": "v1alpha/{+parent}/revisions", "response": { -"$ref": "Operation" +"$ref": "ListSkillRevisionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/agentregistry.read-only", @@ -1070,8 +1554,10 @@ } } } +} +} }, -"revision": "20260608", +"revision": "20260722", "rootUrl": "https://agentregistry.googleapis.com/", "schemas": { "A2ASkill": { @@ -1259,6 +1745,18 @@ }, "type": "object" }, +"ArchiveUploadSource": { +"description": "Direct write-only raw archive payload upload.", +"id": "ArchiveUploadSource", +"properties": { +"archiveContent": { +"description": "Required. Input only. Write-only raw ZIP/TAR archive payload bytes containing the skill package.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, "AuthProviderBinding": { "description": "The AuthProvider of the Binding.", "id": "AuthProviderBinding", @@ -1467,6 +1965,52 @@ }, "type": "object" }, +"Frontmatter": { +"description": "Structured metadata attributes extracted from the package's local SKILL.md frontmatter.", +"id": "Frontmatter", +"properties": { +"compatibility": { +"description": "Optional. Environmental dependencies or local sidecars.", +"type": "string" +}, +"description": { +"description": "Required. Functional description.", +"type": "string" +}, +"license": { +"description": "Optional. License.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Extensible flattened map mapping custom tags, authors, and version parameters.", +"type": "object" +}, +"name": { +"description": "Required. The name of the skill.", +"type": "string" +} +}, +"type": "object" +}, +"GcsSource": { +"description": "Specifications for Cloud Storage objects.", +"id": "GcsSource", +"properties": { +"generation": { +"description": "Optional. Cloud Storage object generation ID. If not specified, the latest generation is used.", +"format": "int64", +"type": "string" +}, +"uri": { +"description": "Required. Cloud Storage object URI. Format: `gs://{bucket_name}/{object_name}`", +"type": "string" +} +}, +"type": "object" +}, "Interface": { "description": "Represents the connection details for an Agent or MCP Server.", "id": "Interface", @@ -1609,6 +2153,24 @@ }, "type": "object" }, +"ListPublishersResponse": { +"description": "Response listing Publishers.", +"id": "ListPublishersResponse", +"properties": { +"nextPageToken": { +"description": "Page offset continuation token.", +"type": "string" +}, +"publishers": { +"description": "The returned list of Publishers.", +"items": { +"$ref": "Publisher" +}, +"type": "array" +} +}, +"type": "object" +}, "ListServicesResponse": { "description": "Message for response to listing Services", "id": "ListServicesResponse", @@ -1627,6 +2189,49 @@ }, "type": "object" }, +"ListSkillRevisionsResponse": { +"description": "Response listing Revisions.", +"id": "ListSkillRevisionsResponse", +"properties": { +"nextPageToken": { +"description": "Page offset continuation token.", +"type": "string" +}, +"skillRevisions": { +"description": "Returned version snapshot list.", +"items": { +"$ref": "SkillRevision" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListSkillsResponse": { +"description": "Response structure listing logical Skills.", +"id": "ListSkillsResponse", +"properties": { +"nextPageToken": { +"description": "Page continuation continuation token.", +"type": "string" +}, +"skills": { +"description": "Returned container list.", +"items": { +"$ref": "Skill" +}, +"type": "array" +}, +"unreachable": { +"description": "Unreachable locations or failures.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -1870,6 +2475,50 @@ }, "type": "object" }, +"Publisher": { +"description": "Represents a verified Publisher of Skills. Prepopulated publishers include `publishers/cloud.google.com` and `publishers/workspace.google.com`.", +"id": "Publisher", +"properties": { +"displayName": { +"description": "Optional. Human readable display name of the publisher.", +"type": "string" +}, +"documentationUri": { +"description": "Optional. URI pointing to official publisher documentation.", +"type": "string" +}, +"name": { +"description": "Identifier. Resource name of the publisher. Format: `projects/{project}/locations/{location}/publishers/{publisher}`", +"type": "string" +}, +"publisherTier": { +"description": "Output only. The curation tier of the publisher.", +"enum": [ +"PUBLISHER_TIER_UNSPECIFIED", +"FIRST_PARTY", +"THIRD_PARTY", +"PRIVATE" +], +"enumDescriptions": [ +"Default value. Unspecified.", +"First-party Google-curated and verified global publishers.", +"Third-party verified enterprise partner publishers.", +"Private publishers within the developer's workspace/project." +], +"readOnly": true, +"type": "string" +}, +"supportUri": { +"description": "Optional. URI pointing to the support portal or email.", +"type": "string" +}, +"verifiedPrefix": { +"description": "Required. The verified prefix (e.g. \"snowflake-\", \"google-\") associated with this publisher. The system uses this prefix to enforce name-squatting rules during Skill registration. Must be globally unique across all publishers.", +"type": "string" +} +}, +"type": "object" +}, "SearchAgentsRequest": { "description": "Message for searching Agents", "id": "SearchAgentsRequest", @@ -1946,6 +2595,24 @@ }, "type": "object" }, +"SearchSkillsResponse": { +"description": "Response listing searched Skills.", +"id": "SearchSkillsResponse", +"properties": { +"nextPageToken": { +"description": "Query page offset continuation token.", +"type": "string" +}, +"skills": { +"description": "Matched Skills list.", +"items": { +"$ref": "Skill" +}, +"type": "array" +} +}, +"type": "object" +}, "Service": { "description": "Represents a user-defined Service.", "id": "Service", @@ -2001,6 +2668,186 @@ }, "type": "object" }, +"Skill": { +"description": "Represents an Executable Agent Skill or a Composite Tool Suite (Bundle). Sibling resource with Agent and McpServer under agentregistry.googleapis.com.", +"id": "Skill", +"properties": { +"createTime": { +"description": "Output only. Create time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"defaultRevision": { +"description": "Optional. The full resource name of the revision currently served by default (floating track). Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`", +"type": "string" +}, +"description": { +"description": "Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters.", +"type": "string" +}, +"displayName": { +"description": "Required. Human-readable display name of the skill. Maximum length is 128 characters.", +"type": "string" +}, +"frontmatter": { +"$ref": "Frontmatter", +"description": "Output only. Lightweight frontmatter metadata attributes copied from the default revision.", +"readOnly": true +}, +"initialRevision": { +"$ref": "SkillRevision", +"description": "Optional. Input only. Optional nested initial revision payload to support standard one-shot creation. The server processes this field on input during creation but must never return it in responses." +}, +"name": { +"description": "Identifier. Resource name of the Skill. Format: `projects/{project}/locations/{location}/skills/{skill}` The `{skill}` segment acts as the resource ID. If the skill is associated with a Publisher, this segment typically uses a hyphenated namespace prefix corresponding to the publisher (e.g., `google-workspace-create-docs`).", +"type": "string" +}, +"publisher": { +"description": "Optional. The publisher resource associated with this skill. Format: `projects/{project}/locations/{location}/publishers/{publisher}` The publisher dictates the allowed namespace prefixes for the skill's name and logical `skill_id` (e.g., Publisher `google` authorizes the `google-*` prefix).", +"type": "string" +}, +"skillId": { +"description": "Output only. A stable, globally unique logical identifier for the skill. It is securely constructed by the backend by combining the associated `publisher`'s verified namespace and the skill's resource ID to enforce strict ownership. For example, the prefix `google-` is reserved exclusively for first-party Google publishers to prevent namespace squatting. Example: `urn:skill:google-workspace:create-docs`", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The system-managed state of the skill.", +"enum": [ +"STATE_UNSPECIFIED", +"STATE_CREATING", +"STATE_DRAFT", +"STATE_ACTIVE", +"STATE_DISABLED", +"STATE_DEPRECATED", +"STATE_DECOMMISSIONED", +"STATE_DELETING" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The skill is being created. It is not served.", +"The skill is in draft, or lacks a valid payload. It is not served.", +"The skill is active and is served.", +"The skill is disabled and is not served.", +"The skill is deprecated. It is served, but emits warnings.", +"The skill is decommissioned and is not served.", +"The skill is being deleted. It is not served." +], +"readOnly": true, +"type": "string" +}, +"targetState": { +"description": "Required. User-managed target state of the skill.", +"enum": [ +"TARGET_STATE_UNSPECIFIED", +"TARGET_STATE_DRAFT", +"TARGET_STATE_ACTIVE", +"TARGET_STATE_DISABLED", +"TARGET_STATE_DEPRECATED", +"TARGET_STATE_DECOMMISSIONED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The skill is in draft and cannot be served.", +"The skill is active and can be served.", +"The skill is disabled and cannot be served.", +"The skill is deprecated. It can still be served, but emits warnings.", +"The skill is decommissioned and cannot be served." +], +"type": "string" +}, +"type": { +"description": "Required. Structural deployment type (SIMPLE leaf vs COMPOSITE bundle).", +"enum": [ +"TYPE_UNSPECIFIED", +"SIMPLE" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"A standard, leaf executable skill containing natural language and code." +], +"type": "string" +}, +"uid": { +"description": "Output only. Universally unique identifier (UUID4) for the logical container.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Update time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SkillRevision": { +"description": "Represents an immutable, versioned snapshot of a Skill package.", +"id": "SkillRevision", +"properties": { +"archiveUploadSource": { +"$ref": "ArchiveUploadSource", +"description": "Optional. Immutable. Direct write-only raw archive upload source." +}, +"createTime": { +"description": "Output only. Revision creation timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"frontmatter": { +"$ref": "Frontmatter", +"description": "Output only. Extracted YAML frontmatter configuration snapshot.", +"readOnly": true +}, +"gcsSource": { +"$ref": "GcsSource", +"description": "Optional. Immutable. Cloud Storage object generation URI." +}, +"name": { +"description": "Identifier. Resource name of the SkillRevision. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`", +"type": "string" +}, +"sha256Hash": { +"description": "Output only. Cryptographic SHA-256 integrity and deduplication digest of the payload zip.", +"readOnly": true, +"type": "string" +}, +"sizeBytes": { +"description": "Output only. Size of the compiled zip payload in bytes (assists client download progress).", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The system-managed lifecycle state of this revision.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"FAILED", +"DELETING" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The revision is being created.", +"The revision is active.", +"The revision failed to compile or ingest.", +"The revision is being deleted." +], +"readOnly": true, +"type": "string" +}, +"uid": { +"description": "Output only. Universally unique identifier (UUID4) for the skill revision.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Source": { "description": "The source of the Binding.", "id": "Source", From fd11c389f7e42470220ffce45e2216afe5aae71d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:57 +0000 Subject: [PATCH 05/84] feat(aiplatform): update the api #### aiplatform:v1 The following keys were added: - resources.projects.resources.locations.resources.indexEndpoints.methods.mutateDeployedIndex.parameters.updateMask (Total Keys: 3) - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents (Total Keys: 12) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate (Total Keys: 12) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge (Total Keys: 12) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve (Total Keys: 12) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback (Total Keys: 12) - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses (Total Keys: 14) - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact (Total Keys: 14) - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait (Total Keys: 14) - resources.servingProfiles.resources.operations.methods.cancel (Total Keys: 11) - resources.servingProfiles.resources.operations.methods.delete (Total Keys: 11) - resources.servingProfiles.resources.operations.methods.get (Total Keys: 11) - resources.servingProfiles.resources.operations.methods.list (Total Keys: 20) - resources.servingProfiles.resources.operations.methods.wait (Total Keys: 14) - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.cfgScale (Total Keys: 2) - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.colorAlignment.$ref (Total Keys: 1) - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.exrColorSpaceOverride.type (Total Keys: 1) - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.omniRewriter.$ref (Total Keys: 1) - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.spatialAlignment.$ref (Total Keys: 1) - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig (Total Keys: 3) - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig (Total Keys: 6) - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig (Total Keys: 3) - schemas.GoogleCloudAiplatformV1AudioTranscription (Total Keys: 30) - schemas.GoogleCloudAiplatformV1CodeExecutionResult.properties.id.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest.properties.force.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.encryptionSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1EvaluationSet.properties.encryptionSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ExecutableCode.properties.id.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1FunctionCall.properties.id.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1FunctionResponse.properties.id.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.allowedProjects (Total Keys: 2) - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.audioTranscriptionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GoogleMaps.properties.groundingTypes.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GoogleMapsGroundingTypes (Total Keys: 4) - schemas.GoogleCloudAiplatformV1GoogleMapsPlaces (Total Keys: 2) - schemas.GoogleCloudAiplatformV1GoogleMapsRouting (Total Keys: 2) - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.retrievalQueries (Total Keys: 2) - schemas.GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec.properties.shieldedInstanceConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig (Total Keys: 5) - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime.properties.customContainerImage.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime.properties.vmImage.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage (Total Keys: 4) - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage (Total Keys: 5) - schemas.GoogleCloudAiplatformV1Part.properties.audioTranscription.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec.properties.serviceAccount.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecContainerSpec.properties.port (Total Keys: 2) - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig.properties.customerVpcNetwork.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig.properties.dnsPeeringConfigs (Total Keys: 2) - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig.properties.networkAttachment.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig (Total Keys: 5) #### aiplatform:v1beta1 The following keys were deleted: - schemas.GenaiVertexV1beta1FunctionResultDelta.properties.contentList.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1FunctionResultDelta.properties.stringResult.type (Total Keys: 1) - schemas.GenaiVertexV1beta1FunctionResultDelta.properties.structResult.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1FunctionResultStep.properties.contentList.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1FunctionResultStep.properties.stringResult.type (Total Keys: 1) - schemas.GenaiVertexV1beta1FunctionResultStep.properties.structResult.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1GenerationConfig.properties.frequency_penalty (Total Keys: 2) - schemas.GenaiVertexV1beta1GenerationConfig.properties.presence_penalty (Total Keys: 2) - schemas.GenaiVertexV1beta1McpServerToolResultDelta.properties.contentList.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1McpServerToolResultDelta.properties.stringResult.type (Total Keys: 1) - schemas.GenaiVertexV1beta1McpServerToolResultDelta.properties.structResult.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1McpServerToolResultStep.properties.contentList.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1McpServerToolResultStep.properties.stringResult.type (Total Keys: 1) - schemas.GenaiVertexV1beta1McpServerToolResultStep.properties.structResult.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1ModelInteraction.properties.cached_content.type (Total Keys: 1) The following keys were added: - resources.memoryBanks.methods.ingestEvents (Total Keys: 12) - resources.memoryBanks.resources.memories.methods.create (Total Keys: 14) - resources.memoryBanks.resources.memories.methods.delete (Total Keys: 11) - resources.memoryBanks.resources.memories.methods.generate (Total Keys: 12) - resources.memoryBanks.resources.memories.methods.list (Total Keys: 20) - resources.memoryBanks.resources.memories.methods.patch (Total Keys: 15) - resources.memoryBanks.resources.memories.methods.purge (Total Keys: 12) - resources.memoryBanks.resources.memories.methods.retrieve (Total Keys: 24) - resources.memoryBanks.resources.memories.methods.rollback (Total Keys: 12) - resources.projects.resources.locations.resources.indexEndpoints.methods.mutateDeployedIndex.parameters.updateMask (Total Keys: 3) - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents (Total Keys: 12) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate (Total Keys: 12) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge (Total Keys: 12) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve (Total Keys: 24) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback (Total Keys: 12) - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses (Total Keys: 14) - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact (Total Keys: 14) - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.methods.get.parameters.view (Total Keys: 2) - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get (Total Keys: 22) - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext (Total Keys: 15) - resources.projects.resources.locations.resources.servingProfiles.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.servingProfiles.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.servingProfiles.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.servingProfiles.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.servingProfiles.methods.patch (Total Keys: 15) - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.cfgScale (Total Keys: 2) - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.colorAlignment.$ref (Total Keys: 1) - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.exrColorSpaceOverride.type (Total Keys: 1) - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.omniRewriter.$ref (Total Keys: 1) - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.spatialAlignment.$ref (Total Keys: 1) - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig (Total Keys: 3) - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig (Total Keys: 6) - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig (Total Keys: 3) - schemas.GenaiVertexV1beta1AgentInteraction.properties.antigravityConfig.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1AgentInteraction.properties.codeMenderConfig.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1AntigravityAgentConfig (Total Keys: 5) - schemas.GenaiVertexV1beta1CodeExecutionCallContent.deprecated (Total Keys: 1) - schemas.GenaiVertexV1beta1CodeExecutionResultContent.deprecated (Total Keys: 1) - schemas.GenaiVertexV1beta1CodeMenderAgentConfig (Total Keys: 26) - schemas.GenaiVertexV1beta1EnvironmentConfig.properties.environmentId.type (Total Keys: 1) - schemas.GenaiVertexV1beta1FileSearchCallContent.deprecated (Total Keys: 1) - schemas.GenaiVertexV1beta1FileSearchResultContent.deprecated (Total Keys: 1) - schemas.GenaiVertexV1beta1FunctionCallContent.deprecated (Total Keys: 1) - schemas.GenaiVertexV1beta1FunctionResultContent.deprecated (Total Keys: 1) - schemas.GenaiVertexV1beta1FunctionResultDelta.properties.result.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1FunctionResultStep.properties.result.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1GenerationConfig.properties.transcriptionConfig.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1GoogleMapsCallContent.deprecated (Total Keys: 1) - schemas.GenaiVertexV1beta1GoogleMapsResultContent.deprecated (Total Keys: 1) - schemas.GenaiVertexV1beta1GoogleSearchCallContent.deprecated (Total Keys: 1) - schemas.GenaiVertexV1beta1GoogleSearchResultContent.deprecated (Total Keys: 1) - schemas.GenaiVertexV1beta1Interaction.properties.labels (Total Keys: 2) - schemas.GenaiVertexV1beta1Interaction.properties.localEnvironment.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1Interaction.properties.safety_settings (Total Keys: 2) - schemas.GenaiVertexV1beta1LocalEnvironmentConfig (Total Keys: 2) - schemas.GenaiVertexV1beta1McpServerToolResultDelta.properties.result.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1McpServerToolResultStep.properties.result.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1RetrievalCallDelta (Total Keys: 4) - schemas.GenaiVertexV1beta1RetrievalCallStep (Total Keys: 8) - schemas.GenaiVertexV1beta1RetrievalResultDelta (Total Keys: 3) - schemas.GenaiVertexV1beta1RetrievalResultStep (Total Keys: 3) - schemas.GenaiVertexV1beta1SafetySetting (Total Keys: 5) - schemas.GenaiVertexV1beta1ServerToolCallDelta.properties.retrievalCall.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1ServerToolResultDelta.properties.retrievalResult.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.wordInfo.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1ThoughtContent.deprecated (Total Keys: 1) - schemas.GenaiVertexV1beta1ToolCallContent.deprecated (Total Keys: 1) - schemas.GenaiVertexV1beta1ToolCallStep.properties.retrievalCall.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1ToolResultContent.deprecated (Total Keys: 1) - schemas.GenaiVertexV1beta1ToolResultStep.properties.retrievalResult.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1TranscriptionConfig (Total Keys: 12) - schemas.GenaiVertexV1beta1WordInfo (Total Keys: 8) - schemas.GoogleCloudAiplatformV1beta1A2aPart (Total Keys: 11) - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.appId.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.artifacts (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.generation (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.history (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.status (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.userId.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact (Total Keys: 15) - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent (Total Keys: 17) - schemas.GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage (Total Keys: 12) - schemas.GoogleCloudAiplatformV1beta1A2aTaskMetadataChange (Total Keys: 6) - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus (Total Keys: 15) - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.agentFramework.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest.properties.events (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest.properties.generation (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsResponse.properties.generation (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1AudioTranscription (Total Keys: 30) - schemas.GoogleCloudAiplatformV1beta1BatchPredictionJob.properties.endpoint.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1CodeExecutionResult.properties.id.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest.properties.force.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EvaluationMetric.properties.encryptionSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EvaluationSet.properties.encryptionSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ExecutableCode.properties.id.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1FeedbackContext (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry (Total Keys: 19) - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.allowedProjects (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.audioTranscriptionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GoogleMaps.properties.groundingTypes.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1GoogleMapsPlaces (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1GoogleMapsRouting (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse.properties.events (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1ListServingProfilesResponse (Total Keys: 7) - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpec.properties.shieldedInstanceConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime.properties.customContainerImage.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime.properties.vmImage.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1Part.properties.audioTranscription.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec.properties.serviceAccount.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecContainerSpec.properties.port (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.stepCount (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig.properties.customerVpcNetwork.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig.properties.dnsPeeringConfigs (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig.properties.networkAttachment.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1ServingProfile (Total Keys: 15) - schemas.GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest.properties.updateMask (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1StructuredMemoryConfigSchemaConfig.properties.jsonSchema.type (Total Keys: 1) --- docs/dyn/aiplatform_v1.endpoints.html | 210 + docs/dyn/aiplatform_v1.html | 5 + ..._v1.projects.locations.cachedContents.html | 216 + ...tform_v1.projects.locations.endpoints.html | 210 + ...v1.projects.locations.evaluationItems.html | 768 + ....projects.locations.evaluationMetrics.html | 148 + ..._v1.projects.locations.evaluationRuns.html | 704 + ..._v1.projects.locations.evaluationSets.html | 63 + .../dyn/aiplatform_v1.projects.locations.html | 578 + ..._v1.projects.locations.indexEndpoints.html | 5 +- ...orm_v1.projects.locations.memoryBanks.html | 169 + ...ojects.locations.memoryBanks.memories.html | 661 + ...ations.memoryBanks.memories.revisions.html | 191 + ...platform_v1.projects.locations.models.html | 14 +- ...jects.locations.notebookExecutionJobs.html | 42 + ...1.projects.locations.onlineEvaluators.html | 152 +- ...form_v1.projects.locations.publishers.html | 5 + ....projects.locations.publishers.models.html | 225 + ...m_v1.projects.locations.publishers.v1.html | 91 + ...cts.locations.publishers.v1.responses.html | 128 + ...1.projects.locations.reasoningEngines.html | 68 + ...s.locations.reasoningEngines.memories.html | 30 + ...ngEngines.sandboxEnvironmentTemplates.html | 27 + ...ions.reasoningEngines.sessions.events.html | 18 + ...s.locations.reasoningEngines.sessions.html | 18 + ...tform_v1.projects.locations.schedules.html | 84 + ...ations.semanticGovernancePolicyEngine.html | 1 + ...v1.projects.locations.servingProfiles.html | 91 + ....locations.servingProfiles.operations.html | 272 + ....projects.locations.trainingPipelines.html | 8 +- ...form_v1.projects.locations.tuningJobs.html | 565 + docs/dyn/aiplatform_v1.publishers.models.html | 210 + docs/dyn/aiplatform_v1.reasoningEngines.html | 68 + ...ngEngines.sandboxEnvironmentTemplates.html | 27 + docs/dyn/aiplatform_v1.servingProfiles.html | 91 + ...latform_v1.servingProfiles.operations.html | 272 + docs/dyn/aiplatform_v1.v1.html | 378 + ...iplatform_v1beta1.batchPredictionJobs.html | 4 + docs/dyn/aiplatform_v1beta1.endpoints.html | 186 + docs/dyn/aiplatform_v1beta1.interactions.html | 58122 ++++++------ docs/dyn/aiplatform_v1beta1.memoryBanks.html | 169 + ...platform_v1beta1.memoryBanks.memories.html | 727 + ...1beta1.memoryBanks.memories.revisions.html | 191 + docs/dyn/aiplatform_v1beta1.projects.html | 5 +- ...locations.agentAnomalyDetectionScopes.html | 30 +- ...rojects.locations.batchPredictionJobs.html | 4 + ...ta1.projects.locations.cachedContents.html | 192 + ...m_v1beta1.projects.locations.datasets.html | 98 + ..._v1beta1.projects.locations.endpoints.html | 198 +- ...a1.projects.locations.evaluationItems.html | 912 + ....projects.locations.evaluationMetrics.html | 148 + ...ta1.projects.locations.evaluationRuns.html | 1236 + ...ta1.projects.locations.evaluationSets.html | 63 + ...eta1.projects.locations.exampleStores.html | 117 + ...v1beta1.projects.locations.extensions.html | 26 + ...aiplatform_v1beta1.projects.locations.html | 580 + ...ta1.projects.locations.indexEndpoints.html | 5 +- ...beta1.projects.locations.interactions.html | 75837 +++++++--------- ...1beta1.projects.locations.memoryBanks.html | 169 + ...ojects.locations.memoryBanks.memories.html | 727 + ...ations.memoryBanks.memories.revisions.html | 191 + ...orm_v1beta1.projects.locations.models.html | 14 +- ....analyzedSessions.analyzedInvocations.html | 8 +- ...ions.monitoredAgents.analyzedSessions.html | 66 +- ...a1.projects.locations.monitoredAgents.html | 22 +- ...jects.locations.notebookExecutionJobs.html | 42 + ...1.projects.locations.onlineEvaluators.html | 152 +- ...v1beta1.projects.locations.publishers.html | 5 + ....projects.locations.publishers.models.html | 204 +- ...eta1.projects.locations.publishers.v1.html | 91 + ...cts.locations.publishers.v1.responses.html | 184 + ...ions.reasoningEngines.a2aTasks.events.html | 156 +- ...s.locations.reasoningEngines.a2aTasks.html | 665 +- ...ions.reasoningEngines.feedbackEntries.html | 783 + ...1.projects.locations.reasoningEngines.html | 64 + ...s.locations.reasoningEngines.memories.html | 26 + ...ons.reasoningEngines.runtimeRevisions.html | 4 + ...ngEngines.sandboxEnvironmentTemplates.html | 27 + ...ions.reasoningEngines.sessions.events.html | 13 + ...s.locations.reasoningEngines.sessions.html | 13 + ..._v1beta1.projects.locations.schedules.html | 84 + ...ations.semanticGovernancePolicyEngine.html | 1 + ...a1.projects.locations.servingProfiles.html | 215 + ....projects.locations.trainingPipelines.html | 8 +- ...v1beta1.projects.locations.tuningJobs.html | 1199 + .../aiplatform_v1beta1.publishers.models.html | 186 + .../aiplatform_v1beta1.reasoningEngines.html | 64 + ...orm_v1beta1.reasoningEngines.memories.html | 26 + ...ngEngines.sandboxEnvironmentTemplates.html | 27 + ...eta1.reasoningEngines.sessions.events.html | 13 + ...orm_v1beta1.reasoningEngines.sessions.html | 13 + docs/dyn/aiplatform_v1beta1.v1beta1.html | 377 + .../documents/aiplatform.v1.json | 1352 +- .../documents/aiplatform.v1beta1.json | 3061 +- 94 files changed, 83278 insertions(+), 72637 deletions(-) create mode 100644 docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.revisions.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.publishers.v1.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.publishers.v1.responses.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.servingProfiles.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.servingProfiles.operations.html create mode 100644 docs/dyn/aiplatform_v1.servingProfiles.html create mode 100644 docs/dyn/aiplatform_v1.servingProfiles.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.memoryBanks.memories.revisions.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.revisions.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.publishers.v1.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.publishers.v1.responses.html diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index eb53bb10a0..269979db8c 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -128,12 +128,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -145,6 +158,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -159,6 +173,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -243,12 +258,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -260,6 +288,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -274,6 +303,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -317,6 +347,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -461,12 +508,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -478,6 +538,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -492,6 +553,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -644,6 +706,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -837,12 +905,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -854,6 +935,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -868,6 +950,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -911,6 +994,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1065,12 +1165,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1082,6 +1195,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1096,6 +1210,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1264,6 +1379,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1411,12 +1532,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1428,6 +1562,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1442,6 +1577,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1559,6 +1695,9 @@

Method Details

"retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. + "A String", + ], "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. @@ -1771,12 +1910,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1788,6 +1940,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1802,6 +1955,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1845,6 +1999,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1999,12 +2170,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2016,6 +2200,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2030,6 +2215,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2198,6 +2384,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2345,12 +2537,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2362,6 +2567,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2376,6 +2582,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2493,6 +2700,9 @@

Method Details

"retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. + "A String", + ], "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. diff --git a/docs/dyn/aiplatform_v1.html b/docs/dyn/aiplatform_v1.html index aff6463c36..89da9fad12 100644 --- a/docs/dyn/aiplatform_v1.html +++ b/docs/dyn/aiplatform_v1.html @@ -234,6 +234,11 @@

Instance Methods

Returns the semanticGovernancePolicies Resource.

+

+ servingProfiles() +

+

Returns the servingProfiles Resource.

+

skills()

diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index d686f998ac..4a9c8ea5f4 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -115,12 +115,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -132,6 +145,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -146,6 +160,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -198,12 +213,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -215,6 +243,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -229,6 +258,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -397,6 +427,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -535,12 +571,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -552,6 +601,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -566,6 +616,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -618,12 +669,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -635,6 +699,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -649,6 +714,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -817,6 +883,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -980,12 +1052,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -997,6 +1082,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1011,6 +1097,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1063,12 +1150,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1080,6 +1180,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1094,6 +1195,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1262,6 +1364,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1411,12 +1519,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1428,6 +1549,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1442,6 +1564,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1494,12 +1617,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1511,6 +1647,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1525,6 +1662,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1693,6 +1831,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1850,12 +1994,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1867,6 +2024,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1881,6 +2039,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1933,12 +2092,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1950,6 +2122,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1964,6 +2137,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2132,6 +2306,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2271,12 +2451,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2288,6 +2481,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2302,6 +2496,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2354,12 +2549,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2371,6 +2579,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2385,6 +2594,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2553,6 +2763,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index bb29f97b60..a678b41618 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -196,12 +196,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -213,6 +226,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -227,6 +241,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -311,12 +326,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -328,6 +356,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -342,6 +371,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -385,6 +415,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -529,12 +576,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -546,6 +606,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -560,6 +621,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -712,6 +774,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1801,12 +1869,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1818,6 +1899,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1832,6 +1914,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1875,6 +1958,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2029,12 +2129,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2046,6 +2159,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2060,6 +2174,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2228,6 +2343,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2375,12 +2496,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2392,6 +2526,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2406,6 +2541,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2523,6 +2659,9 @@

Method Details

"retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. + "A String", + ], "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. @@ -4217,12 +4356,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4234,6 +4386,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -4248,6 +4401,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -4291,6 +4445,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4445,12 +4616,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4462,6 +4646,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -4476,6 +4661,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -4644,6 +4830,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -4791,12 +4983,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4808,6 +5013,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -4822,6 +5028,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -4939,6 +5146,9 @@

Method Details

"retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. + "A String", + ], "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html index 393286c4cf..57767d6265 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html @@ -245,6 +245,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -477,6 +483,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -595,12 +607,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -612,6 +637,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -626,6 +652,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -814,6 +841,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1046,6 +1079,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1164,12 +1203,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1181,6 +1233,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1195,6 +1248,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1382,6 +1436,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1614,6 +1674,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1732,12 +1798,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1749,6 +1828,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1763,6 +1843,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1819,12 +1900,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1836,6 +1930,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1850,6 +1945,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2082,6 +2178,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2314,6 +2416,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2432,12 +2540,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2449,6 +2570,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2463,6 +2585,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2651,6 +2774,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2883,6 +3012,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3001,12 +3136,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3018,6 +3166,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3032,6 +3181,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3219,6 +3369,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3451,6 +3607,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3569,12 +3731,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3586,6 +3761,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3600,6 +3776,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3656,12 +3833,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3673,6 +3863,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3687,6 +3878,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3910,6 +4102,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -4142,6 +4340,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -4260,12 +4464,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4277,6 +4494,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -4291,6 +4509,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -4479,6 +4698,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -4711,6 +4936,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -4829,12 +5060,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4846,6 +5090,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -4860,6 +5105,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -5047,6 +5293,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -5279,6 +5531,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -5397,12 +5655,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -5414,6 +5685,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -5428,6 +5700,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -5484,12 +5757,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -5501,6 +5787,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -5515,6 +5802,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -5747,6 +6035,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -5979,6 +6273,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -6097,12 +6397,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6114,6 +6427,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -6128,6 +6442,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -6316,6 +6631,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -6548,6 +6869,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -6666,12 +6993,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6683,6 +7023,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -6697,6 +7038,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -6884,6 +7226,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7116,6 +7464,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7234,12 +7588,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7251,6 +7618,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -7265,6 +7633,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -7321,12 +7690,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7338,6 +7720,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -7352,6 +7735,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -7617,6 +8001,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7849,6 +8239,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7967,12 +8363,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7984,6 +8393,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -7998,6 +8408,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -8186,6 +8597,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -8418,6 +8835,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -8536,12 +8959,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8553,6 +8989,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -8567,6 +9004,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -8754,6 +9192,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -8986,6 +9430,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -9104,12 +9554,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9121,6 +9584,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -9135,6 +9599,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -9191,12 +9656,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9208,6 +9686,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -9222,6 +9701,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -9454,6 +9934,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -9686,6 +10172,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -9804,12 +10296,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9821,6 +10326,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -9835,6 +10341,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -10023,6 +10530,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -10255,6 +10768,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -10373,12 +10892,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -10390,6 +10922,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -10404,6 +10937,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -10591,6 +11125,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -10823,6 +11363,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -10941,12 +11487,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -10958,6 +11517,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -10972,6 +11532,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -11028,12 +11589,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11045,6 +11619,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -11059,6 +11634,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -11295,6 +11871,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -11527,6 +12109,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -11645,12 +12233,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11662,6 +12263,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -11676,6 +12278,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -11864,6 +12467,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -12096,6 +12705,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -12214,12 +12829,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -12231,6 +12859,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -12245,6 +12874,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -12432,6 +13062,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -12664,6 +13300,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -12782,12 +13424,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -12799,6 +13454,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -12813,6 +13469,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -12869,12 +13526,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -12886,6 +13556,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -12900,6 +13571,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -13132,6 +13804,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -13364,6 +14042,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -13482,12 +14166,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -13499,6 +14196,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -13513,6 +14211,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -13701,6 +14400,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -13933,6 +14638,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -14051,12 +14762,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -14068,6 +14792,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -14082,6 +14807,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -14269,6 +14995,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -14501,6 +15233,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -14619,12 +15357,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -14636,6 +15387,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -14650,6 +15402,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -14706,12 +15459,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -14723,6 +15489,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -14737,6 +15504,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html index b853265a44..70916183fb 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html @@ -111,6 +111,9 @@

Method Details

"createTime": "A String", # Output only. The time when the EvaluationMetric was created. "description": "A String", # Optional. A description of the EvaluationMetric. "displayName": "A String", # Required. The user-friendly display name for the EvaluationMetric. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "gcsUri": "A String", # Optional. The Google Cloud Storage URI that stores the metric specification.. "labels": { # Optional. Labels for the evaluation metric. "a_key": "A String", @@ -142,6 +145,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -299,6 +319,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -504,6 +541,9 @@

Method Details

"createTime": "A String", # Output only. The time when the EvaluationMetric was created. "description": "A String", # Optional. A description of the EvaluationMetric. "displayName": "A String", # Required. The user-friendly display name for the EvaluationMetric. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "gcsUri": "A String", # Optional. The Google Cloud Storage URI that stores the metric specification.. "labels": { # Optional. Labels for the evaluation metric. "a_key": "A String", @@ -535,6 +575,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -692,6 +749,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -938,6 +1012,9 @@

Method Details

"createTime": "A String", # Output only. The time when the EvaluationMetric was created. "description": "A String", # Optional. A description of the EvaluationMetric. "displayName": "A String", # Required. The user-friendly display name for the EvaluationMetric. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "gcsUri": "A String", # Optional. The Google Cloud Storage URI that stores the metric specification.. "labels": { # Optional. Labels for the evaluation metric. "a_key": "A String", @@ -969,6 +1046,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1126,6 +1220,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1343,6 +1454,9 @@

Method Details

"createTime": "A String", # Output only. The time when the EvaluationMetric was created. "description": "A String", # Optional. A description of the EvaluationMetric. "displayName": "A String", # Required. The user-friendly display name for the EvaluationMetric. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "gcsUri": "A String", # Optional. The Google Cloud Storage URI that stores the metric specification.. "labels": { # Optional. Labels for the evaluation metric. "a_key": "A String", @@ -1374,6 +1488,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1531,6 +1662,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html index 9f867fadb4..62bcc25405 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -168,6 +168,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -347,6 +364,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -499,6 +533,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -675,6 +726,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -832,6 +900,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1046,6 +1131,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1192,6 +1294,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1367,6 +1486,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1544,6 +1680,23 @@

Method Details

"maxTurn": 42, # Maximum number of invocations allowed by the multi-turn agent scraping. This property allows us to stop a run-off conversation, where the agent and the user simulator get into a never ending loop. The initial fixed prompt is also counted as an invocation. "modelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # The configuration for the model. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1805,6 +1958,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1923,6 +2082,23 @@

Method Details

}, "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2118,6 +2294,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2297,6 +2490,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2449,6 +2659,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2625,6 +2852,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2782,6 +3026,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2996,6 +3257,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3142,6 +3420,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3317,6 +3612,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3494,6 +3806,23 @@

Method Details

"maxTurn": 42, # Maximum number of invocations allowed by the multi-turn agent scraping. This property allows us to stop a run-off conversation, where the agent and the user simulator get into a never ending loop. The initial fixed prompt is also counted as an invocation. "modelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # The configuration for the model. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3755,6 +4084,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3873,6 +4208,23 @@

Method Details

}, "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4110,6 +4462,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4289,6 +4658,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4441,6 +4827,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4617,6 +5020,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4774,6 +5194,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4988,6 +5425,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5134,6 +5588,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5309,6 +5780,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5486,6 +5974,23 @@

Method Details

"maxTurn": 42, # Maximum number of invocations allowed by the multi-turn agent scraping. This property allows us to stop a run-off conversation, where the agent and the user simulator get into a never ending loop. The initial fixed prompt is also counted as an invocation. "modelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # The configuration for the model. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5747,6 +6252,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -5865,6 +6376,23 @@

Method Details

}, "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -6073,6 +6601,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -6252,6 +6797,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -6404,6 +6966,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -6580,6 +7159,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -6737,6 +7333,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -6951,6 +7564,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -7097,6 +7727,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -7272,6 +7919,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -7449,6 +8113,23 @@

Method Details

"maxTurn": 42, # Maximum number of invocations allowed by the multi-turn agent scraping. This property allows us to stop a run-off conversation, where the agent and the user simulator get into a never ending loop. The initial fixed prompt is also counted as an invocation. "modelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # The configuration for the model. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -7710,6 +8391,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7828,6 +8515,23 @@

Method Details

}, "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html index 9df98be642..7d03575502 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html @@ -235,6 +235,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -353,6 +359,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], @@ -491,6 +500,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -609,6 +624,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], @@ -789,6 +807,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -907,6 +931,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], @@ -1078,6 +1105,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1196,6 +1229,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], @@ -1393,6 +1429,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1511,6 +1553,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], @@ -1668,6 +1713,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1786,6 +1837,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], @@ -1925,6 +1979,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2043,6 +2103,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index f410629cb6..5394d48b28 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -264,6 +264,11 @@

Instance Methods

Returns the semanticGovernancePolicyEngine Resource.

+

+ servingProfiles() +

+

Returns the servingProfiles Resource.

+

skills()

@@ -496,6 +501,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -783,6 +794,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -942,12 +959,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -959,6 +989,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -973,6 +1004,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1061,12 +1093,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1078,6 +1123,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1092,6 +1138,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1171,12 +1218,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input content to corroborate, only text format is supported for now. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1188,6 +1248,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1202,6 +1263,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1536,6 +1598,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1714,6 +1793,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1871,6 +1967,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2111,6 +2224,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2329,12 +2459,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2346,6 +2489,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2360,6 +2504,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2520,6 +2665,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2648,12 +2799,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2665,6 +2829,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2679,6 +2844,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2839,6 +3005,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2963,12 +3135,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2980,6 +3165,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2994,6 +3180,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3043,12 +3230,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3060,6 +3260,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3074,6 +3275,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3229,6 +3431,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3461,6 +3669,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3579,12 +3793,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3596,6 +3823,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3610,6 +3838,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3669,12 +3898,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3686,6 +3928,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3700,6 +3943,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3752,12 +3996,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3769,6 +4026,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3783,6 +4041,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3833,12 +4092,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3850,6 +4122,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3864,6 +4137,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3914,12 +4188,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3931,6 +4218,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3945,6 +4233,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -4038,6 +4327,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4195,6 +4501,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4414,6 +4737,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4571,6 +4911,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4781,12 +5138,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4798,6 +5168,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -4812,6 +5183,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -4903,12 +5275,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4920,6 +5305,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -4934,6 +5320,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -5541,12 +5928,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -5558,6 +5958,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -5572,6 +5973,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -5732,6 +6134,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -5853,12 +6261,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -5870,6 +6291,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -5884,6 +6306,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -5939,6 +6362,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -6293,6 +6733,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -6525,6 +6971,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -6643,12 +7095,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6660,6 +7125,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -6674,6 +7140,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -6862,6 +7329,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7094,6 +7567,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7212,12 +7691,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7229,6 +7721,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -7243,6 +7736,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -7430,6 +7924,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7662,6 +8162,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7780,12 +8286,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7797,6 +8316,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -7811,6 +8331,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -7867,12 +8388,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7884,6 +8418,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -7898,6 +8433,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -8018,12 +8554,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The actual content or value for this field. This can be text, images, or other types of data. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8035,6 +8584,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -8049,6 +8599,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -8122,12 +8673,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The actual content or value for this field. This can be text, images, or other types of data. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8139,6 +8703,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -8153,6 +8718,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -8332,6 +8898,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -8559,6 +9131,9 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was created. "gatewayConfigs": { # Optional. Configurations for gateways. The keys are user-defined names for each gateway. At most 5 gateway configurations are allowed. "a_key": { # Configuration for a single gateway. + "allowedProjects": [ # Optional. Additional consumer projects permitted to attach their own PSC endpoint to this gateway's ServiceAttachment. This is the "decoupled" mode, where the customer creates the PSC endpoint in a project other than this gateway's `network` project. Each listed project is VPC-SC enforced: it must be within the caller's service perimeter. The owning SemanticGovernancePolicyEngine's own project is always permitted implicitly and need not be listed. Format: project ID or number. + "A String", + ], "dnsRecord": "A String", # Output only. The fully qualified record name of the created A-record in Cloud DNS. "dnsZoneName": "A String", # Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint. "ipAddress": "A String", # Output only. The private IP address of the PSC endpoint. @@ -8771,6 +9346,9 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was created. "gatewayConfigs": { # Optional. Configurations for gateways. The keys are user-defined names for each gateway. At most 5 gateway configurations are allowed. "a_key": { # Configuration for a single gateway. + "allowedProjects": [ # Optional. Additional consumer projects permitted to attach their own PSC endpoint to this gateway's ServiceAttachment. This is the "decoupled" mode, where the customer creates the PSC endpoint in a project other than this gateway's `network` project. Each listed project is VPC-SC enforced: it must be within the caller's service perimeter. The owning SemanticGovernancePolicyEngine's own project is always permitted implicitly and need not be listed. Format: project ID or number. + "A String", + ], "dnsRecord": "A String", # Output only. The fully qualified record name of the created A-record in Cloud DNS. "dnsZoneName": "A String", # Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint. "ipAddress": "A String", # Output only. The private IP address of the PSC endpoint. diff --git a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html index e2b908bab3..f299ee9972 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html @@ -104,7 +104,7 @@

Instance Methods

list_next()

Retrieves the next page of results.

- mutateDeployedIndex(indexEndpoint, body=None, x__xgafv=None)

+ mutateDeployedIndex(indexEndpoint, body=None, updateMask=None, x__xgafv=None)

Update an existing DeployedIndex under an IndexEndpoint.

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

@@ -837,7 +837,7 @@

Method Details

- mutateDeployedIndex(indexEndpoint, body=None, x__xgafv=None) + mutateDeployedIndex(indexEndpoint, body=None, updateMask=None, x__xgafv=None)
Update an existing DeployedIndex under an IndexEndpoint.
 
 Args:
@@ -921,6 +921,7 @@ 

Method Details

], } + updateMask: string, Optional. The update mask applies to the resource. The supported paths are `automatic_resources`, `dedicated_resources`, `enable_access_logging` and `deployed_index_auth_config`. When omitted, the service will perform a full update of all fields. See google.protobuf.FieldMask. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.html b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.html index 869428ee88..878c4c3dda 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.html +++ b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.html @@ -87,10 +87,179 @@

Instance Methods

close()

Close httplib2 connections.

+

+ ingestEvents(parent, body=None, x__xgafv=None)

+

Ingests events for a Memory Bank.

Method Details

close()
Close httplib2 connections.
+
+ ingestEvents(parent, body=None, x__xgafv=None) +
Ingests events for a Memory Bank.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.IngestEvents.
+  "directContentsSource": { # Ingest events directly from the request. # Ingest events directly from the request.
+    "events": [ # Required. The events to ingest.
+      { # A single event to ingest.
+        "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event.
+          "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+            { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+              "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data.
+                "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set.
+                "text": "A String", # Required. The transcription text of this audio segment.
+                "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set.
+                  { # Information about a single recognized word.
+                    "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio.
+                    "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio.
+                    "word": "A String", # Required. Transcript of the word.
+                  },
+                ],
+              },
+              "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+                "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.
+                "outcome": "A String", # Required. Outcome of the code execution.
+                "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+              },
+              "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                "code": "A String", # Required. The code to be executed.
+                "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.
+                "language": "A String", # Required. Programming language of the `code`.
+              },
+              "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                  "a_key": "", # Properties of the object.
+                },
+                "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+                "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                  { # Partial argument value of the function call.
+                    "boolValue": True or False, # Optional. Represents a boolean value.
+                    "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                    "nullValue": "A String", # Optional. Represents a null value.
+                    "numberValue": 3.14, # Optional. Represents a double value.
+                    "stringValue": "A String", # Optional. Represents a string value.
+                    "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                  },
+                ],
+                "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+              },
+              "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+                "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                  { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                    "fileData": { # URI based data for function response. # URI based data.
+                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "fileUri": "A String", # Required. URI.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                      "data": "A String", # Required. Raw bytes.
+                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                  },
+                ],
+                "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                  "a_key": "", # Properties of the object.
+                },
+                "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+              },
+              "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                "data": "A String", # Required. The raw bytes of the data.
+                "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+                "level": "A String", # The tokenization quality used for given media.
+              },
+              "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+              "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+              "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+              "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                "endOffset": "A String", # Optional. The end offset of the video.
+                "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                "startOffset": "A String", # Optional. The start offset of the video.
+              },
+            },
+          ],
+          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+        },
+        "eventId": "A String", # Optional. A unique identifier for the event. If an event with the same event_id is ingested multiple times, it will be de-duplicated.
+        "eventTime": "A String", # Optional. The time at which the event occurred. If provided, this timestamp will be used for ordering events within a stream. If not provided, the server-side ingestion time will be used.
+      },
+    ],
+  },
+  "disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request.
+  "forceFlush": True or False, # Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`.
+  "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately.
+    "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately.
+      "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit.
+      "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity.
+      "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.
+      "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window.
+    },
+  },
+  "metadata": { # Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "metadataMergeStrategy": "A String", # Optional. The strategy to use when applying metadata to existing memories.
+  "revisionExpireTime": "A String", # Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. The TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. The scope of the memories that should be generated from the stream. Memories will be consolidated across memories with the same scope. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "streamId": "A String", # Optional. The ID of the stream to ingest events into. If not provided, a new one will be created.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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.memoryBanks.memories.html b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.html index 880a6ad4d4..5a94d9f413 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.html +++ b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.html @@ -79,18 +79,337 @@

Instance Methods

Returns the operations Resource.

+

+ revisions() +

+

Returns the revisions Resource.

+

close()

Close httplib2 connections.

+

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

+

Create a Memory.

+

+ delete(name, x__xgafv=None)

+

Delete a Memory.

+

+ generate(parent, body=None, x__xgafv=None)

+

Generate memories.

get(name, x__xgafv=None)

Get a Memory.

+

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

+

List Memories.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a Memory.

+

+ purge(parent, body=None, x__xgafv=None)

+

Purge memories.

+

+ retrieve(parent, body=None, x__xgafv=None)

+

Retrieve memories.

+

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

+

Rollback Memory to a specific revision.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, memoryId=None, x__xgafv=None) +
Create a Memory.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A memory.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+  "description": "A String", # Optional. Represents the description of the Memory.
+  "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+  "displayName": "A String", # Optional. Represents the display name of the Memory.
+  "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+  "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+  "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+  "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "topics": [ # Optional. Represents the Topics of the Memory.
+    { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+    },
+  ],
+  "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+}
+
+  memoryId: string, Optional. The user defined ID to use for memory, which will become the final component of the memory 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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete a Memory.
+
+Args:
+  name: string, Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ generate(parent, body=None, x__xgafv=None) +
Generate memories.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB.
+  "allowedTopics": [ # Optional. Restricts memory generation to a subset of memory topics.
+    { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+    },
+  ],
+  "directContentsSource": { # Defines a direct source of content from which to generate the memories. # Defines a direct source of content as the source content from which to generate memories.
+    "events": [ # Required. The source content (i.e. chat history) to generate memories from.
+      { # A single piece of conversation from which to generate memories.
+        "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single piece of content from which to generate memories.
+          "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+            { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+              "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data.
+                "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set.
+                "text": "A String", # Required. The transcription text of this audio segment.
+                "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set.
+                  { # Information about a single recognized word.
+                    "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio.
+                    "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio.
+                    "word": "A String", # Required. Transcript of the word.
+                  },
+                ],
+              },
+              "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+                "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.
+                "outcome": "A String", # Required. Outcome of the code execution.
+                "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+              },
+              "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                "code": "A String", # Required. The code to be executed.
+                "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.
+                "language": "A String", # Required. Programming language of the `code`.
+              },
+              "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                  "a_key": "", # Properties of the object.
+                },
+                "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+                "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                  { # Partial argument value of the function call.
+                    "boolValue": True or False, # Optional. Represents a boolean value.
+                    "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                    "nullValue": "A String", # Optional. Represents a null value.
+                    "numberValue": 3.14, # Optional. Represents a double value.
+                    "stringValue": "A String", # Optional. Represents a string value.
+                    "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                  },
+                ],
+                "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+              },
+              "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+                "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                  { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                    "fileData": { # URI based data for function response. # URI based data.
+                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "fileUri": "A String", # Required. URI.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                      "data": "A String", # Required. Raw bytes.
+                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                  },
+                ],
+                "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                  "a_key": "", # Properties of the object.
+                },
+                "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+              },
+              "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                "data": "A String", # Required. The raw bytes of the data.
+                "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+                "level": "A String", # The tokenization quality used for given media.
+              },
+              "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+              "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+              "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+              "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                "endOffset": "A String", # Optional. The end offset of the video.
+                "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                "startOffset": "A String", # Optional. The start offset of the video.
+              },
+            },
+          ],
+          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+        },
+      },
+    ],
+  },
+  "directMemoriesSource": { # Defines a direct source of memories that should be uploaded to Memory Bank with consolidation. # Defines a direct source of memories that should be uploaded to Memory Bank. This is similar to `CreateMemory`, but it allows for consolidation between these new memories and existing memories for the same scope.
+    "directMemories": [ # Required. The direct memories to upload to Memory Bank. At most 5 direct memories are allowed per request.
+      { # A direct memory to upload to Memory Bank.
+        "fact": "A String", # Required. The fact to consolidate with existing memories.
+        "topics": [ # Optional. The topics that the consolidated memories should be associated with.
+          { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+            "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+            "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+          },
+        ],
+      },
+    ],
+  },
+  "disableConsolidation": True or False, # Optional. If true, generated memories will not be consolidated with existing memories; all generated memories will be added as new memories regardless of whether they are duplicates of or contradictory to existing memories. By default, memory consolidation is enabled.
+  "disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request.
+  "metadata": { # Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "metadataMergeStrategy": "A String", # Optional. The strategy to use when applying metadata to existing memories.
+  "revisionExpireTime": "A String", # Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. The TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "vertexSessionSource": { # Defines an Agent Engine Session from which to generate the memories. If `scope` is not provided, the scope will be extracted from the Session (i.e. {"user_id": sesison.user_id}). # Defines a Vertex Session as the source content from which to generate memories.
+    "endTime": "A String", # Optional. End time (exclusive) of the time range. If not set, the end time is unbounded.
+    "session": "A String", # Required. The resource name of the Session to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
+    "startTime": "A String", # Optional. Time range to define which session events should be used to generate memories. Start time (inclusive) of the time range. If not set, the start time is unbounded.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
get(name, x__xgafv=None)
Get a Memory.
@@ -140,4 +459,346 @@ 

Method Details

}
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
List Memories.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`)
+  orderBy: string, Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`
+  pageSize: integer, Optional. The standard list page size.
+  pageToken: string, Optional. The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for MemoryBankService.ListMemories.
+  "memories": [ # List of Memories in the requested page.
+    { # A memory.
+      "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+      "description": "A String", # Optional. Represents the description of the Memory.
+      "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+      "displayName": "A String", # Optional. Represents the display name of the Memory.
+      "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+      "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+      "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+        "a_key": { # Memory metadata.
+          "boolValue": True or False, # Represents a boolean value.
+          "doubleValue": 3.14, # Represents a double value.
+          "stringValue": "A String", # Represents a string value.
+          "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+        },
+      },
+      "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+      "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+      "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+        "a_key": "A String",
+      },
+      "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+      "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+        "a_key": "A String",
+      },
+      "topics": [ # Optional. Represents the Topics of the Memory.
+        { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+          "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+          "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+        },
+      ],
+      "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+      "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListMemoriesRequest.page_token to obtain that page.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update a Memory.
+
+Args:
+  name: string, Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A memory.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+  "description": "A String", # Optional. Represents the description of the Memory.
+  "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+  "displayName": "A String", # Optional. Represents the display name of the Memory.
+  "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+  "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+  "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+  "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "topics": [ # Optional. Represents the Topics of the Memory.
+    { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+    },
+  ],
+  "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+}
+
+  updateMask: string, Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ purge(parent, body=None, x__xgafv=None) +
Purge memories.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.PurgeMemories.
+  "filter": "A String", # Required. The standard list filter to determine which memories to purge. More detail in [AIP-160](https://google.aip.dev/160).
+  "filterGroups": [ # Optional. Metadata filters that will be applied to the memories to be purged. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`.
+    { # A conjunction of filters that will be combined using AND logic.
+      "filters": [ # Represents filters that will be combined using AND logic.
+        { # Filter to apply when retrieving memories.
+          "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author".
+          "negate": True or False, # Indicates whether the filter will be negated.
+          "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used.
+          "value": { # Memory metadata. # Represents the value to compare to.
+            "boolValue": True or False, # Represents a boolean value.
+            "doubleValue": 3.14, # Represents a double value.
+            "stringValue": "A String", # Represents a string value.
+            "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+          },
+        },
+      ],
+    },
+  ],
+  "force": True or False, # Optional. If true, the memories will actually be purged. If false, the purge request will be validated but not executed.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ retrieve(parent, body=None, x__xgafv=None) +
Retrieve memories.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.RetrieveMemories.
+  "filter": "A String", # Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time` * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`)
+  "filterGroups": [ # Optional. Metadata filters that will be applied to the retrieved memories' `metadata` using OR logic. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`.
+    { # A conjunction of filters that will be combined using AND logic.
+      "filters": [ # Represents filters that will be combined using AND logic.
+        { # Filter to apply when retrieving memories.
+          "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author".
+          "negate": True or False, # Indicates whether the filter will be negated.
+          "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used.
+          "value": { # Memory metadata. # Represents the value to compare to.
+            "boolValue": True or False, # Represents a boolean value.
+            "doubleValue": 3.14, # Represents a double value.
+            "stringValue": "A String", # Represents a string value.
+            "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+          },
+        },
+      ],
+    },
+  ],
+  "memoryTypes": [ # Optional. Specifies the types of memories to retrieve. If this field is empty or not provided, the request will default to retrieving only memories of type `NATURAL_LANGUAGE_COLLECTION`. If populated, the request will retrieve memories matching any of the specified `MemoryType` values.
+    "A String",
+  ],
+  "scope": { # Required. The scope of the memories to retrieve. A memory must have exactly the same scope (`Memory.scope`) as the scope provided here to be retrieved (same keys and values). Order does not matter, but it is case-sensitive.
+    "a_key": "A String",
+  },
+  "similaritySearchParams": { # Parameters for semantic similarity search based retrieval. # Parameters for semantic similarity search based retrieval.
+    "searchQuery": "A String", # Required. Query to use for similarity search retrieval. If provided, then the parent ReasoningEngine must have ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig set.
+    "topK": 42, # Optional. The maximum number of memories to return. The service may return fewer than this value. If unspecified, at most 3 memories will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  },
+  "simpleRetrievalParams": { # Parameters for simple (non-similarity search) retrieval. # Parameters for simple (non-similarity search) retrieval.
+    "pageSize": 42, # Optional. The maximum number of memories to return. The service may return fewer than this value. If unspecified, at most 3 memories will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+    "pageToken": "A String", # Optional. A page token, received from a previous `RetrieveMemories` call. Provide this to retrieve the subsequent page.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for MemoryBankService.RetrieveMemories.
+  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. This token is not set if similarity search was used for retrieval.
+  "retrievedMemories": [ # The retrieved memories.
+    { # A retrieved memory.
+      "distance": 3.14, # The distance between the query and the retrieved Memory. Smaller values indicate more similar memories. This is only set if similarity search was used for retrieval.
+      "memory": { # A memory. # The retrieved Memory.
+        "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+        "description": "A String", # Optional. Represents the description of the Memory.
+        "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+        "displayName": "A String", # Optional. Represents the display name of the Memory.
+        "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+        "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+        "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+          "a_key": { # Memory metadata.
+            "boolValue": True or False, # Represents a boolean value.
+            "doubleValue": 3.14, # Represents a double value.
+            "stringValue": "A String", # Represents a string value.
+            "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+          },
+        },
+        "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+        "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+        "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+          "a_key": "A String",
+        },
+        "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+        "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+          "a_key": "A String",
+        },
+        "topics": [ # Optional. Represents the Topics of the Memory.
+          { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+            "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+            "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+          },
+        ],
+        "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+        "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+      },
+    },
+  ],
+}
+
+ +
+ rollback(name, body=None, x__xgafv=None) +
Rollback Memory to a specific revision.
+
+Args:
+  name: string, Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.RollbackMemory.
+  "targetRevisionId": "A String", # Required. The ID of the revision to rollback to.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.revisions.html b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.revisions.html new file mode 100644 index 0000000000..f5adaf4997 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.revisions.html @@ -0,0 +1,191 @@ + + + +

Agent Platform API . projects . locations . memoryBanks . memories . revisions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a Memory Revision.

+

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

+

List Memory Revisions for a Memory.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get a Memory Revision.
+
+Args:
+  name: string, Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A revision of a Memory.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory Revision was created.
+  "expireTime": "A String", # Output only. Represents the timestamp of when this resource is considered expired.
+  "extractedMemories": [ # Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.
+    { # An extracted memory that is the intermediate result before consolidation.
+      "context": "A String", # Output only. Represents the explanation of why the information was extracted from the source content.
+      "fact": "A String", # Output only. Represents the fact of the extracted memory.
+      "structuredData": { # Output only. Represents the structured value of the extracted memory.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  ],
+  "fact": "A String", # Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.
+  "labels": { # Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`
+  "structuredData": { # Output only. Represents the structured value of the memory at the time of revision creation.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
List Memory Revisions for a Memory.
+
+Args:
+  parent: string, Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`
+  pageSize: integer, Optional. The standard list page size.
+  pageToken: string, Optional. The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for MemoryBankService.ListMemoryRevisions.
+  "memoryRevisions": [ # The list of Memory Revisions in the request page.
+    { # A revision of a Memory.
+      "createTime": "A String", # Output only. Represents the timestamp when this Memory Revision was created.
+      "expireTime": "A String", # Output only. Represents the timestamp of when this resource is considered expired.
+      "extractedMemories": [ # Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.
+        { # An extracted memory that is the intermediate result before consolidation.
+          "context": "A String", # Output only. Represents the explanation of why the information was extracted from the source content.
+          "fact": "A String", # Output only. Represents the fact of the extracted memory.
+          "structuredData": { # Output only. Represents the structured value of the extracted memory.
+            "a_key": "", # Properties of the object.
+          },
+        },
+      ],
+      "fact": "A String", # Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.
+      "labels": { # Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`
+      "structuredData": { # Output only. Represents the structured value of the memory at the time of revision creation.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.models.html b/docs/dyn/aiplatform_v1.projects.locations.models.html index 2313281c27..ebbb0835c2 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.models.html @@ -348,7 +348,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -731,7 +731,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -1124,7 +1124,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -1505,7 +1505,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -1841,7 +1841,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -2176,7 +2176,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -2650,7 +2650,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html index 3feb5a650f..734cd5ffdb 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html @@ -138,6 +138,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -177,6 +182,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, } @@ -290,6 +304,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -329,6 +348,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }
@@ -385,6 +413,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -424,6 +457,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.onlineEvaluators.html b/docs/dyn/aiplatform_v1.projects.locations.onlineEvaluators.html index 731560bb44..0204c2643c 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.onlineEvaluators.html +++ b/docs/dyn/aiplatform_v1.projects.locations.onlineEvaluators.html @@ -172,7 +172,7 @@

Method Details

"traceScope": { # If chosen, the online evaluator will evaluate single traces matching specified `filter`. # Scope online evaluation to single traces. "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. { # Defines a single filter predicate. - "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace. + "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace (in seconds). "comparisonOperator": "A String", # Required. The comparison operator to apply. "value": 3.14, # Required. The value to compare against. }, @@ -192,7 +192,7 @@

Method Details

}, }, "createTime": "A String", # Output only. Timestamp when the OnlineEvaluator was created. - "displayName": "A String", # Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. + "displayName": "A String", # Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. { # The metric source used for evaluation. "metric": { # The metric used for running evaluations. # Inline metric config. @@ -222,6 +222,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -379,6 +396,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -668,7 +702,7 @@

Method Details

"traceScope": { # If chosen, the online evaluator will evaluate single traces matching specified `filter`. # Scope online evaluation to single traces. "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. { # Defines a single filter predicate. - "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace. + "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace (in seconds). "comparisonOperator": "A String", # Required. The comparison operator to apply. "value": 3.14, # Required. The value to compare against. }, @@ -688,7 +722,7 @@

Method Details

}, }, "createTime": "A String", # Output only. Timestamp when the OnlineEvaluator was created. - "displayName": "A String", # Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. + "displayName": "A String", # Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. { # The metric source used for evaluation. "metric": { # The metric used for running evaluations. # Inline metric config. @@ -718,6 +752,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -875,6 +926,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1108,7 +1176,7 @@

Method Details

"traceScope": { # If chosen, the online evaluator will evaluate single traces matching specified `filter`. # Scope online evaluation to single traces. "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. { # Defines a single filter predicate. - "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace. + "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace (in seconds). "comparisonOperator": "A String", # Required. The comparison operator to apply. "value": 3.14, # Required. The value to compare against. }, @@ -1128,7 +1196,7 @@

Method Details

}, }, "createTime": "A String", # Output only. Timestamp when the OnlineEvaluator was created. - "displayName": "A String", # Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. + "displayName": "A String", # Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. { # The metric source used for evaluation. "metric": { # The metric used for running evaluations. # Inline metric config. @@ -1158,6 +1226,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1315,6 +1400,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1552,7 +1654,7 @@

Method Details

"traceScope": { # If chosen, the online evaluator will evaluate single traces matching specified `filter`. # Scope online evaluation to single traces. "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. { # Defines a single filter predicate. - "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace. + "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace (in seconds). "comparisonOperator": "A String", # Required. The comparison operator to apply. "value": 3.14, # Required. The value to compare against. }, @@ -1572,7 +1674,7 @@

Method Details

}, }, "createTime": "A String", # Output only. Timestamp when the OnlineEvaluator was created. - "displayName": "A String", # Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. + "displayName": "A String", # Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. { # The metric source used for evaluation. "metric": { # The metric used for running evaluations. # Inline metric config. @@ -1602,6 +1704,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1759,6 +1878,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.html index 7d03c9ec2f..5f9afbe16b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.html @@ -79,6 +79,11 @@

Instance Methods

Returns the models Resource.

+

+ v1() +

+

Returns the v1 Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index 1361cff7ef..02037958b0 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -135,12 +135,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -152,6 +165,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -166,6 +180,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -250,12 +265,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -267,6 +295,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -281,6 +310,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -324,6 +354,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -468,12 +515,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -485,6 +545,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -499,6 +560,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -651,6 +713,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -801,12 +869,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content to be embedded. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -818,6 +899,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -832,6 +914,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -993,12 +1076,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1010,6 +1106,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1024,6 +1121,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1067,6 +1165,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1221,12 +1336,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1238,6 +1366,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1252,6 +1381,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1420,6 +1550,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1567,12 +1703,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1584,6 +1733,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1598,6 +1748,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1715,6 +1866,9 @@

Method Details

"retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. + "A String", + ], "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. @@ -2155,12 +2309,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2172,6 +2339,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2186,6 +2354,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2229,6 +2398,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2383,12 +2569,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2400,6 +2599,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2414,6 +2614,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2582,6 +2783,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2729,12 +2936,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2746,6 +2966,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2760,6 +2981,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2877,6 +3099,9 @@

Method Details

"retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. + "A String", + ], "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.v1.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.v1.html new file mode 100644 index 0000000000..27df6f4232 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.v1.html @@ -0,0 +1,91 @@ + + + +

Agent Platform API . projects . locations . publishers . v1

+

Instance Methods

+

+ responses() +

+

Returns the responses 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.publishers.v1.responses.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.v1.responses.html new file mode 100644 index 0000000000..7bdff4eab3 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.v1.responses.html @@ -0,0 +1,128 @@ + + + +

Agent Platform API . projects . locations . publishers . v1 . responses

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ compact(endpoint, body=None, deployedModelId=None, x__xgafv=None)

+

Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ compact(endpoint, body=None, deployedModelId=None, x__xgafv=None) +
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # 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.
+    },
+  ],
+}
+
+  deployedModelId: string, ID of the DeployedModel that serves the invoke request.
+  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_v1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html index 58f1da2464..42a1ddc4ee 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html @@ -255,12 +255,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -272,6 +285,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -286,6 +300,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -398,6 +413,7 @@

Method Details

"spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -407,6 +423,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. @@ -645,12 +662,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -662,6 +692,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -676,6 +707,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -788,6 +820,7 @@

Method Details

"spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -797,6 +830,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. @@ -966,12 +1000,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -983,6 +1030,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -997,6 +1045,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1109,6 +1158,7 @@

Method Details

"spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -1118,6 +1168,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. @@ -1257,12 +1308,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1274,6 +1338,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1288,6 +1353,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1400,6 +1466,7 @@

Method Details

"spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -1409,6 +1476,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html index 13986f9825..dc17e6218d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html @@ -256,12 +256,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single piece of content from which to generate memories. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -273,6 +286,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -287,6 +301,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -463,12 +478,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -480,6 +508,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -494,6 +523,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html index 09c27cb5bf..4d2167766d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html @@ -146,7 +146,16 @@

Method Details

}, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. + "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into. + "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC. + { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC. + "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. + "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. + "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. + }, + ], "internetAccess": True or False, # Optional. Whether to allow internet access. + "networkAttachment": "A String", # Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress. }, "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. @@ -265,7 +274,16 @@

Method Details

}, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. + "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into. + "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC. + { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC. + "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. + "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. + "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. + }, + ], "internetAccess": True or False, # Optional. Whether to allow internet access. + "networkAttachment": "A String", # Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress. }, "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. @@ -327,7 +345,16 @@

Method Details

}, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. + "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into. + "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC. + { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC. + "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. + "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. + "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. + }, + ], "internetAccess": True or False, # Optional. Whether to allow internet access. + "networkAttachment": "A String", # Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress. }, "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. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html index 4b7583893c..38fbefcfc8 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html @@ -129,12 +129,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Content of the event provided by the author. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -146,6 +159,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -160,6 +174,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -282,6 +297,9 @@

Method Details

"retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. + "A String", + ], "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html index d15eebe04e..225daa75d5 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html @@ -137,12 +137,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Content of the event provided by the author. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -154,6 +167,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -168,6 +182,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -290,6 +305,9 @@

Method Details

"retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. + "A String", + ], "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. diff --git a/docs/dyn/aiplatform_v1.projects.locations.schedules.html b/docs/dyn/aiplatform_v1.projects.locations.schedules.html index d3bcc30f61..b0b5d40d5d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.schedules.html +++ b/docs/dyn/aiplatform_v1.projects.locations.schedules.html @@ -151,6 +151,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -190,6 +195,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, "notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob. @@ -484,6 +498,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -523,6 +542,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, "notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob. @@ -859,6 +887,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -898,6 +931,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, "notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob. @@ -1206,6 +1248,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -1245,6 +1292,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, "notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob. @@ -1557,6 +1613,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -1596,6 +1657,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, "notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob. @@ -1891,6 +1961,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -1930,6 +2005,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, "notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob. diff --git a/docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicyEngine.html b/docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicyEngine.html index 1b529e95d1..e8f6967f40 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicyEngine.html +++ b/docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicyEngine.html @@ -96,6 +96,7 @@

Method Details

The object takes the form of: { # Request message for SemanticGovernancePolicyEngineService.DeprovisionSemanticGovernancePolicyEngine. + "force": True or False, # Optional. If true, the operation bypass checks on current state and force the deprovisioning operation. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/aiplatform_v1.projects.locations.servingProfiles.html b/docs/dyn/aiplatform_v1.projects.locations.servingProfiles.html new file mode 100644 index 0000000000..fe2de40e3a --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.servingProfiles.html @@ -0,0 +1,91 @@ + + + +

Agent Platform API . projects . locations . servingProfiles

+

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.servingProfiles.operations.html b/docs/dyn/aiplatform_v1.projects.locations.servingProfiles.operations.html new file mode 100644 index 0000000000..b343e098c5 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.servingProfiles.operations.html @@ -0,0 +1,272 @@ + + + +

Agent Platform API . projects . locations . servingProfiles . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

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

+

Method Details

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

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -617,7 +617,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -1060,7 +1060,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -1475,7 +1475,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html index a1cb281c05..8971c2ae32 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -259,6 +259,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -406,6 +423,23 @@

Method Details

], "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -571,6 +605,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -728,6 +779,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -995,12 +1063,25 @@

Method Details

"completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1012,6 +1093,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1026,6 +1108,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1073,12 +1156,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1090,6 +1186,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1104,6 +1201,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1197,12 +1295,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1214,6 +1325,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1228,6 +1340,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1453,6 +1566,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1600,6 +1730,23 @@

Method Details

], "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1765,6 +1912,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1922,6 +2086,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2189,12 +2370,25 @@

Method Details

"completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2206,6 +2400,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2220,6 +2415,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2267,12 +2463,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2284,6 +2493,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2298,6 +2508,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2391,12 +2602,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2408,6 +2632,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2422,6 +2647,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2654,6 +2880,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2801,6 +3044,23 @@

Method Details

], "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2966,6 +3226,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3123,6 +3400,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3390,12 +3684,25 @@

Method Details

"completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3407,6 +3714,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3421,6 +3729,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3468,12 +3777,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3485,6 +3807,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3499,6 +3822,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3592,12 +3916,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3609,6 +3946,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3623,6 +3961,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3861,6 +4200,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4008,6 +4364,23 @@

Method Details

], "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4173,6 +4546,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4330,6 +4720,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4597,12 +5004,25 @@

Method Details

"completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4614,6 +5034,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -4628,6 +5049,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -4675,12 +5097,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4692,6 +5127,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -4706,6 +5142,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -4799,12 +5236,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4816,6 +5266,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -4830,6 +5281,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -5083,6 +5535,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5230,6 +5699,23 @@

Method Details

], "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5395,6 +5881,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5552,6 +6055,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5819,12 +6339,25 @@

Method Details

"completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -5836,6 +6369,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -5850,6 +6384,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -5897,12 +6432,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -5914,6 +6462,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -5928,6 +6477,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -6021,12 +6571,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6038,6 +6601,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -6052,6 +6616,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index a98662c0c5..89e857ae4b 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -121,12 +121,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -138,6 +151,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -152,6 +166,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -236,12 +251,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -253,6 +281,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -267,6 +296,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -310,6 +340,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -454,12 +501,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -471,6 +531,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -485,6 +546,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -637,6 +699,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -830,12 +898,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -847,6 +928,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -861,6 +943,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -904,6 +987,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1058,12 +1158,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1075,6 +1188,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1089,6 +1203,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1257,6 +1372,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1404,12 +1525,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1421,6 +1555,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1435,6 +1570,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1552,6 +1688,9 @@

Method Details

"retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. + "A String", + ], "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. @@ -2339,12 +2478,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2356,6 +2508,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2370,6 +2523,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2413,6 +2567,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2567,12 +2738,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2584,6 +2768,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2598,6 +2783,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2766,6 +2952,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2913,12 +3105,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2930,6 +3135,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2944,6 +3150,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3061,6 +3268,9 @@

Method Details

"retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. + "A String", + ], "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.html b/docs/dyn/aiplatform_v1.reasoningEngines.html index ebbc32290c..fc41500019 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.html @@ -245,12 +245,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -262,6 +275,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -276,6 +290,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -388,6 +403,7 @@

Method Details

"spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -397,6 +413,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. @@ -636,12 +653,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -653,6 +683,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -667,6 +698,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -779,6 +811,7 @@

Method Details

"spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -788,6 +821,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. @@ -922,12 +956,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -939,6 +986,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -953,6 +1001,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1065,6 +1114,7 @@

Method Details

"spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -1074,6 +1124,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. @@ -1213,12 +1264,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1230,6 +1294,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1244,6 +1309,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1356,6 +1422,7 @@

Method Details

"spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -1365,6 +1432,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html index 9d0a06baac..2d4affbb97 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html @@ -146,7 +146,16 @@

Method Details

}, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. + "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into. + "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC. + { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC. + "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. + "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. + "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. + }, + ], "internetAccess": True or False, # Optional. Whether to allow internet access. + "networkAttachment": "A String", # Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress. }, "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. @@ -265,7 +274,16 @@

Method Details

}, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. + "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into. + "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC. + { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC. + "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. + "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. + "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. + }, + ], "internetAccess": True or False, # Optional. Whether to allow internet access. + "networkAttachment": "A String", # Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress. }, "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. @@ -327,7 +345,16 @@

Method Details

}, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. + "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into. + "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC. + { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC. + "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. + "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. + "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. + }, + ], "internetAccess": True or False, # Optional. Whether to allow internet access. + "networkAttachment": "A String", # Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress. }, "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. diff --git a/docs/dyn/aiplatform_v1.servingProfiles.html b/docs/dyn/aiplatform_v1.servingProfiles.html new file mode 100644 index 0000000000..4f2de9174f --- /dev/null +++ b/docs/dyn/aiplatform_v1.servingProfiles.html @@ -0,0 +1,91 @@ + + + +

Agent Platform API . servingProfiles

+

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.servingProfiles.operations.html b/docs/dyn/aiplatform_v1.servingProfiles.operations.html new file mode 100644 index 0000000000..8e1117122c --- /dev/null +++ b/docs/dyn/aiplatform_v1.servingProfiles.operations.html @@ -0,0 +1,272 @@ + + + +

Agent Platform API . servingProfiles . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

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

+

Method Details

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

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -284,6 +301,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -441,6 +475,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -680,6 +731,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -898,12 +966,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -915,6 +996,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -929,6 +1011,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1089,6 +1172,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1217,12 +1306,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1234,6 +1336,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1248,6 +1351,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1408,6 +1512,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1532,12 +1642,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1549,6 +1672,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1563,6 +1687,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1612,12 +1737,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1629,6 +1767,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -1643,6 +1782,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -1798,6 +1938,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2030,6 +2176,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2148,12 +2300,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2165,6 +2330,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2179,6 +2345,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2238,12 +2405,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2255,6 +2435,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2269,6 +2450,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2321,12 +2503,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2338,6 +2533,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2352,6 +2548,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2402,12 +2599,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2419,6 +2629,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2433,6 +2644,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2483,12 +2695,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2500,6 +2725,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -2514,6 +2740,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -2607,6 +2834,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2764,6 +3008,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2983,6 +3244,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3140,6 +3418,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3350,12 +3645,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3367,6 +3675,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3381,6 +3690,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -3472,12 +3782,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3489,6 +3812,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -3503,6 +3827,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -4109,12 +4434,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4126,6 +4464,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -4140,6 +4479,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -4300,6 +4640,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -4421,12 +4767,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4438,6 +4797,7 @@

Method Details

"args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. @@ -4452,6 +4812,7 @@

Method Details

"willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. @@ -4507,6 +4868,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. diff --git a/docs/dyn/aiplatform_v1beta1.batchPredictionJobs.html b/docs/dyn/aiplatform_v1beta1.batchPredictionJobs.html index 93d2e5d6c1..39c22a45c4 100644 --- a/docs/dyn/aiplatform_v1beta1.batchPredictionJobs.html +++ b/docs/dyn/aiplatform_v1beta1.batchPredictionJobs.html @@ -141,6 +141,7 @@

Method Details

"kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. }, "endTime": "A String", # Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. + "endpoint": "A String", # For Bring-Your-Own-Endpoint (BYOE), the name of the Endpoint resource that produces the predictions via this job, must share the same ancestor Location. Exactly one of model, unmanaged_container_model, or endpoint must be set. Example: `projects/193595526740/locations/us-central1/endpoints/4203439000301600768` "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. @@ -647,6 +648,7 @@

Method Details

"kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. }, "endTime": "A String", # Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. + "endpoint": "A String", # For Bring-Your-Own-Endpoint (BYOE), the name of the Endpoint resource that produces the predictions via this job, must share the same ancestor Location. Exactly one of model, unmanaged_container_model, or endpoint must be set. Example: `projects/193595526740/locations/us-central1/endpoints/4203439000301600768` "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. @@ -1159,6 +1161,7 @@

Method Details

"kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. }, "endTime": "A String", # Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. + "endpoint": "A String", # For Bring-Your-Own-Endpoint (BYOE), the name of the Endpoint resource that produces the predictions via this job, must share the same ancestor Location. Exactly one of model, unmanaged_container_model, or endpoint must be set. Example: `projects/193595526740/locations/us-central1/endpoints/4203439000301600768` "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. @@ -1677,6 +1680,7 @@

Method Details

"kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. }, "endTime": "A String", # Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. + "endpoint": "A String", # For Bring-Your-Own-Endpoint (BYOE), the name of the Endpoint resource that produces the predictions via this job, must share the same ancestor Location. Exactly one of model, unmanaged_container_model, or endpoint must be set. Example: `projects/193595526740/locations/us-central1/endpoints/4203439000301600768` "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index f79766bb44..aa969f9bf7 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -128,12 +128,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -245,12 +258,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -321,6 +347,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -468,12 +511,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -653,6 +709,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -853,12 +915,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -929,6 +1004,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1086,12 +1178,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1287,6 +1392,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1441,12 +1552,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1808,12 +1932,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1884,6 +2021,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2041,12 +2195,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2242,6 +2409,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2396,12 +2569,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/docs/dyn/aiplatform_v1beta1.interactions.html b/docs/dyn/aiplatform_v1beta1.interactions.html index afba08120f..5447cb5650 100644 --- a/docs/dyn/aiplatform_v1beta1.interactions.html +++ b/docs/dyn/aiplatform_v1beta1.interactions.html @@ -104,6 +104,38 @@

Method Details

{ # Response for InteractionService.CreateInteraction. "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. "agent": "A String", # The name of the `Agent` used for generating the completion. + "antigravityConfig": { # Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration. # Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis. + "maxTotalTokens": "A String", # Max total tokens for the agent run. + "model": "A String", # The model to use for agent reasoning. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "find_request": { # Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase. # Parameters for finding vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the vulnerability analysis. + "finding_id": "A String", # The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability. + "mode": "A String", # The mode of the find session. + "source_files": [ # A list of source files to provide as context for the scan. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "fix_request": { # Request parameters specific to FIX sessions, used for generating and validating security patches. # Parameters for fixing vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the patch generation process. + "finding_id": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "source_files": [ # A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. + "session_config": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "max_rounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "session_id": "A String", # Parameter for grouping multiple interactions that belong to the same CodeMender session. + }, "deepResearchConfig": { # Configuration for the Deep Research agent. "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. @@ -165,6 +197,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -208,6 +246,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -309,6 +353,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -389,6 +439,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -482,6 +538,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -525,6 +587,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -626,6 +694,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -706,6 +780,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -786,6 +866,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -829,6 +915,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -930,6 +1022,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1010,6 +1108,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1046,16 +1150,18 @@

Method Details

"envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "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", + }, + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. }, "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. "seed": 42, # Seed used in decoding for reproducibility. "speechConfig": [ # Configuration for speech interaction. { # The configuration for speech interaction. @@ -1080,6 +1186,21 @@

Method Details

}, "toolChoiceMode": "A String", # The mode of the tool choice. "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "transcriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for speech recognition (transcription). If present, ASR is enabled. + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageHints": [ # Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to ["auto"] to enable automatic language detection. + "A String", + ], + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, "videoConfig": { # Configuration options for video generation. # Configuration for video generation. "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. }, @@ -1135,333 +1256,11 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], @@ -1506,6 +1305,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1607,6 +1412,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1687,6 +1498,365 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "environmentId": "A String", # Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1796,6 +1966,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1839,6 +2015,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1940,6 +2122,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2020,6 +2208,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2119,6 +2313,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2162,6 +2362,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2263,6 +2469,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2343,6 +2555,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2463,6 +2681,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2506,6 +2730,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2607,6 +2837,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2687,6 +2923,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2786,6 +3028,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2829,6 +3077,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2930,6 +3184,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3010,6 +3270,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3066,6 +3332,13 @@

Method Details

"A String", ], "role": "A String", # Output only. The role of the interaction. + "safety_settings": [ # Safety settings for the interaction. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. + "type": "A String", # Required. The type of harm category to be blocked. + }, + ], "status": "A String", # Required. Output only. The status of the interaction. "stepList": { # A list of Steps. # Input only. The steps for the interaction. "steps": [ # The steps of the list. @@ -3120,321 +3393,11 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], @@ -3479,6 +3442,352 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3580,6 +3889,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3660,6 +3975,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3756,6 +4077,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3799,6 +4126,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3900,6 +4233,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3980,6 +4319,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -4096,6 +4441,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -4139,6 +4490,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -4240,6 +4597,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -4320,6 +4683,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -4366,6 +4735,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -4384,334 +4761,72 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -4747,167 +4862,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -4919,100 +5050,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -5045,334 +5132,426 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -5408,382 +5587,15 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": "A String", # Required. The text content. }, }, ], @@ -5882,6 +5694,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -5962,6 +5780,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6051,6 +5875,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6094,6 +5924,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6195,6 +6031,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6275,6 +6117,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6367,6 +6215,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6410,6 +6264,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6511,6 +6371,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6591,6 +6457,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6687,6 +6559,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6730,6 +6608,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6831,6 +6715,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6911,6 +6801,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -7027,6 +6923,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -7070,6 +6972,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -7171,6 +7079,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -7251,6 +7165,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -7297,6 +7217,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -7315,334 +7243,72 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -7678,167 +7344,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -7850,100 +7532,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -7976,334 +7614,71 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -8339,167 +7714,97 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -8511,101 +7816,147 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "serverName": "A String", # The name of the used MCP server. + }, + "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. }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result step. @@ -8669,6 +8020,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -8712,6 +8069,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -8813,6 +8176,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -8893,6 +8262,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9005,6 +8380,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9048,6 +8429,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9149,6 +8536,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9229,6 +8622,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9403,6 +8802,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9446,6 +8851,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9547,6 +8958,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9627,6 +9044,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9731,6 +9154,38 @@

Method Details

{ # Response for InteractionService.CreateInteraction. "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. "agent": "A String", # The name of the `Agent` used for generating the completion. + "antigravityConfig": { # Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration. # Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis. + "maxTotalTokens": "A String", # Max total tokens for the agent run. + "model": "A String", # The model to use for agent reasoning. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "find_request": { # Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase. # Parameters for finding vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the vulnerability analysis. + "finding_id": "A String", # The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability. + "mode": "A String", # The mode of the find session. + "source_files": [ # A list of source files to provide as context for the scan. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "fix_request": { # Request parameters specific to FIX sessions, used for generating and validating security patches. # Parameters for fixing vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the patch generation process. + "finding_id": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "source_files": [ # A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. + "session_config": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "max_rounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "session_id": "A String", # Parameter for grouping multiple interactions that belong to the same CodeMender session. + }, "deepResearchConfig": { # Configuration for the Deep Research agent. "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. @@ -9792,6 +9247,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9835,6 +9296,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9936,6 +9403,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10016,6 +9489,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10109,6 +9588,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10152,6 +9637,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10253,6 +9744,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10333,6 +9830,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10413,6 +9916,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10456,6 +9965,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10557,6 +10072,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10637,6 +10158,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10673,16 +10200,18 @@

Method Details

"envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "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", + }, + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. }, "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. "seed": 42, # Seed used in decoding for reproducibility. "speechConfig": [ # Configuration for speech interaction. { # The configuration for speech interaction. @@ -10707,6 +10236,21 @@

Method Details

}, "toolChoiceMode": "A String", # The mode of the tool choice. "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "transcriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for speech recognition (transcription). If present, ASR is enabled. + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageHints": [ # Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to ["auto"] to enable automatic language detection. + "A String", + ], + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, "videoConfig": { # Configuration options for video generation. # Configuration for video generation. "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. }, @@ -10762,6 +10306,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10805,6 +10355,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10906,6 +10462,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10986,6 +10548,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11019,6 +10587,7 @@

Method Details

], "previousInteractionId": "A String", # The ID of the previous interaction, if any. "remoteEnvironment": { # Configuration for a custom environment. + "environmentId": "A String", # Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one. "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. "allowlist": [ # List of allowed domains and their configurations. { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. @@ -11090,6 +10659,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11133,6 +10708,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11234,6 +10815,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11314,6 +10901,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11423,6 +11016,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11466,6 +11065,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11567,6 +11172,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11647,6 +11258,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11746,6 +11363,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11789,6 +11412,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11890,6 +11519,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11970,6 +11605,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12090,6 +11731,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12133,6 +11780,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12234,6 +11887,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12314,6 +11973,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12413,6 +12078,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12456,6 +12127,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12557,6 +12234,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12637,6 +12320,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12693,6 +12382,13 @@

Method Details

"A String", ], "role": "A String", # Output only. The role of the interaction. + "safety_settings": [ # Safety settings for the interaction. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. + "type": "A String", # Required. The type of harm category to be blocked. + }, + ], "status": "A String", # Required. Output only. The status of the interaction. "stepList": { # A list of Steps. # Input only. The steps for the interaction. "steps": [ # The steps of the list. @@ -12747,321 +12443,11 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], @@ -13106,6 +12492,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13207,6 +12599,352 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13287,6 +13025,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13383,6 +13127,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13426,6 +13176,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13527,6 +13283,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13607,6 +13369,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13723,6 +13491,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13766,6 +13540,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13867,6 +13647,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13947,6 +13733,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13993,6 +13785,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -14011,334 +13811,72 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -14374,167 +13912,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -14546,100 +14100,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -14672,334 +14182,426 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -15035,382 +14637,15 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": "A String", # Required. The text content. }, }, ], @@ -15509,6 +14744,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -15589,6 +14830,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -15678,6 +14925,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -15721,6 +14974,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -15822,6 +15081,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -15902,6 +15167,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -15994,6 +15265,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16037,6 +15314,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16138,6 +15421,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16218,6 +15507,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16314,6 +15609,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16357,6 +15658,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16458,6 +15765,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16538,6 +15851,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16654,6 +15973,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16697,6 +16022,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16798,6 +16129,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16878,6 +16215,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16924,6 +16267,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -16942,334 +16293,72 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -17305,167 +16394,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -17477,100 +16582,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -17603,334 +16664,71 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -17966,167 +16764,97 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -18138,101 +16866,147 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "serverName": "A String", # The name of the used MCP server. + }, + "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. }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result step. @@ -18296,6 +17070,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18339,6 +17119,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18440,6 +17226,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18520,6 +17312,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18632,6 +17430,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18675,6 +17479,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18776,6 +17586,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18856,6 +17672,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19030,6 +17852,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19073,6 +17901,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19174,6 +18008,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19254,6 +18094,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19351,7 +18197,7 @@

Method Details

An object of the form: { - "contentDelta": { # The content block delta data, used for content.delta events. + "contentDelta": { # The content block delta data, used for content.delta events. Legacy content-based streaming event, used when steps are disabled. "delta": { # The delta content data for a content block. "audio": { "channels": 42, # The number of audio channels. @@ -19404,6 +18250,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], }, @@ -19459,6 +18311,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19502,6 +18360,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19603,6 +18467,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19683,6 +18553,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19778,6 +18654,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19821,6 +18703,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19922,6 +18810,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20002,6 +18896,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20117,6 +19017,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20160,6 +19066,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20261,6 +19173,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20341,6 +19259,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20409,217 +19333,91 @@

Method Details

], }, "functionResult": { - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "isError": True or False, + "name": "A String", + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -20631,112 +19429,346 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + }, + "googleMapsResult": { + "result": [ # The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { "isError": True or False, + "result": [ + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { "name": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -20772,167 +19804,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -20944,147 +19992,249 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { - "result": [ # The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "serverName": "A String", }, - "googleSearchResult": { + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { "isError": True or False, "result": [ - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "mcpServerToolResult": { - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + }, + "video": { + "data": "A String", + "mimeType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", + }, + }, + "index": 42, + }, + "contentStart": { # The content block start data, used for content.start events. Legacy content-based streaming event, used when steps are disabled. + "content": { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -21120,266 +20270,184 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "url": "A String", # URI reference of the place. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "name": "A String", - "serverName": "A String", + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "index": 42, + }, + "contentStop": { # The content block stop data, used for content.stop events. Legacy content-based streaming event, used when steps are disabled. + "index": 42, + }, + "errorEvent": { # The error event data, used for error events. + "error": { # Error message from an interaction. + "code": "A String", # A URI that identifies the error type. + "message": "A String", # A human-readable error message. + }, + }, + "eventId": "A String", # The event_id token to be used to resume the interaction stream, from this event. + "interactionCompleteEvent": { # The interaction data, used for interaction.complete events. Legacy event, used when steps are disabled. + "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "antigravityConfig": { # Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration. # Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis. + "maxTotalTokens": "A String", # Max total tokens for the agent run. + "model": "A String", # The model to use for agent reasoning. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "find_request": { # Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase. # Parameters for finding vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the vulnerability analysis. + "finding_id": "A String", # The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability. + "mode": "A String", # The mode of the find session. + "source_files": [ # A list of source files to provide as context for the scan. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "fix_request": { # Request parameters specific to FIX sessions, used for generating and validating security patches. # Parameters for fixing vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the patch generation process. + "finding_id": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "source_files": [ # A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. + "session_config": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "max_rounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "session_id": "A String", # Parameter for grouping multiple interactions that belong to the same CodeMender session. + }, + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -21433,6 +20501,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21476,6 +20550,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21577,6 +20657,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21657,6 +20743,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21701,83 +20793,348 @@

Method Details

], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { - "isError": True or False, - "result": [ - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + }, + "content": { # The content of the response. # The content for the interaction. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - }, - "video": { - "data": "A String", - "mimeType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", - }, - }, - "index": 42, - }, - "contentStart": { # The content block start data, used for content.start events. - "content": { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -21813,171 +21170,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -21989,83 +21360,327 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "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", }, - }, - "index": 42, - }, - "contentStop": { # The content block stop data, used for content.stop events. - "index": 42, - }, - "errorEvent": { # The error event data, used for error events. - "error": { # Error message from an interaction. - "code": "A String", # A URI that identifies the error type. - "message": "A String", # A human-readable error message. - }, - }, - "eventId": "A String", # The event_id token to be used to resume the interaction stream, from this event. - "interactionCompleteEvent": { # The interaction data, used for interaction.complete events. - "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. + }, + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "transcriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for speech recognition (transcription). If present, ASR is enabled. + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageHints": [ # Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to ["auto"] to enable automatic language detection. + "A String", + ], + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -22101,350 +21716,382 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "environmentId": "A String", # Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + "text": "A String", # Required. The text content. }, }, ], }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -22456,381 +22103,138 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -22866,856 +22270,900 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - "videoConfig": { # Configuration options for video generation. # Configuration for video generation. - "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. - }, - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "text": "A String", # Required. The text content. }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + ], }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - "text": "A String", # Required. The text content. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", }, ], }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -23727,18 +23175,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -23775,6 +23227,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -23782,117 +23240,131 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -23904,141 +23376,141 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "fileSearchCall": { # File Search content. }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -24050,18 +23522,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -24098,6 +23574,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -24105,253 +23587,69 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. - }, + ], }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + }, + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "safety_settings": [ # Safety settings for the interaction. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. + "type": "A String", # Required. The type of harm category to be blocked. + }, + ], + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -24399,6 +23697,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -24442,6 +23746,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -24543,6 +23853,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -24623,6 +23939,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -24653,455 +23975,126 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": "A String", # Required. The text content. }, }, ], @@ -25200,6 +24193,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25280,6 +24279,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25311,442 +24316,138 @@

Method Details

}, }, ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, "fileSearchCall": { # File Search content. @@ -25836,6 +24537,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25916,6 +24623,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -26032,6 +24745,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -26075,6 +24794,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -26176,6 +24901,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -26256,6 +24987,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -26302,6 +25039,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -26320,217 +25065,91 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "searchType": "A String", # The type of search grounding enabled. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -26542,112 +25161,346 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + ], + "url": "A String", + }, + ], + "widgetContextToken": "A String", + }, + ], + }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -26683,167 +25536,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -26855,460 +25724,138 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "widgetContextToken": "A String", }, - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "serverName": "A String", # The name of the used MCP server. }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -27344,510 +25891,149 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], }, @@ -27898,6 +26084,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -27987,6 +26179,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28030,6 +26228,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28131,6 +26335,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28211,6 +26421,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28303,6 +26519,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28346,6 +26568,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28447,6 +26675,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28527,6 +26761,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28623,6 +26863,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28666,6 +26912,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28767,6 +27019,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28847,6 +27105,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28963,6 +27227,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29006,6 +27276,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29107,6 +27383,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29187,6 +27469,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29233,6 +27521,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -29251,334 +27547,72 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -29614,167 +27648,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -29786,100 +27836,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -29912,334 +27918,426 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -30275,382 +28373,15 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": "A String", # Required. The text content. }, }, ], @@ -30749,6 +28480,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -30829,6 +28566,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -30941,6 +28684,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -30984,6 +28733,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31085,6 +28840,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31165,6 +28926,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31339,6 +29106,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31382,6 +29155,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31483,6 +29262,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31563,6 +29348,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31641,10 +29432,42 @@

Method Details

}, }, }, - "interactionCompletedEvent": { # The interaction data, used for interaction.completed events. + "interactionCompletedEvent": { # The interaction data, used for interaction.completed events. Used when steps are enabled. "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. "agent": "A String", # The name of the `Agent` used for generating the completion. + "antigravityConfig": { # Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration. # Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis. + "maxTotalTokens": "A String", # Max total tokens for the agent run. + "model": "A String", # The model to use for agent reasoning. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "find_request": { # Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase. # Parameters for finding vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the vulnerability analysis. + "finding_id": "A String", # The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability. + "mode": "A String", # The mode of the find session. + "source_files": [ # A list of source files to provide as context for the scan. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "fix_request": { # Request parameters specific to FIX sessions, used for generating and validating security patches. # Parameters for fixing vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the patch generation process. + "finding_id": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "source_files": [ # A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. + "session_config": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "max_rounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "session_id": "A String", # Parameter for grouping multiple interactions that belong to the same CodeMender session. + }, "deepResearchConfig": { # Configuration for the Deep Research agent. "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. @@ -31706,6 +29529,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31749,6 +29578,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31850,6 +29685,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31930,6 +29771,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -32023,6 +29870,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -32066,6 +29919,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -32167,6 +30026,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -32247,6 +30112,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -32327,6 +30198,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -32370,6 +30247,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -32471,6 +30354,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -32551,6 +30440,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -32587,16 +30482,18 @@

Method Details

"envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "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", + }, + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. }, "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. "seed": 42, # Seed used in decoding for reproducibility. "speechConfig": [ # Configuration for speech interaction. { # The configuration for speech interaction. @@ -32621,6 +30518,21 @@

Method Details

}, "toolChoiceMode": "A String", # The mode of the tool choice. "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "transcriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for speech recognition (transcription). If present, ASR is enabled. + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageHints": [ # Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to ["auto"] to enable automatic language detection. + "A String", + ], + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, "videoConfig": { # Configuration options for video generation. # Configuration for video generation. "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. }, @@ -32676,333 +30588,11 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], @@ -33047,6 +30637,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -33148,6 +30744,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -33228,6 +30830,365 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "environmentId": "A String", # Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -33337,6 +31298,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -33380,6 +31347,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -33481,6 +31454,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -33561,6 +31540,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -33660,6 +31645,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -33703,6 +31694,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -33804,6 +31801,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -33884,6 +31887,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -34004,6 +32013,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -34047,6 +32062,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -34148,6 +32169,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -34228,6 +32255,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -34327,6 +32360,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -34370,6 +32409,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -34471,6 +32516,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -34551,6 +32602,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -34607,6 +32664,13 @@

Method Details

"A String", ], "role": "A String", # Output only. The role of the interaction. + "safety_settings": [ # Safety settings for the interaction. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. + "type": "A String", # Required. The type of harm category to be blocked. + }, + ], "status": "A String", # Required. Output only. The status of the interaction. "stepList": { # A list of Steps. # Input only. The steps for the interaction. "steps": [ # The steps of the list. @@ -34661,321 +32725,11 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], @@ -35020,6 +32774,352 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -35121,6 +33221,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -35201,6 +33307,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -35297,6 +33409,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -35340,6 +33458,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -35441,6 +33565,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -35521,6 +33651,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -35637,6 +33773,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -35680,6 +33822,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -35781,6 +33929,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -35861,6 +34015,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -35907,6 +34067,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -35925,334 +34093,72 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -36288,167 +34194,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -36460,100 +34382,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -36586,334 +34464,426 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -36949,382 +34919,15 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": "A String", # Required. The text content. }, }, ], @@ -37423,6 +35026,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -37503,6 +35112,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -37592,6 +35207,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -37635,6 +35256,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -37736,6 +35363,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -37816,6 +35449,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -37908,6 +35547,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -37951,6 +35596,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -38052,6 +35703,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -38132,6 +35789,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -38228,6 +35891,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -38271,6 +35940,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -38372,6 +36047,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -38452,6 +36133,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -38568,6 +36255,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -38611,6 +36304,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -38712,6 +36411,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -38792,6 +36497,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -38838,6 +36549,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -38856,334 +36575,72 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -39219,167 +36676,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -39391,100 +36864,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -39517,334 +36946,71 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -39880,167 +37046,97 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -40052,101 +37148,147 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "serverName": "A String", # The name of the used MCP server. + }, + "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. }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result step. @@ -40210,6 +37352,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -40253,6 +37401,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -40354,6 +37508,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -40434,6 +37594,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -40546,6 +37712,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -40589,6 +37761,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -40690,6 +37868,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -40770,6 +37954,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -40944,6 +38134,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -40987,6 +38183,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41088,6 +38290,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41168,6 +38376,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41246,10 +38460,42 @@

Method Details

}, }, }, - "interactionCreatedEvent": { # The interaction data, used for interaction.created events. + "interactionCreatedEvent": { # The interaction data, used for interaction.created events. Used when steps are enabled. "interaction": { # Response for InteractionService.CreateInteraction. "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. "agent": "A String", # The name of the `Agent` used for generating the completion. + "antigravityConfig": { # Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration. # Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis. + "maxTotalTokens": "A String", # Max total tokens for the agent run. + "model": "A String", # The model to use for agent reasoning. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "find_request": { # Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase. # Parameters for finding vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the vulnerability analysis. + "finding_id": "A String", # The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability. + "mode": "A String", # The mode of the find session. + "source_files": [ # A list of source files to provide as context for the scan. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "fix_request": { # Request parameters specific to FIX sessions, used for generating and validating security patches. # Parameters for fixing vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the patch generation process. + "finding_id": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "source_files": [ # A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. + "session_config": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "max_rounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "session_id": "A String", # Parameter for grouping multiple interactions that belong to the same CodeMender session. + }, "deepResearchConfig": { # Configuration for the Deep Research agent. "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. @@ -41311,6 +38557,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41354,6 +38606,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41455,6 +38713,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41535,6 +38799,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41628,6 +38898,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41671,6 +38947,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41772,6 +39054,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41852,6 +39140,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41932,6 +39226,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41975,6 +39275,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -42076,6 +39382,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -42156,6 +39468,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -42192,16 +39510,18 @@

Method Details

"envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "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", + }, + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. }, "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. "seed": 42, # Seed used in decoding for reproducibility. "speechConfig": [ # Configuration for speech interaction. { # The configuration for speech interaction. @@ -42226,6 +39546,21 @@

Method Details

}, "toolChoiceMode": "A String", # The mode of the tool choice. "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "transcriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for speech recognition (transcription). If present, ASR is enabled. + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageHints": [ # Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to ["auto"] to enable automatic language detection. + "A String", + ], + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, "videoConfig": { # Configuration options for video generation. # Configuration for video generation. "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. }, @@ -42281,6 +39616,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -42324,6 +39665,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -42371,3829 +39718,567 @@

Method Details

"urls": [ # The URLs to fetch. "A String", ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. - }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, + ], + "url": "A String", # URI reference of the place. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "environmentId": "A String", # Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", + "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -46241,6 +40326,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -46284,6 +40375,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -46385,6 +40482,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -46450,548 +40553,139 @@

Method Details

}, "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -47028,6 +40722,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -47035,195 +40735,491 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "fileSearchCall": { # File Search content. }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -47235,129 +41231,147 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -47369,22 +41383,24 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -47421,6 +41437,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -47428,118 +41450,488 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "safety_settings": [ # Safety settings for the interaction. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. + "type": "A String", # Required. The type of harm category to be blocked. + }, + ], + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -47551,157 +41943,465 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -47737,469 +42437,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - ], - "text": "A String", # Required. The text content. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -48211,314 +42627,145 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool to call. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -48554,577 +42801,331 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], - "text": "A String", # Required. The text content. }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, + "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. + "A String", ], - "widgetContextToken": "A String", }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "retrievalType": "A String", # The type of retrieval tools. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - ], + }, }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -49172,6 +43173,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -49215,6 +43222,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -49316,6 +43329,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -49345,153 +43364,305 @@

Method Details

"url": "A String", # URI reference of the place. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", + }, + ], + "widgetContextToken": "A String", + }, + ], + }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + "fileSearchCall": { # File Search content. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -49528,6 +43699,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -49535,313 +43712,16 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -49853,257 +43733,461 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "serverName": "A String", # The name of the used MCP server. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. - "A String", - ], - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -50151,6 +44235,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -50194,6 +44284,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -50295,6 +44391,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -50375,6 +44477,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -50405,158 +44513,377 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "top_k": 42, # Optional. The number of contexts to retrieve. - }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", - ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. - }, - }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "fileSearchCall": { # File Search content. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -50592,171 +44919,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -50768,262 +45109,193 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - }, - "interactionStartEvent": { # The interaction data, used for interaction.start events. - "interaction": { # Response for InteractionService.CreateInteraction. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. - }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -51060,6 +45332,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -51067,281 +45345,281 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - }, - ], + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "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. + "A String", ], - "text": "A String", # Required. The text content. }, + "retrievalType": "A String", # The type of retrieval tools. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "fileSearchResult": { # File Search result step. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -51377,174 +45655,341 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + }, + ], }, - ], - "text": "A String", # Required. The text content. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", + }, + ], + "widgetContextToken": "A String", + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + "mcpServerToolResult": { # MCPServer tool result step. + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -51580,171 +46025,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -51754,474 +46213,498 @@

Method Details

"url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "serverName": "A String", # The name of the used MCP server. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. + "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. }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - "videoConfig": { # Configuration options for video generation. # Configuration for video generation. - "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. - }, - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "contentString": "A String", # The content of the step. A single string. }, }, ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", + ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -52257,91 +46740,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -52353,184 +46930,417 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", + }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. }, - ], + }, + "top_k": 42, # Optional. The number of contexts to retrieve. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -52542,18 +47352,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -52590,6 +47404,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -52597,117 +47417,207 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + }, + "interactionStartEvent": { # The interaction data, used for interaction.start events. Legacy event, used when steps are disabled. + "interaction": { # Response for InteractionService.CreateInteraction. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "antigravityConfig": { # Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration. # Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis. + "maxTotalTokens": "A String", # Max total tokens for the agent run. + "model": "A String", # The model to use for agent reasoning. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "find_request": { # Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase. # Parameters for finding vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the vulnerability analysis. + "finding_id": "A String", # The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability. + "mode": "A String", # The mode of the find session. + "source_files": [ # A list of source files to provide as context for the scan. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "fix_request": { # Request parameters specific to FIX sessions, used for generating and validating security patches. # Parameters for fixing vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the patch generation process. + "finding_id": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "source_files": [ # A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. + "session_config": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "max_rounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "session_id": "A String", # Parameter for grouping multiple interactions that belong to the same CodeMender session. + }, + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -52719,141 +47629,141 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "fileSearchCall": { # File Search content. }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -52865,18 +47775,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -52913,6 +47827,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -52920,265 +47840,299 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + }, + "content": { # The content of the response. # The content for the interaction. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, + ], + "url": "A String", # URI reference of the place. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. - }, + ], }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -53214,167 +48168,232 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -53386,968 +48405,939 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "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", + }, + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. + }, + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "transcriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for speech recognition (transcription). If present, ASR is enabled. + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageHints": [ # Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to ["auto"] to enable automatic language detection. + "A String", + ], + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "url": "A String", # URI reference of the place. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, + }, + ], + "text": "A String", # Required. The text content. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "environmentId": "A String", # Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "a_key": "", # Properties of the object. Contains field @type with type URL. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -54359,22 +49349,24 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -54411,6 +49403,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -54418,419 +49416,123 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "fileSearchCall": { # File Search content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -54842,18 +49544,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -54890,6 +49596,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -54897,117 +49609,131 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -55019,179 +49745,450 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + }, + ], }, }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -55228,6 +50225,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -55235,234 +50238,198 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - "text": "A String", # Required. The text content. + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + "text": "A String", # Required. The text content. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -55498,167 +50465,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -55670,166 +50653,653 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "safety_settings": [ # Safety settings for the interaction. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. + "type": "A String", # Required. The type of harm category to be blocked. + }, + ], + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", }, ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -55841,18 +51311,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -55889,6 +51363,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -55896,216 +51376,42 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], }, - ], + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -56159,6 +51465,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -56202,6 +51514,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -56303,6 +51621,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -56383,6 +51707,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -56426,491 +51756,44 @@

Method Details

}, ], }, + "name": "A String", # Required. The name of the tool to call. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -56946,286 +51829,391 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, }, - ], - "text": "A String", # Required. The text content. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -57262,6 +52250,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -57269,16 +52263,298 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", + }, + ], + "widgetContextToken": "A String", + }, + ], + }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -57290,22 +52566,24 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -57334,94 +52612,144 @@

Method Details

"title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -57433,18 +52761,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -57481,6 +52813,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -57488,280 +52826,285 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "serverName": "A String", # The name of the used MCP server. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "fileSearchCall": { # File Search content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -57773,18 +53116,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -57821,6 +53168,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -57828,278 +53181,267 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -58111,18 +53453,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -58159,6 +53505,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -58166,216 +53518,382 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], + "text": "A String", # Required. The text content. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - "text": "A String", # Required. The text content. + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -58429,6 +53947,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -58472,6 +53996,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -58573,6 +54103,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -58648,395 +54184,80 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -59090,6 +54311,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -59133,6 +54360,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -59234,6 +54467,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -59314,6 +54553,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -59357,22 +54602,40 @@

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. + }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. }, "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -59420,6 +54683,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -59463,6 +54732,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -59564,6 +54839,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -59644,6 +54925,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -59674,437 +54961,404 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. - "A String", - ], - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. - }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", }, ], + "widgetContextToken": "A String", }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + ], + }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", - }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, + "serverName": "A String", # The name of the used MCP server. }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, + "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. }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "top_k": 42, # Optional. The number of contexts to retrieve. - }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. "contents": [ # The contents of the list. { # The content of the response. "audio": { # An audio content block. @@ -60154,6 +55408,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -60197,6 +55457,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -60298,6 +55564,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -60378,6 +55650,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -60410,192 +55688,265 @@

Method Details

}, ], }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. + "contentString": "A String", # The content of the step. A single string. }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - }, - "interactionStatusUpdate": { # The interaction status data, used for interaction.status_update events. - "interactionId": "A String", - "status": "A String", - }, - "metadata": { # Optional metadata accompanying ANY streamed event. - "totalUsage": { # Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. }, ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - "stepDelta": { # The step delta data, used for step.delta events. - "delta": { - "argumentsDelta": { - "arguments": "A String", - }, - "audio": { - "channels": 42, # The number of audio channels. - "data": "A String", - "mimeType": "A String", - "rate": 42, # Deprecated. Use sample_rate instead. The value is ignored. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", - }, - "document": { - "data": "A String", - "mimeType": "A String", - "uri": "A String", - }, - "functionResult": { - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. + }, + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], + }, + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", + ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. + }, + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -60607,234 +55958,191 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", + }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + ], + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. + }, }, + "top_k": 42, # Optional. The number of contexts to retrieve. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - ], + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", + ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. + }, + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. + }, }, - "isError": True or False, - "name": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -60882,6 +56190,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -60925,6 +56239,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -61026,6 +56346,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -61106,6 +56432,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -61136,481 +56468,289 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "image": { - "data": "A String", - "mimeType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], }, - "serverToolCall": { - "codeExecutionCall": { - "arguments": { # The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + }, + "interactionStatusUpdate": { # The interaction status data, used for interaction.status_update events. + "interactionId": "A String", + "status": "A String", + }, + "metadata": { # Optional metadata accompanying ANY streamed event. + "totalUsage": { # Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. }, - "fileSearchCall": { + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. }, - "googleMapsCall": { - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. }, - "googleSearchCall": { - "arguments": { # The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. }, - "mcpServerToolCall": { - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + "stepDelta": { # The step delta data, used for step.delta events. Step-based streaming event, used when steps are enabled. + "delta": { + "argumentsDelta": { + "arguments": "A String", + }, + "audio": { + "channels": 42, # The number of audio channels. + "data": "A String", + "mimeType": "A String", + "rate": 42, # Deprecated. Use sample_rate instead. The value is ignored. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", + }, + "document": { + "data": "A String", + "mimeType": "A String", + "uri": "A String", + }, + "functionResult": { + "isError": True or False, + "name": "A String", + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", - "serverName": "A String", - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { - "arguments": { # The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "serverToolResult": { - "codeExecutionResult": { - "isError": True or False, - "result": "A String", - }, - "fileSearchResult": { - "result": [ - { # The result of the File Search. - }, - ], - }, - "googleMapsResult": { - "result": [ # The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { - "isError": True or False, - "result": [ - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -61647,6 +56787,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -61654,216 +56800,157 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - "name": "A String", - "serverName": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "image": { + "data": "A String", + "mimeType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", + }, + "serverToolCall": { + "codeExecutionCall": { + "arguments": { # The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { + }, + "googleMapsCall": { + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { + "arguments": { # The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + }, + "mcpServerToolCall": { + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -61917,6 +57004,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -61960,6 +57053,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62061,6 +57160,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62141,6 +57246,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62184,6 +57295,410 @@

Method Details

}, ], }, + "name": "A String", + "serverName": "A String", + }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { + "arguments": { # The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "serverToolResult": { + "codeExecutionResult": { + "isError": True or False, + "result": "A String", + }, + "fileSearchResult": { + "result": [ + { # The result of the File Search. + }, + ], + }, + "googleMapsResult": { + "result": [ # The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { + "isError": True or False, + "result": [ + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { + "name": "A String", + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "serverName": "A String", + }, + "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. }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { @@ -62228,6 +57743,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], }, @@ -62283,6 +57804,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62326,6 +57853,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62427,6 +57960,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62507,6 +58046,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62547,7 +58092,7 @@

Method Details

}, "index": 42, }, - "stepStart": { # The step start data, used for step.start events. + "stepStart": { # The step start data, used for step.start events. Step-based streaming event, used when steps are enabled. "index": 42, "step": { # A step in the interaction. "modelOutput": { # Output generated by the model. @@ -62600,6 +58145,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62643,6 +58194,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62744,6 +58301,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62824,6 +58387,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62916,6 +58485,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62959,6 +58534,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -63054,475 +58635,147 @@

Method Details

}, ], "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "fileSearchCall": { # File Search call step. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -63576,6 +58829,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -63619,6 +58878,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -63720,460 +58985,161 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -64227,6 +59193,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -64270,6 +59242,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -64371,23 +59349,448 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -64399,100 +59802,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -64525,334 +59884,71 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -64888,167 +59984,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -65060,101 +60172,61 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "serverName": "A String", # The name of the used MCP server. + }, + "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. }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result step. @@ -65218,6 +60290,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -65261,6 +60339,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -65362,6 +60446,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -65442,6 +60532,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -65478,7 +60574,7 @@

Method Details

}, }, }, - "stepStop": { # The step stop data, used for step.stop events. + "stepStop": { # The step stop data, used for step.stop events. Step-based streaming event, used when steps are enabled. "index": 42, "stepUsage": { # Statistics on the interaction request's token usage. # Model usage stats for this specific step. "cachedTokensByModality": [ # A breakdown of cached token usage by modality. diff --git a/docs/dyn/aiplatform_v1beta1.memoryBanks.html b/docs/dyn/aiplatform_v1beta1.memoryBanks.html index d0fd8bc6ce..84317abfa2 100644 --- a/docs/dyn/aiplatform_v1beta1.memoryBanks.html +++ b/docs/dyn/aiplatform_v1beta1.memoryBanks.html @@ -87,10 +87,179 @@

Instance Methods

close()

Close httplib2 connections.

+

+ ingestEvents(parent, body=None, x__xgafv=None)

+

Ingests events for a Memory Bank.

Method Details

close()
Close httplib2 connections.
+
+ ingestEvents(parent, body=None, x__xgafv=None) +
Ingests events for a Memory Bank.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.IngestEvents.
+  "directContentsSource": { # Ingest events directly from the request. # Ingest events directly from the request.
+    "events": [ # Required. The events to ingest.
+      { # A single event to ingest.
+        "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event.
+          "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+            { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+              "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data.
+                "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set.
+                "text": "A String", # Required. The transcription text of this audio segment.
+                "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set.
+                  { # Information about a single recognized word.
+                    "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio.
+                    "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio.
+                    "word": "A String", # Required. Transcript of the word.
+                  },
+                ],
+              },
+              "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+                "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.
+                "outcome": "A String", # Required. Outcome of the code execution.
+                "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+              },
+              "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                "code": "A String", # Required. The code to be executed.
+                "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.
+                "language": "A String", # Required. Programming language of the `code`.
+              },
+              "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                  "a_key": "", # Properties of the object.
+                },
+                "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+                "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                  { # Partial argument value of the function call.
+                    "boolValue": True or False, # Optional. Represents a boolean value.
+                    "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                    "nullValue": "A String", # Optional. Represents a null value.
+                    "numberValue": 3.14, # Optional. Represents a double value.
+                    "stringValue": "A String", # Optional. Represents a string value.
+                    "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                  },
+                ],
+                "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+              },
+              "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+                "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                  { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                    "fileData": { # URI based data for function response. # URI based data.
+                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "fileUri": "A String", # Required. URI.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                      "data": "A String", # Required. Raw bytes.
+                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                  },
+                ],
+                "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                  "a_key": "", # Properties of the object.
+                },
+                "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+              },
+              "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                "data": "A String", # Required. The raw bytes of the data.
+                "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+                "level": "A String", # The tokenization quality used for given media.
+              },
+              "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+              "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+              "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+              "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                "endOffset": "A String", # Optional. The end offset of the video.
+                "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                "startOffset": "A String", # Optional. The start offset of the video.
+              },
+            },
+          ],
+          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+        },
+        "eventId": "A String", # Optional. A unique identifier for the event. If an event with the same event_id is ingested multiple times, it will be de-duplicated.
+        "eventTime": "A String", # Optional. The time at which the event occurred. If provided, this timestamp will be used for ordering events within a stream. If not provided, the server-side ingestion time will be used.
+      },
+    ],
+  },
+  "disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request.
+  "forceFlush": True or False, # Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`.
+  "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately.
+    "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately.
+      "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit.
+      "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity.
+      "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.
+      "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window.
+    },
+  },
+  "metadata": { # Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "metadataMergeStrategy": "A String", # Optional. The strategy to use when applying metadata to existing memories.
+  "revisionExpireTime": "A String", # Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. The TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. The scope of the memories that should be generated from the stream. Memories will be consolidated across memories with the same scope. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "streamId": "A String", # Optional. The ID of the stream to ingest events into. If not provided, a new one will be created.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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.memoryBanks.memories.html b/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html index 4efb48c7de..6efe86457b 100644 --- a/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html +++ b/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html @@ -79,18 +79,347 @@

Instance Methods

Returns the operations Resource.

+

+ revisions() +

+

Returns the revisions Resource.

+

close()

Close httplib2 connections.

+

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

+

Create a Memory.

+

+ delete(name, x__xgafv=None)

+

Delete a Memory.

+

+ generate(parent, body=None, x__xgafv=None)

+

Generate memories.

get(name, x__xgafv=None)

Get a Memory.

+

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

+

List Memories.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a Memory.

+

+ purge(parent, body=None, x__xgafv=None)

+

Purge memories.

+

+ retrieve(parent, body=None, x__xgafv=None)

+

Retrieve memories.

+

+ retrieveProfiles(parent, body=None, x__xgafv=None)

+

Retrieves profiles.

+

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

+

Rollback Memory to a specific revision.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, memoryId=None, x__xgafv=None) +
Create a Memory.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A memory.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+  "description": "A String", # Optional. Represents the description of the Memory.
+  "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+  "displayName": "A String", # Optional. Represents the display name of the Memory.
+  "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+  "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+  "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided.
+  "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+  "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory.
+    "data": { # Required. Represents the structured value of the memory.
+      "a_key": "", # Properties of the object.
+    },
+    "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to.
+  },
+  "topics": [ # Optional. Represents the Topics of the Memory.
+    { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+    },
+  ],
+  "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+}
+
+  memoryId: string, Optional. The user defined ID to use for memory, which will become the final component of the memory 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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete a Memory.
+
+Args:
+  name: string, Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ generate(parent, body=None, x__xgafv=None) +
Generate memories.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB.
+  "allowedTopics": [ # Optional. Restricts memory generation to a subset of memory topics.
+    { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+    },
+  ],
+  "directContentsSource": { # Defines a direct source of content from which to generate the memories. # Defines a direct source of content as the source content from which to generate memories.
+    "events": [ # Required. The source content (i.e. chat history) to generate memories from.
+      { # A single piece of conversation from which to generate memories.
+        "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single piece of content from which to generate memories.
+          "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+            { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+              "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data.
+                "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set.
+                "text": "A String", # Required. The transcription text of this audio segment.
+                "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set.
+                  { # Information about a single recognized word.
+                    "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio.
+                    "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio.
+                    "word": "A String", # Required. Transcript of the word.
+                  },
+                ],
+              },
+              "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+                "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.
+                "outcome": "A String", # Required. Outcome of the code execution.
+                "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+              },
+              "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                "code": "A String", # Required. The code to be executed.
+                "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.
+                "language": "A String", # Required. Programming language of the `code`.
+              },
+              "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                  "a_key": "", # Properties of the object.
+                },
+                "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+                "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                  { # Partial argument value of the function call.
+                    "boolValue": True or False, # Optional. Represents a boolean value.
+                    "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                    "nullValue": "A String", # Optional. Represents a null value.
+                    "numberValue": 3.14, # Optional. Represents a double value.
+                    "stringValue": "A String", # Optional. Represents a string value.
+                    "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                  },
+                ],
+                "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+              },
+              "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+                "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                  { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                    "fileData": { # URI based data for function response. # URI based data.
+                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "fileUri": "A String", # Required. URI.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                      "data": "A String", # Required. Raw bytes.
+                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                  },
+                ],
+                "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                  "a_key": "", # Properties of the object.
+                },
+                "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+              },
+              "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                "data": "A String", # Required. The raw bytes of the data.
+                "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+                "level": "A String", # The tokenization quality used for given media.
+              },
+              "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+              "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+              "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+              "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                "endOffset": "A String", # Optional. The end offset of the video.
+                "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                "startOffset": "A String", # Optional. The start offset of the video.
+              },
+            },
+          ],
+          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+        },
+      },
+    ],
+  },
+  "directMemoriesSource": { # Defines a direct source of memories that should be uploaded to Memory Bank with consolidation. # Defines a direct source of memories that should be uploaded to Memory Bank. This is similar to `CreateMemory`, but it allows for consolidation between these new memories and existing memories for the same scope.
+    "directMemories": [ # Required. The direct memories to upload to Memory Bank. At most 5 direct memories are allowed per request.
+      { # A direct memory to upload to Memory Bank.
+        "fact": "A String", # Required. The fact to consolidate with existing memories.
+        "topics": [ # Optional. The topics that the consolidated memories should be associated with.
+          { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+            "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+            "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+          },
+        ],
+      },
+    ],
+  },
+  "disableConsolidation": True or False, # Optional. If true, generated memories will not be consolidated with existing memories; all generated memories will be added as new memories regardless of whether they are duplicates of or contradictory to existing memories. By default, memory consolidation is enabled.
+  "disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request.
+  "metadata": { # Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "metadataMergeStrategy": "A String", # Optional. The strategy to use when applying metadata to existing memories.
+  "revisionExpireTime": "A String", # Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. The TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "vertexSessionSource": { # Defines an Agent Engine Session from which to generate the memories. If `scope` is not provided, the scope will be extracted from the Session (i.e. {"user_id": sesison.user_id}). # Defines a Vertex Session as the source content from which to generate memories.
+    "endTime": "A String", # Optional. End time (exclusive) of the time range. If not set, the end time is unbounded.
+    "session": "A String", # Required. The resource name of the Session to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
+    "startTime": "A String", # Optional. Time range to define which session events should be used to generate memories. Start time (inclusive) of the time range. If not set, the start time is unbounded.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
get(name, x__xgafv=None)
Get a Memory.
@@ -147,4 +476,402 @@ 

Method Details

}
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
List Memories.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`)
+  orderBy: string, Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`
+  pageSize: integer, Optional. The standard list page size.
+  pageToken: string, Optional. The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for MemoryBankService.ListMemories.
+  "memories": [ # List of Memories in the requested page.
+    { # A memory.
+      "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+      "description": "A String", # Optional. Represents the description of the Memory.
+      "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+      "displayName": "A String", # Optional. Represents the display name of the Memory.
+      "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+      "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+      "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided.
+      "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+        "a_key": { # Memory metadata.
+          "boolValue": True or False, # Represents a boolean value.
+          "doubleValue": 3.14, # Represents a double value.
+          "stringValue": "A String", # Represents a string value.
+          "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+        },
+      },
+      "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+      "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+      "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+        "a_key": "A String",
+      },
+      "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+      "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+        "a_key": "A String",
+      },
+      "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory.
+        "data": { # Required. Represents the structured value of the memory.
+          "a_key": "", # Properties of the object.
+        },
+        "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to.
+      },
+      "topics": [ # Optional. Represents the Topics of the Memory.
+        { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+          "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+          "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+        },
+      ],
+      "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+      "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListMemoriesRequest.page_token to obtain that page.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update a Memory.
+
+Args:
+  name: string, Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A memory.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+  "description": "A String", # Optional. Represents the description of the Memory.
+  "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+  "displayName": "A String", # Optional. Represents the display name of the Memory.
+  "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+  "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+  "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided.
+  "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+  "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory.
+    "data": { # Required. Represents the structured value of the memory.
+      "a_key": "", # Properties of the object.
+    },
+    "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to.
+  },
+  "topics": [ # Optional. Represents the Topics of the Memory.
+    { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+    },
+  ],
+  "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+}
+
+  updateMask: string, Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ purge(parent, body=None, x__xgafv=None) +
Purge memories.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.PurgeMemories.
+  "filter": "A String", # Required. The standard list filter to determine which memories to purge. More detail in [AIP-160](https://google.aip.dev/160).
+  "filterGroups": [ # Optional. Metadata filters that will be applied to the memories to be purged. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`.
+    { # A conjunction of filters that will be combined using AND logic.
+      "filters": [ # Represents filters that will be combined using AND logic.
+        { # Filter to apply when retrieving memories.
+          "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author".
+          "negate": True or False, # Indicates whether the filter will be negated.
+          "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used.
+          "value": { # Memory metadata. # Represents the value to compare to.
+            "boolValue": True or False, # Represents a boolean value.
+            "doubleValue": 3.14, # Represents a double value.
+            "stringValue": "A String", # Represents a string value.
+            "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+          },
+        },
+      ],
+    },
+  ],
+  "force": True or False, # Optional. If true, the memories will actually be purged. If false, the purge request will be validated but not executed.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ retrieve(parent, body=None, x__xgafv=None) +
Retrieve memories.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.RetrieveMemories.
+  "filter": "A String", # Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time` * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`)
+  "filterGroups": [ # Optional. Metadata filters that will be applied to the retrieved memories' `metadata` using OR logic. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`.
+    { # A conjunction of filters that will be combined using AND logic.
+      "filters": [ # Represents filters that will be combined using AND logic.
+        { # Filter to apply when retrieving memories.
+          "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author".
+          "negate": True or False, # Indicates whether the filter will be negated.
+          "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used.
+          "value": { # Memory metadata. # Represents the value to compare to.
+            "boolValue": True or False, # Represents a boolean value.
+            "doubleValue": 3.14, # Represents a double value.
+            "stringValue": "A String", # Represents a string value.
+            "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+          },
+        },
+      ],
+    },
+  ],
+  "memoryTypes": [ # Optional. Specifies the types of memories to retrieve. If this field is empty or not provided, the request will default to retrieving only memories of type `NATURAL_LANGUAGE_COLLECTION`. If populated, the request will retrieve memories matching any of the specified `MemoryType` values.
+    "A String",
+  ],
+  "scope": { # Required. The scope of the memories to retrieve. A memory must have exactly the same scope (`Memory.scope`) as the scope provided here to be retrieved (same keys and values). Order does not matter, but it is case-sensitive.
+    "a_key": "A String",
+  },
+  "similaritySearchParams": { # Parameters for semantic similarity search based retrieval. # Parameters for semantic similarity search based retrieval.
+    "searchQuery": "A String", # Required. Query to use for similarity search retrieval. If provided, then the parent ReasoningEngine must have ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig set.
+    "topK": 42, # Optional. The maximum number of memories to return. The service may return fewer than this value. If unspecified, at most 3 memories will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  },
+  "simpleRetrievalParams": { # Parameters for simple (non-similarity search) retrieval. # Parameters for simple (non-similarity search) retrieval.
+    "pageSize": 42, # Optional. The maximum number of memories to return. The service may return fewer than this value. If unspecified, at most 3 memories will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+    "pageToken": "A String", # Optional. A page token, received from a previous `RetrieveMemories` call. Provide this to retrieve the subsequent page.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for MemoryBankService.RetrieveMemories.
+  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. This token is not set if similarity search was used for retrieval.
+  "retrievedMemories": [ # The retrieved memories.
+    { # A retrieved memory.
+      "distance": 3.14, # The distance between the query and the retrieved Memory. Smaller values indicate more similar memories. This is only set if similarity search was used for retrieval.
+      "memory": { # A memory. # The retrieved Memory.
+        "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+        "description": "A String", # Optional. Represents the description of the Memory.
+        "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+        "displayName": "A String", # Optional. Represents the display name of the Memory.
+        "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+        "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+        "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided.
+        "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+          "a_key": { # Memory metadata.
+            "boolValue": True or False, # Represents a boolean value.
+            "doubleValue": 3.14, # Represents a double value.
+            "stringValue": "A String", # Represents a string value.
+            "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+          },
+        },
+        "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+        "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+        "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+          "a_key": "A String",
+        },
+        "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+        "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+          "a_key": "A String",
+        },
+        "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory.
+          "data": { # Required. Represents the structured value of the memory.
+            "a_key": "", # Properties of the object.
+          },
+          "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to.
+        },
+        "topics": [ # Optional. Represents the Topics of the Memory.
+          { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+            "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+            "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+          },
+        ],
+        "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+        "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+      },
+    },
+  ],
+}
+
+ +
+ retrieveProfiles(parent, body=None, x__xgafv=None) +
Retrieves profiles.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.RetrieveProfiles.
+  "scope": { # Required. The scope of the profiles to retrieve.
+    "a_key": "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 MemoryBankService.RetrieveProfiles.
+  "profiles": { # The retrieved structured profiles, which match the schemas under the requested scope. The key is the ID of the schema that the profile is linked with, which corresponds to the `schema_id` defined inside the `SchemaConfig`, under `StructuredMemoryCustomizationConfig`.
+    "a_key": { # A memory profile.
+      "profile": { # Represents the profile data.
+        "a_key": "", # Properties of the object.
+      },
+      "schemaId": "A String", # Represents the ID of the schema. This ID corresponds to the `schema_id` defined inside the SchemaConfig, under StructuredMemoryCustomizationConfig.
+    },
+  },
+}
+
+ +
+ rollback(name, body=None, x__xgafv=None) +
Rollback Memory to a specific revision.
+
+Args:
+  name: string, Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.RollbackMemory.
+  "targetRevisionId": "A String", # Required. The ID of the revision to rollback to.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.revisions.html b/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.revisions.html new file mode 100644 index 0000000000..204be98127 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.revisions.html @@ -0,0 +1,191 @@ + + + +

Agent Platform API . memoryBanks . memories . revisions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a Memory Revision.

+

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

+

List Memory Revisions for a Memory.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get a Memory Revision.
+
+Args:
+  name: string, Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A revision of a Memory.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory Revision was created.
+  "expireTime": "A String", # Output only. Represents the timestamp of when this resource is considered expired.
+  "extractedMemories": [ # Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.
+    { # An extracted memory that is the intermediate result before consolidation.
+      "context": "A String", # Output only. Represents the explanation of why the information was extracted from the source content.
+      "fact": "A String", # Output only. Represents the fact of the extracted memory.
+      "structuredData": { # Output only. Represents the structured value of the extracted memory.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  ],
+  "fact": "A String", # Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.
+  "labels": { # Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`
+  "structuredData": { # Output only. Represents the structured value of the memory at the time of revision creation.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
List Memory Revisions for a Memory.
+
+Args:
+  parent: string, Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`
+  pageSize: integer, Optional. The standard list page size.
+  pageToken: string, Optional. The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for MemoryBankService.ListMemoryRevisions.
+  "memoryRevisions": [ # The list of Memory Revisions in the request page.
+    { # A revision of a Memory.
+      "createTime": "A String", # Output only. Represents the timestamp when this Memory Revision was created.
+      "expireTime": "A String", # Output only. Represents the timestamp of when this resource is considered expired.
+      "extractedMemories": [ # Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.
+        { # An extracted memory that is the intermediate result before consolidation.
+          "context": "A String", # Output only. Represents the explanation of why the information was extracted from the source content.
+          "fact": "A String", # Output only. Represents the fact of the extracted memory.
+          "structuredData": { # Output only. Represents the structured value of the extracted memory.
+            "a_key": "", # Properties of the object.
+          },
+        },
+      ],
+      "fact": "A String", # Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.
+      "labels": { # Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`
+      "structuredData": { # Output only. Represents the structured value of the memory at the time of revision creation.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.html b/docs/dyn/aiplatform_v1beta1.projects.html index 44d8136725..06d1f92e43 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.html +++ b/docs/dyn/aiplatform_v1beta1.projects.html @@ -130,7 +130,7 @@

Method Details

"cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. - "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). When enabled, logs are emitted for all publisher-model traffic on the model -- Provisioned Throughput and on-demand alike. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. @@ -182,7 +182,7 @@

Method Details

"cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. - "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). When enabled, logs are emitted for all publisher-model traffic on the model -- Provisioned Throughput and on-demand alike. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. @@ -196,6 +196,7 @@

Method Details

"samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. }, }, + "updateMask": "A String", # Optional. The fields of `publisher_model_config` to overwrite. If empty, the entire config is replaced. If set, only the listed fields are overwritten and the others are left unchanged; this lets you update one setting (for example `inference_event_logging_config`) without clearing its siblings. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.agentAnomalyDetectionScopes.html b/docs/dyn/aiplatform_v1beta1.projects.locations.agentAnomalyDetectionScopes.html index e5ec1c3265..93581c9900 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.agentAnomalyDetectionScopes.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.agentAnomalyDetectionScopes.html @@ -107,16 +107,16 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Resource representing an Agent Anomaly Detection Scope. - "displayName": "A String", # Optional. User provided display name of the AgentAnomalyDetectionScope. - "logBuckets": [ # Required. Customer owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`. +{ # Represents an Agent Anomaly Detection Scope. + "displayName": "A String", # Optional. User-provided display name of the AgentAnomalyDetectionScope. + "logBuckets": [ # Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`. "A String", ], "name": "A String", # Identifier. The resource name of the AgentAnomalyDetectionScope. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}` - "observabilityBuckets": [ # Required. Customer owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`. + "observabilityBuckets": [ # Required. Customer-owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`. "A String", ], - "state": "A String", # Output only. The lifecycle state of the scope. See `State` for the semantics of each value. + "state": "A String", # Output only. The lifecycle state of the scope. } agentAnomalyDetectionScopeId: string, Required. The ID to use for the AgentAnomalyDetectionScope, which will become the final component of the AgentAnomalyDetectionScope's resource name. This value should be 1-63 characters, and valid characters are /[a-z]([a-z0-9-]{0,61}[a-z0-9])?/. @@ -198,16 +198,16 @@

Method Details

Returns: An object of the form: - { # Resource representing an Agent Anomaly Detection Scope. - "displayName": "A String", # Optional. User provided display name of the AgentAnomalyDetectionScope. - "logBuckets": [ # Required. Customer owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`. + { # Represents an Agent Anomaly Detection Scope. + "displayName": "A String", # Optional. User-provided display name of the AgentAnomalyDetectionScope. + "logBuckets": [ # Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`. "A String", ], "name": "A String", # Identifier. The resource name of the AgentAnomalyDetectionScope. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}` - "observabilityBuckets": [ # Required. Customer owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`. + "observabilityBuckets": [ # Required. Customer-owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`. "A String", ], - "state": "A String", # Output only. The lifecycle state of the scope. See `State` for the semantics of each value. + "state": "A String", # Output only. The lifecycle state of the scope. } @@ -229,16 +229,16 @@

Method Details

{ # Response message for AgentAnomalyDetectionService.ListAgentAnomalyDetectionScopes. "agentAnomalyDetectionScopes": [ # A list of AgentAnomalyDetectionScopes that matches the specified filter in the request. - { # Resource representing an Agent Anomaly Detection Scope. - "displayName": "A String", # Optional. User provided display name of the AgentAnomalyDetectionScope. - "logBuckets": [ # Required. Customer owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`. + { # Represents an Agent Anomaly Detection Scope. + "displayName": "A String", # Optional. User-provided display name of the AgentAnomalyDetectionScope. + "logBuckets": [ # Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`. "A String", ], "name": "A String", # Identifier. The resource name of the AgentAnomalyDetectionScope. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}` - "observabilityBuckets": [ # Required. Customer owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`. + "observabilityBuckets": [ # Required. Customer-owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`. "A String", ], - "state": "A String", # Output only. The lifecycle state of the scope. See `State` for the semantics of each value. + "state": "A String", # Output only. The lifecycle state of the scope. }, ], "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. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.batchPredictionJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.batchPredictionJobs.html index eb564ab078..efaaeb3d05 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.batchPredictionJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.batchPredictionJobs.html @@ -172,6 +172,7 @@

Method Details

"kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. }, "endTime": "A String", # Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. + "endpoint": "A String", # For Bring-Your-Own-Endpoint (BYOE), the name of the Endpoint resource that produces the predictions via this job, must share the same ancestor Location. Exactly one of model, unmanaged_container_model, or endpoint must be set. Example: `projects/193595526740/locations/us-central1/endpoints/4203439000301600768` "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. @@ -677,6 +678,7 @@

Method Details

"kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. }, "endTime": "A String", # Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. + "endpoint": "A String", # For Bring-Your-Own-Endpoint (BYOE), the name of the Endpoint resource that produces the predictions via this job, must share the same ancestor Location. Exactly one of model, unmanaged_container_model, or endpoint must be set. Example: `projects/193595526740/locations/us-central1/endpoints/4203439000301600768` "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. @@ -1224,6 +1226,7 @@

Method Details

"kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. }, "endTime": "A String", # Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. + "endpoint": "A String", # For Bring-Your-Own-Endpoint (BYOE), the name of the Endpoint resource that produces the predictions via this job, must share the same ancestor Location. Exactly one of model, unmanaged_container_model, or endpoint must be set. Example: `projects/193595526740/locations/us-central1/endpoints/4203439000301600768` "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. @@ -1742,6 +1745,7 @@

Method Details

"kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. }, "endTime": "A String", # Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. + "endpoint": "A String", # For Bring-Your-Own-Endpoint (BYOE), the name of the Endpoint resource that produces the predictions via this job, must share the same ancestor Location. Exactly one of model, unmanaged_container_model, or endpoint must be set. Example: `projects/193595526740/locations/us-central1/endpoints/4203439000301600768` "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index 99ac8afae3..6855be9792 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -115,12 +115,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -200,12 +213,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -401,6 +427,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -546,12 +578,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -631,12 +676,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -832,6 +890,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1002,12 +1066,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1087,12 +1164,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1288,6 +1378,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1444,12 +1540,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1529,12 +1638,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1730,6 +1852,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1894,12 +2022,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1979,12 +2120,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2180,6 +2334,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2326,12 +2486,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2411,12 +2584,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2612,6 +2798,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index c6c81fd6ea..3a7aee5abe 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -170,12 +170,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -246,6 +259,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -404,12 +434,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -605,6 +648,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -788,12 +837,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -864,6 +926,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1022,12 +1101,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1223,6 +1315,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index afbe86fa85..3008ce01f7 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -210,12 +210,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -327,12 +340,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -403,6 +429,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -550,12 +593,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -735,6 +791,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1160,7 +1222,7 @@

Method Details

"cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. - "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). When enabled, logs are emitted for all publisher-model traffic on the model -- Provisioned Throughput and on-demand alike. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. @@ -2045,12 +2107,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2121,6 +2196,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2278,12 +2370,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2479,6 +2584,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2633,12 +2744,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3185,7 +3309,7 @@

Method Details

"cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. - "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). When enabled, logs are emitted for all publisher-model traffic on the model -- Provisioned Throughput and on-demand alike. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. @@ -3537,7 +3661,7 @@

Method Details

"cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. - "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). When enabled, logs are emitted for all publisher-model traffic on the model -- Provisioned Throughput and on-demand alike. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. @@ -4110,7 +4234,7 @@

Method Details

"cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. - "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). When enabled, logs are emitted for all publisher-model traffic on the model -- Provisioned Throughput and on-demand alike. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. @@ -4414,7 +4538,7 @@

Method Details

"cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. - "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). When enabled, logs are emitted for all publisher-model traffic on the model -- Provisioned Throughput and on-demand alike. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. @@ -4825,12 +4949,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4901,6 +5038,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5058,12 +5212,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -5259,6 +5426,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -5413,12 +5586,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6068,7 +6254,7 @@

Method Details

"cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. - "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). When enabled, logs are emitted for all publisher-model traffic on the model -- Provisioned Throughput and on-demand alike. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html index 67db9e20b8..3f0488df8e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html @@ -250,6 +250,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -489,6 +495,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -614,12 +626,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -712,12 +737,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -913,6 +951,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1152,6 +1196,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1277,12 +1327,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1375,12 +1438,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1575,6 +1651,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1814,6 +1896,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1939,12 +2027,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2028,12 +2129,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2293,6 +2407,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2532,6 +2652,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2657,12 +2783,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2755,12 +2894,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2956,6 +3108,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3195,6 +3353,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3320,12 +3484,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3418,12 +3595,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3618,6 +3808,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3857,6 +4053,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3982,12 +4184,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4071,12 +4286,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4327,6 +4555,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -4566,6 +4800,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -4691,12 +4931,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4789,12 +5042,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4990,6 +5256,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -5229,6 +5501,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -5354,12 +5632,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -5452,12 +5743,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -5652,6 +5956,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -5891,6 +6201,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -6016,12 +6332,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6105,12 +6434,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6370,6 +6712,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -6609,6 +6957,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -6734,12 +7088,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6832,12 +7199,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7033,6 +7413,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7272,6 +7658,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7397,12 +7789,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7495,12 +7900,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7695,6 +8113,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7934,6 +8358,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -8059,12 +8489,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8148,12 +8591,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8446,6 +8902,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -8685,6 +9147,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -8810,12 +9278,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8908,12 +9389,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9109,6 +9603,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -9348,6 +9848,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -9473,12 +9979,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9571,12 +10090,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9771,6 +10303,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -10010,6 +10548,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -10135,12 +10679,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -10224,12 +10781,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -10489,6 +11059,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -10728,6 +11304,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -10853,12 +11435,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -10951,12 +11546,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11152,6 +11760,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -11391,6 +12005,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -11516,12 +12136,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11614,12 +12247,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11814,6 +12460,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -12053,6 +12705,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -12178,12 +12836,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -12267,12 +12938,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -12536,6 +13220,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -12775,6 +13465,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -12900,12 +13596,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -12998,12 +13707,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -13199,6 +13921,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -13438,6 +14166,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -13563,12 +14297,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -13661,12 +14408,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -13861,6 +14621,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -14100,6 +14866,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -14225,12 +14997,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -14314,12 +15099,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -14579,6 +15377,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -14818,6 +15622,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -14943,12 +15753,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -15041,12 +15864,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -15242,6 +16078,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -15481,6 +16323,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -15606,12 +16454,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -15704,12 +16565,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -15904,6 +16778,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -16143,6 +17023,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -16268,12 +17154,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -16357,12 +17256,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html index 02849429f1..619b954d33 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html @@ -116,6 +116,9 @@

Method Details

"createTime": "A String", # Output only. The time when the EvaluationMetric was created. "description": "A String", # Optional. A description of the EvaluationMetric. "displayName": "A String", # Required. The user-friendly display name for the EvaluationMetric. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "gcsUri": "A String", # Optional. The Google Cloud Storage URI that stores the metric specification.. "labels": { # Optional. Labels for the evaluation metric. "a_key": "A String", @@ -147,6 +150,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -307,6 +327,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -515,6 +552,9 @@

Method Details

"createTime": "A String", # Output only. The time when the EvaluationMetric was created. "description": "A String", # Optional. A description of the EvaluationMetric. "displayName": "A String", # Required. The user-friendly display name for the EvaluationMetric. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "gcsUri": "A String", # Optional. The Google Cloud Storage URI that stores the metric specification.. "labels": { # Optional. Labels for the evaluation metric. "a_key": "A String", @@ -546,6 +586,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -706,6 +763,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -955,6 +1029,9 @@

Method Details

"createTime": "A String", # Output only. The time when the EvaluationMetric was created. "description": "A String", # Optional. A description of the EvaluationMetric. "displayName": "A String", # Required. The user-friendly display name for the EvaluationMetric. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "gcsUri": "A String", # Optional. The Google Cloud Storage URI that stores the metric specification.. "labels": { # Optional. Labels for the evaluation metric. "a_key": "A String", @@ -986,6 +1063,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1146,6 +1240,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1366,6 +1477,9 @@

Method Details

"createTime": "A String", # Output only. The time when the EvaluationMetric was created. "description": "A String", # Optional. A description of the EvaluationMetric. "displayName": "A String", # Required. The user-friendly display name for the EvaluationMetric. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "gcsUri": "A String", # Optional. The Google Cloud Storage URI that stores the metric specification.. "labels": { # Optional. Labels for the evaluation metric. "a_key": "A String", @@ -1397,6 +1511,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1557,6 +1688,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index 09b290bc2e..4f36bc9384 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -173,6 +173,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -355,6 +372,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -510,6 +544,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -689,6 +740,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -849,6 +917,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1066,6 +1151,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1215,6 +1317,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1393,6 +1512,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1720,6 +1856,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1959,6 +2101,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2084,12 +2232,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2182,12 +2343,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2383,6 +2557,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2622,6 +2802,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2747,12 +2933,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2845,12 +3044,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3045,6 +3257,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3284,6 +3502,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3409,12 +3633,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3498,12 +3735,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3637,12 +3887,25 @@

Method Details

"developerInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The developer instruction for the agent. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3822,6 +4085,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3959,6 +4228,23 @@

Method Details

"maxTurn": 42, # Maximum number of invocations allowed by the multi-turn agent scraping. This property allows us to stop a run-off conversation, where the agent and the user simulator get into a never ending loop. The initial fixed prompt is also counted as an invocation. "modelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # The configuration for the model. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4223,6 +4509,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -4348,6 +4640,23 @@

Method Details

}, "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4546,6 +4855,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4728,6 +5054,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -4883,6 +5226,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5062,6 +5422,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5222,6 +5599,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5439,6 +5833,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5588,6 +5999,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5766,6 +6194,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -6093,6 +6538,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -6332,6 +6783,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -6457,12 +6914,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6555,12 +7025,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6756,6 +7239,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -6995,6 +7484,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7120,12 +7615,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7218,12 +7726,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7418,6 +7939,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7657,6 +8184,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7782,12 +8315,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7871,12 +8417,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8010,12 +8569,25 @@

Method Details

"developerInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The developer instruction for the agent. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8195,6 +8767,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -8332,6 +8910,23 @@

Method Details

"maxTurn": 42, # Maximum number of invocations allowed by the multi-turn agent scraping. This property allows us to stop a run-off conversation, where the agent and the user simulator get into a never ending loop. The initial fixed prompt is also counted as an invocation. "modelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # The configuration for the model. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -8596,6 +9191,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -8721,6 +9322,23 @@

Method Details

}, "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -8961,6 +9579,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -9143,6 +9778,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -9298,6 +9950,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -9477,6 +10146,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -9637,6 +10323,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -9854,6 +10557,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -10003,6 +10723,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -10181,6 +10918,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -10508,6 +11262,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -10747,6 +11507,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -10872,12 +11638,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -10970,12 +11749,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11171,6 +11963,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -11410,6 +12208,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -11535,12 +12339,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11633,12 +12450,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11833,6 +12663,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -12072,6 +12908,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -12197,12 +13039,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -12286,12 +13141,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -12425,12 +13293,25 @@

Method Details

"developerInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The developer instruction for the agent. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -12610,6 +13491,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -12747,6 +13634,23 @@

Method Details

"maxTurn": 42, # Maximum number of invocations allowed by the multi-turn agent scraping. This property allows us to stop a run-off conversation, where the agent and the user simulator get into a never ending loop. The initial fixed prompt is also counted as an invocation. "modelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # The configuration for the model. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -13011,6 +13915,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -13136,6 +14046,23 @@

Method Details

}, "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -13347,6 +14274,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -13529,6 +14473,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -13684,6 +14645,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -13863,6 +14841,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -14023,6 +15018,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -14240,6 +15252,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -14389,6 +15418,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -14567,6 +15613,23 @@

Method Details

"autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -14894,6 +15957,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -15133,6 +16202,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -15258,12 +16333,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -15356,12 +16444,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -15557,6 +16658,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -15796,6 +16903,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -15921,12 +17034,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -16019,12 +17145,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -16219,6 +17358,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -16458,6 +17603,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -16583,12 +17734,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -16672,12 +17836,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -16811,12 +17988,25 @@

Method Details

"developerInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The developer instruction for the agent. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -16996,6 +18186,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -17133,6 +18329,23 @@

Method Details

"maxTurn": 42, # Maximum number of invocations allowed by the multi-turn agent scraping. This property allows us to stop a run-off conversation, where the agent and the user simulator get into a never ending loop. The initial fixed prompt is also counted as an invocation. "modelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # The configuration for the model. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -17397,6 +18610,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -17522,6 +18741,23 @@

Method Details

}, "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html index fce9510a75..2fffb2fa6f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html @@ -240,6 +240,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -365,6 +371,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], @@ -503,6 +512,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -628,6 +643,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], @@ -808,6 +826,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -933,6 +957,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], @@ -1104,6 +1131,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1229,6 +1262,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], @@ -1426,6 +1462,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1551,6 +1593,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], @@ -1708,6 +1753,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1833,6 +1884,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], @@ -1972,6 +2026,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2097,6 +2157,9 @@

Method Details

}, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. + "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + }, "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html index 0f657ebff6..d0aa824daf 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html @@ -245,12 +245,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -324,12 +337,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single step's content. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -607,12 +633,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -718,12 +757,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -797,12 +849,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single step's content. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -907,12 +972,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -986,12 +1064,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single step's content. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1094,12 +1185,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1173,12 +1277,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single step's content. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index e9052f8188..9dcce0cd25 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -1153,12 +1153,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1243,12 +1256,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index f4f7dd9a2d..4ab1a49236 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -569,6 +569,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -874,6 +880,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1040,12 +1052,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1168,12 +1193,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1282,12 +1320,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input content to corroborate, only text format is supported for now. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1754,6 +1805,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1935,6 +2003,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2095,6 +2180,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2338,6 +2440,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2559,12 +2678,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2752,6 +2884,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2887,12 +3025,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3080,6 +3231,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3211,12 +3368,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3293,12 +3463,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3481,6 +3664,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3720,6 +3909,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3845,12 +4040,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4051,6 +4259,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -4290,6 +4504,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -4415,12 +4635,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4507,12 +4740,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4592,12 +4838,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4675,12 +4934,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4758,12 +5030,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4884,6 +5169,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5044,6 +5346,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5266,6 +5585,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5426,6 +5762,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5639,12 +5992,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -5763,12 +6129,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6403,12 +6782,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6596,6 +6988,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -6724,12 +7122,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6812,6 +7223,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -7169,6 +7597,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7408,6 +7842,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -7533,12 +7973,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7631,12 +8084,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7832,6 +8298,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -8071,6 +8543,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -8196,12 +8674,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8294,12 +8785,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8494,6 +8998,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -8733,6 +9243,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -8858,12 +9374,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8947,12 +9476,25 @@

Method Details

"a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9100,12 +9642,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The actual content or value for this field. This can be text, images, or other types of data. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9206,12 +9761,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The actual content or value for this field. This can be text, images, or other types of data. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9418,6 +9986,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -9654,6 +10228,9 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was created. "gatewayConfigs": { # Optional. Configurations for gateways. The keys are user-defined names for each gateway. At most 5 gateway configurations are allowed. "a_key": { # Configuration for a single gateway. + "allowedProjects": [ # Optional. Additional consumer projects permitted to attach their own PSC endpoint to this gateway's ServiceAttachment. This is the "decoupled" mode, where the customer creates the PSC endpoint in a project other than this gateway's `network` project. Each listed project is VPC-SC enforced: it must be within the caller's service perimeter. The owning SemanticGovernancePolicyEngine's own project is always permitted implicitly and need not be listed. Format: project ID or number. + "A String", + ], "dnsRecord": "A String", # Output only. The fully qualified record name of the created A-record in Cloud DNS. "dnsZoneName": "A String", # Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint. "ipAddress": "A String", # Output only. The private IP address of the PSC endpoint. @@ -10206,6 +10783,9 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was created. "gatewayConfigs": { # Optional. Configurations for gateways. The keys are user-defined names for each gateway. At most 5 gateway configurations are allowed. "a_key": { # Configuration for a single gateway. + "allowedProjects": [ # Optional. Additional consumer projects permitted to attach their own PSC endpoint to this gateway's ServiceAttachment. This is the "decoupled" mode, where the customer creates the PSC endpoint in a project other than this gateway's `network` project. Each listed project is VPC-SC enforced: it must be within the caller's service perimeter. The owning SemanticGovernancePolicyEngine's own project is always permitted implicitly and need not be listed. Format: project ID or number. + "A String", + ], "dnsRecord": "A String", # Output only. The fully qualified record name of the created A-record in Cloud DNS. "dnsZoneName": "A String", # Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint. "ipAddress": "A String", # Output only. The private IP address of the PSC endpoint. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html index adeef6c985..ed31b2147d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html @@ -104,7 +104,7 @@

Instance Methods

list_next()

Retrieves the next page of results.

- mutateDeployedIndex(indexEndpoint, body=None, x__xgafv=None)

+ mutateDeployedIndex(indexEndpoint, body=None, updateMask=None, x__xgafv=None)

Update an existing DeployedIndex under an IndexEndpoint.

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

@@ -892,7 +892,7 @@

Method Details

- mutateDeployedIndex(indexEndpoint, body=None, x__xgafv=None) + mutateDeployedIndex(indexEndpoint, body=None, updateMask=None, x__xgafv=None)
Update an existing DeployedIndex under an IndexEndpoint.
 
 Args:
@@ -989,6 +989,7 @@ 

Method Details

], } + updateMask: string, Optional. The update mask applies to the resource. The supported paths are `automatic_resources`, `dedicated_resources`, `enable_access_logging` and `deployed_index_auth_config`. When omitted, the service will perform a full update of all fields. See google.protobuf.FieldMask. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html index 2b49a63bb6..4eb0efd198 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html @@ -107,6 +107,38 @@

Method Details

"interaction": { # Response for InteractionService.CreateInteraction. # The interaction to create. "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. "agent": "A String", # The name of the `Agent` used for generating the completion. + "antigravityConfig": { # Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration. # Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis. + "maxTotalTokens": "A String", # Max total tokens for the agent run. + "model": "A String", # The model to use for agent reasoning. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "find_request": { # Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase. # Parameters for finding vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the vulnerability analysis. + "finding_id": "A String", # The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability. + "mode": "A String", # The mode of the find session. + "source_files": [ # A list of source files to provide as context for the scan. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "fix_request": { # Request parameters specific to FIX sessions, used for generating and validating security patches. # Parameters for fixing vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the patch generation process. + "finding_id": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "source_files": [ # A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. + "session_config": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "max_rounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "session_id": "A String", # Parameter for grouping multiple interactions that belong to the same CodeMender session. + }, "deepResearchConfig": { # Configuration for the Deep Research agent. "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. @@ -168,6 +200,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -211,6 +249,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -312,6 +356,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -392,6 +442,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -485,6 +541,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -528,6 +590,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -629,6 +697,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -709,6 +783,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -789,6 +869,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -832,6 +918,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -933,6 +1025,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1013,6 +1111,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1049,16 +1153,18 @@

Method Details

"envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "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", + }, + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. }, "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. "seed": 42, # Seed used in decoding for reproducibility. "speechConfig": [ # Configuration for speech interaction. { # The configuration for speech interaction. @@ -1083,6 +1189,21 @@

Method Details

}, "toolChoiceMode": "A String", # The mode of the tool choice. "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "transcriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for speech recognition (transcription). If present, ASR is enabled. + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageHints": [ # Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to ["auto"] to enable automatic language detection. + "A String", + ], + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, "videoConfig": { # Configuration options for video generation. # Configuration for video generation. "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. }, @@ -1138,333 +1259,11 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], @@ -1509,6 +1308,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1610,6 +1415,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1690,6 +1501,365 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "environmentId": "A String", # Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1799,6 +1969,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1842,6 +2018,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -1943,6 +2125,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2023,6 +2211,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2122,6 +2316,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2165,6 +2365,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2266,6 +2472,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2346,6 +2558,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2466,6 +2684,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2509,6 +2733,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2610,6 +2840,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2690,6 +2926,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2789,6 +3031,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2832,6 +3080,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -2933,6 +3187,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3013,6 +3273,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3069,6 +3335,13 @@

Method Details

"A String", ], "role": "A String", # Output only. The role of the interaction. + "safety_settings": [ # Safety settings for the interaction. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. + "type": "A String", # Required. The type of harm category to be blocked. + }, + ], "status": "A String", # Required. Output only. The status of the interaction. "stepList": { # A list of Steps. # Input only. The steps for the interaction. "steps": [ # The steps of the list. @@ -3123,321 +3396,11 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], @@ -3482,6 +3445,352 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3583,6 +3892,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3663,6 +3978,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3759,6 +4080,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3802,6 +4129,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3903,6 +4236,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -3983,6 +4322,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -4099,6 +4444,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -4142,6 +4493,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -4243,6 +4600,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -4323,6 +4686,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -4369,6 +4738,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -4387,334 +4764,72 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -4750,167 +4865,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -4922,100 +5053,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -5048,334 +5135,426 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -5411,382 +5590,15 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": "A String", # Required. The text content. }, }, ], @@ -5885,6 +5697,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -5965,6 +5783,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6054,6 +5878,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6097,6 +5927,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6198,6 +6034,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6278,6 +6120,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6370,6 +6218,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6413,6 +6267,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6514,6 +6374,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6594,6 +6460,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6690,6 +6562,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6733,6 +6611,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6834,6 +6718,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -6914,6 +6804,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -7030,6 +6926,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -7073,6 +6975,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -7174,6 +7082,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -7254,6 +7168,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -7300,6 +7220,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -7318,334 +7246,72 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -7681,167 +7347,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -7853,100 +7535,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -7979,334 +7617,71 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -8342,167 +7717,97 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -8514,101 +7819,147 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "serverName": "A String", # The name of the used MCP server. + }, + "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. }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result step. @@ -8672,6 +8023,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -8715,6 +8072,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -8816,6 +8179,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -8896,6 +8265,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9008,6 +8383,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9051,6 +8432,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9152,6 +8539,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9232,6 +8625,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9406,6 +8805,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9449,6 +8854,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9550,6 +8961,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9630,6 +9047,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9722,6 +9145,38 @@

Method Details

{ # Response for InteractionService.CreateInteraction. "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. "agent": "A String", # The name of the `Agent` used for generating the completion. + "antigravityConfig": { # Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration. # Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis. + "maxTotalTokens": "A String", # Max total tokens for the agent run. + "model": "A String", # The model to use for agent reasoning. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "find_request": { # Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase. # Parameters for finding vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the vulnerability analysis. + "finding_id": "A String", # The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability. + "mode": "A String", # The mode of the find session. + "source_files": [ # A list of source files to provide as context for the scan. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "fix_request": { # Request parameters specific to FIX sessions, used for generating and validating security patches. # Parameters for fixing vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the patch generation process. + "finding_id": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "source_files": [ # A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. + "session_config": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "max_rounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "session_id": "A String", # Parameter for grouping multiple interactions that belong to the same CodeMender session. + }, "deepResearchConfig": { # Configuration for the Deep Research agent. "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. @@ -9783,6 +9238,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9826,6 +9287,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -9927,6 +9394,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10007,6 +9480,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10100,6 +9579,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10143,6 +9628,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10244,6 +9735,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10324,6 +9821,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10404,6 +9907,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10447,6 +9956,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10548,6 +10063,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10628,6 +10149,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10664,16 +10191,18 @@

Method Details

"envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "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", + }, + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. }, "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. "seed": 42, # Seed used in decoding for reproducibility. "speechConfig": [ # Configuration for speech interaction. { # The configuration for speech interaction. @@ -10698,6 +10227,21 @@

Method Details

}, "toolChoiceMode": "A String", # The mode of the tool choice. "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "transcriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for speech recognition (transcription). If present, ASR is enabled. + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageHints": [ # Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to ["auto"] to enable automatic language detection. + "A String", + ], + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, "videoConfig": { # Configuration options for video generation. # Configuration for video generation. "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. }, @@ -10753,6 +10297,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10796,6 +10346,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10897,6 +10453,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -10977,6 +10539,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11010,6 +10578,7 @@

Method Details

], "previousInteractionId": "A String", # The ID of the previous interaction, if any. "remoteEnvironment": { # Configuration for a custom environment. + "environmentId": "A String", # Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one. "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. "allowlist": [ # List of allowed domains and their configurations. { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. @@ -11081,6 +10650,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11124,6 +10699,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11225,6 +10806,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11305,6 +10892,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11414,6 +11007,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11457,6 +11056,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11558,6 +11163,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11638,6 +11249,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11737,6 +11354,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11780,6 +11403,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11881,6 +11510,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -11961,6 +11596,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12081,6 +11722,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12124,6 +11771,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12225,6 +11878,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12305,6 +11964,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12404,6 +12069,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12447,6 +12118,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12548,6 +12225,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12628,6 +12311,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -12684,6 +12373,13 @@

Method Details

"A String", ], "role": "A String", # Output only. The role of the interaction. + "safety_settings": [ # Safety settings for the interaction. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. + "type": "A String", # Required. The type of harm category to be blocked. + }, + ], "status": "A String", # Required. Output only. The status of the interaction. "stepList": { # A list of Steps. # Input only. The steps for the interaction. "steps": [ # The steps of the list. @@ -12738,321 +12434,11 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], @@ -13097,6 +12483,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13198,6 +12590,352 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13278,6 +13016,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13374,6 +13118,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13417,6 +13167,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13518,6 +13274,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13598,6 +13360,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13714,6 +13482,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13757,6 +13531,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13858,6 +13638,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13938,6 +13724,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -13984,6 +13776,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -14002,334 +13802,72 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -14365,167 +13903,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -14537,100 +14091,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -14663,334 +14173,426 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -15026,382 +14628,15 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": "A String", # Required. The text content. }, }, ], @@ -15500,6 +14735,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -15580,6 +14821,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -15669,6 +14916,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -15712,6 +14965,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -15813,6 +15072,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -15893,6 +15158,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -15985,6 +15256,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16028,6 +15305,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16129,6 +15412,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16209,6 +15498,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16305,6 +15600,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16348,6 +15649,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16449,6 +15756,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16529,6 +15842,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16645,6 +15964,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16688,6 +16013,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16789,6 +16120,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16869,6 +16206,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -16915,6 +16258,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -16933,334 +16284,72 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -17296,167 +16385,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -17468,100 +16573,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -17594,334 +16655,71 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -17957,167 +16755,97 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -18129,101 +16857,147 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "serverName": "A String", # The name of the used MCP server. + }, + "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. }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result step. @@ -18287,6 +17061,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18330,6 +17110,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18431,6 +17217,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18511,6 +17303,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18623,6 +17421,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18666,6 +17470,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18767,6 +17577,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -18847,6 +17663,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19021,6 +17843,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19064,6 +17892,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19165,6 +17999,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19245,6 +18085,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19339,6 +18185,38 @@

Method Details

"interaction": { # Response for InteractionService.CreateInteraction. # The interaction to create. "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. "agent": "A String", # The name of the `Agent` used for generating the completion. + "antigravityConfig": { # Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration. # Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis. + "maxTotalTokens": "A String", # Max total tokens for the agent run. + "model": "A String", # The model to use for agent reasoning. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "find_request": { # Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase. # Parameters for finding vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the vulnerability analysis. + "finding_id": "A String", # The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability. + "mode": "A String", # The mode of the find session. + "source_files": [ # A list of source files to provide as context for the scan. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "fix_request": { # Request parameters specific to FIX sessions, used for generating and validating security patches. # Parameters for fixing vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the patch generation process. + "finding_id": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "source_files": [ # A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. + "session_config": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "max_rounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "session_id": "A String", # Parameter for grouping multiple interactions that belong to the same CodeMender session. + }, "deepResearchConfig": { # Configuration for the Deep Research agent. "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. @@ -19400,6 +18278,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19443,6 +18327,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19544,6 +18434,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19624,6 +18520,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19717,6 +18619,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19760,6 +18668,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19861,6 +18775,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -19941,6 +18861,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20021,6 +18947,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20064,6 +18996,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20165,6 +19103,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20245,6 +19189,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20281,16 +19231,18 @@

Method Details

"envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "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", + }, + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. }, "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. "seed": 42, # Seed used in decoding for reproducibility. "speechConfig": [ # Configuration for speech interaction. { # The configuration for speech interaction. @@ -20315,6 +19267,21 @@

Method Details

}, "toolChoiceMode": "A String", # The mode of the tool choice. "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "transcriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for speech recognition (transcription). If present, ASR is enabled. + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageHints": [ # Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to ["auto"] to enable automatic language detection. + "A String", + ], + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, "videoConfig": { # Configuration options for video generation. # Configuration for video generation. "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. }, @@ -20370,6 +19337,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20413,6 +19386,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20514,6 +19493,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20594,6 +19579,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20627,6 +19618,7 @@

Method Details

], "previousInteractionId": "A String", # The ID of the previous interaction, if any. "remoteEnvironment": { # Configuration for a custom environment. + "environmentId": "A String", # Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one. "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. "allowlist": [ # List of allowed domains and their configurations. { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. @@ -20698,6 +19690,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20741,6 +19739,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20842,6 +19846,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -20922,6 +19932,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21031,6 +20047,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21074,6 +20096,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21175,6 +20203,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21255,6 +20289,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21354,6 +20394,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21397,6 +20443,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21498,6 +20550,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21578,6 +20636,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21698,6 +20762,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21741,6 +20811,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21842,6 +20918,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -21922,6 +21004,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -22021,6 +21109,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -22064,6 +21158,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -22165,6 +21265,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -22245,6 +21351,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -22301,6 +21413,13 @@

Method Details

"A String", ], "role": "A String", # Output only. The role of the interaction. + "safety_settings": [ # Safety settings for the interaction. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. + "type": "A String", # Required. The type of harm category to be blocked. + }, + ], "status": "A String", # Required. Output only. The status of the interaction. "stepList": { # A list of Steps. # Input only. The steps for the interaction. "steps": [ # The steps of the list. @@ -22355,321 +21474,11 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], @@ -22714,6 +21523,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -22815,6 +21630,352 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -22895,6 +22056,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -22991,6 +22158,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -23034,6 +22207,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -23135,6 +22314,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -23215,6 +22400,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -23331,6 +22522,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -23374,6 +22571,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -23475,6 +22678,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -23555,6 +22764,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -23601,6 +22816,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -23619,334 +22842,72 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -23982,167 +22943,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -24154,100 +23131,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -24280,334 +23213,426 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -24643,382 +23668,15 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": "A String", # Required. The text content. }, }, ], @@ -25117,6 +23775,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25197,6 +23861,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25286,6 +23956,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25329,6 +24005,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25430,6 +24112,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25510,6 +24198,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25602,6 +24296,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25645,6 +24345,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25746,6 +24452,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25826,6 +24538,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25922,6 +24640,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -25965,6 +24689,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -26066,6 +24796,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -26146,6 +24882,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -26262,6 +25004,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -26305,6 +25053,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -26406,6 +25160,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -26486,6 +25246,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -26532,6 +25298,14 @@

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. }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, "signature": "A String", # A signature hash for backend validation. "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. @@ -26550,334 +25324,72 @@

Method Details

"fileSearchResult": { # File Search result step. }, "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -26913,167 +25425,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -27085,100 +25613,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -27211,334 +25695,71 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -27574,167 +25795,97 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -27746,101 +25897,147 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "serverName": "A String", # The name of the used MCP server. + }, + "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. }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result step. @@ -27904,6 +26101,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -27947,6 +26150,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28048,6 +26257,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28128,6 +26343,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28240,6 +26461,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28283,6 +26510,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28384,6 +26617,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28464,6 +26703,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28638,6 +26883,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28681,6 +26932,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28782,6 +27039,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28862,6 +27125,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -28952,7 +27221,7 @@

Method Details

An object of the form: { - "contentDelta": { # The content block delta data, used for content.delta events. + "contentDelta": { # The content block delta data, used for content.delta events. Legacy content-based streaming event, used when steps are disabled. "delta": { # The delta content data for a content block. "audio": { "channels": 42, # The number of audio channels. @@ -29005,6 +27274,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], }, @@ -29060,6 +27335,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29103,6 +27384,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29204,6 +27491,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29284,6 +27577,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29379,6 +27678,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29422,6 +27727,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29523,6 +27834,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29603,6 +27920,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29718,6 +28041,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29761,6 +28090,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29862,6 +28197,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -29942,6 +28283,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -30010,217 +28357,91 @@

Method Details

], }, "functionResult": { - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "isError": True or False, + "name": "A String", + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -30232,112 +28453,346 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + }, + "googleMapsResult": { + "result": [ # The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { "isError": True or False, + "result": [ + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { "name": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -30373,167 +28828,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -30545,147 +29016,249 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { - "result": [ # The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "serverName": "A String", }, - "googleSearchResult": { + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { "isError": True or False, "result": [ - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "mcpServerToolResult": { - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + }, + "video": { + "data": "A String", + "mimeType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", + }, + }, + "index": 42, + }, + "contentStart": { # The content block start data, used for content.start events. Legacy content-based streaming event, used when steps are disabled. + "content": { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -30721,266 +29294,184 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "url": "A String", # URI reference of the place. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "name": "A String", - "serverName": "A String", + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "index": 42, + }, + "contentStop": { # The content block stop data, used for content.stop events. Legacy content-based streaming event, used when steps are disabled. + "index": 42, + }, + "errorEvent": { # The error event data, used for error events. + "error": { # Error message from an interaction. + "code": "A String", # A URI that identifies the error type. + "message": "A String", # A human-readable error message. + }, + }, + "eventId": "A String", # The event_id token to be used to resume the interaction stream, from this event. + "interactionCompleteEvent": { # The interaction data, used for interaction.complete events. Legacy event, used when steps are disabled. + "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "antigravityConfig": { # Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration. # Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis. + "maxTotalTokens": "A String", # Max total tokens for the agent run. + "model": "A String", # The model to use for agent reasoning. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "find_request": { # Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase. # Parameters for finding vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the vulnerability analysis. + "finding_id": "A String", # The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability. + "mode": "A String", # The mode of the find session. + "source_files": [ # A list of source files to provide as context for the scan. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "fix_request": { # Request parameters specific to FIX sessions, used for generating and validating security patches. # Parameters for fixing vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the patch generation process. + "finding_id": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "source_files": [ # A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. + "session_config": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "max_rounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "session_id": "A String", # Parameter for grouping multiple interactions that belong to the same CodeMender session. + }, + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -31034,6 +29525,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31077,6 +29574,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31178,6 +29681,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31258,6 +29767,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -31302,83 +29817,348 @@

Method Details

], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { - "isError": True or False, - "result": [ - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + }, + "content": { # The content of the response. # The content for the interaction. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - }, - "video": { - "data": "A String", - "mimeType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", - }, - }, - "index": 42, - }, - "contentStart": { # The content block start data, used for content.start events. - "content": { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -31414,171 +30194,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -31590,83 +30384,327 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "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", }, - }, - "index": 42, - }, - "contentStop": { # The content block stop data, used for content.stop events. - "index": 42, - }, - "errorEvent": { # The error event data, used for error events. - "error": { # Error message from an interaction. - "code": "A String", # A URI that identifies the error type. - "message": "A String", # A human-readable error message. - }, - }, - "eventId": "A String", # The event_id token to be used to resume the interaction stream, from this event. - "interactionCompleteEvent": { # The interaction data, used for interaction.complete events. - "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. + }, + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "transcriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for speech recognition (transcription). If present, ASR is enabled. + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageHints": [ # Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to ["auto"] to enable automatic language detection. + "A String", + ], + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -31702,350 +30740,382 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "environmentId": "A String", # Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + "text": "A String", # Required. The text content. }, }, ], }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -32057,381 +31127,138 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, ], }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -32467,6468 +31294,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - "videoConfig": { # Configuration options for video generation. # Configuration for video generation. - "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. - }, - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. - }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -38940,228 +31484,110 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -39215,6 +31641,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -39258,6 +31690,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -39359,6 +31797,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -39410,112 +31854,461 @@

Method Details

"resolution": "A String", # The resolution of the media. "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", }, - ], - "widgetContextToken": "A String", + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -39563,6 +32356,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -39606,6 +32405,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -39707,6 +32512,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -39787,6 +32598,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -39817,30 +32634,107 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "safety_settings": [ # Safety settings for the interaction. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. + "type": "A String", # Required. The type of harm category to be blocked. + }, + ], + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -39876,167 +32770,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -40048,116 +32958,61 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. @@ -40206,6 +33061,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -40249,6 +33110,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -40350,6 +33217,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -40430,6 +33303,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -40462,275 +33341,399 @@

Method Details

}, ], }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. - "A String", - ], - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. - }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - "text": "A String", # Required. The text content. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -40766,498 +33769,329 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", - }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, - }, - "top_k": 42, # Optional. The number of contexts to retrieve. - }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", - ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. - }, - }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], }, - ], + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - }, - "interactionCompletedEvent": { # The interaction data, used for interaction.completed events. - "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. - }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. "boolValue": True or False, # Represents a boolean value. "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. @@ -41307,6 +34141,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41350,6 +34190,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -41451,941 +34297,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - "videoConfig": { # Configuration options for video generation. # Configuration for video generation. - "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. - }, - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "url": "A String", }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + ], + "widgetContextToken": "A String", + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -42421,51 +34511,326 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], + "serverName": "A String", # The name of the used MCP server. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -42494,125 +34859,315 @@

Method Details

"url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - "text": "A String", # Required. The text content. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, + "contentString": "A String", # The content of the step. A single string. }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", }, ], }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -42648,171 +35203,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -42824,85 +35393,170 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -42921,50 +35575,497 @@

Method Details

"pageNumber": 42, # Page number of the cited document, if applicable. "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -42976,238 +36077,127 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool to call. }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -43261,6 +36251,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -43304,6 +36300,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -43405,6 +36407,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -43485,6 +36493,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -43528,34 +36542,38 @@

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. + }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. "boolValue": True or False, # Represents a boolean value. "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. @@ -43605,6 +36623,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -43648,6 +36672,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -43749,6 +36779,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -43829,6 +36865,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -43870,225 +36912,120 @@

Method Details

"structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + ], + "widgetContextToken": "A String", + }, + ], + }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -44100,120 +37037,269 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], + "serverName": "A String", # The name of the used MCP server. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. @@ -44262,6 +37348,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -44305,6 +37397,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -44406,6 +37504,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -44486,6 +37590,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -44517,19 +37627,461 @@

Method Details

}, }, ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. + }, + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], + }, + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", + ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. + }, + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", + }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "top_k": 42, # Optional. The number of contexts to retrieve. }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", + ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. + }, + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. + }, + }, + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. @@ -44578,6 +38130,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -44621,6 +38179,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -44719,490 +38283,290 @@

Method Details

}, "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, + ], + }, + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + }, + "interactionCompletedEvent": { # The interaction data, used for interaction.completed events. Used when steps are enabled. + "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "antigravityConfig": { # Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration. # Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis. + "maxTotalTokens": "A String", # Max total tokens for the agent run. + "model": "A String", # The model to use for agent reasoning. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "find_request": { # Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase. # Parameters for finding vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the vulnerability analysis. + "finding_id": "A String", # The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability. + "mode": "A String", # The mode of the find session. + "source_files": [ # A list of source files to provide as context for the scan. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + ], + }, + "fix_request": { # Request parameters specific to FIX sessions, used for generating and validating security patches. # Parameters for fixing vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the patch generation process. + "finding_id": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "source_files": [ # A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + ], + }, + "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. + "session_config": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "max_rounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "session_id": "A String", # Parameter for grouping multiple interactions that belong to the same CodeMender session. + }, + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -45238,167 +38602,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -45410,1441 +38790,1388 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + ], + }, + }, + }, + "content": { # The content of the response. # The content for the interaction. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - "fileSearchResult": { # File Search result step. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + "text": "A String", # Required. The text content. }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "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", + }, + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. + }, + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "transcriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for speech recognition (transcription). If present, ASR is enabled. + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageHints": [ # Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to ["auto"] to enable automatic language detection. + "A String", + ], + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, + }, + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", + "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "environmentId": "A String", # Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, + ], + "url": "A String", # URI reference of the place. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -46880,33 +40207,300 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -46918,129 +40512,147 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -47052,22 +40664,24 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -47104,6 +40718,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -47111,565 +40731,643 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "fileSearchCall": { # File Search content. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], - "text": "A String", # Required. The text content. }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -47681,22 +41379,24 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -47733,6 +41433,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -47740,60 +41446,323 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "safety_settings": [ # Safety settings for the interaction. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. + "type": "A String", # Required. The type of harm category to be blocked. + }, + ], + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -47829,167 +41798,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -48001,139 +41986,123 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -48169,352 +42138,630 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool to call. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -48550,303 +42797,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], - "text": "A String", # Required. The text content. }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -48858,269 +42987,141 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, + "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. + "A String", ], - "widgetContextToken": "A String", }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "retrievalType": "A String", # The type of retrieval tools. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - ], + }, }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -49168,6 +43169,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -49211,6 +43218,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -49312,6 +43325,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -49392,6 +43411,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -49422,422 +43447,277 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + "url": "A String", + }, + ], + "widgetContextToken": "A String", + }, + ], + }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "fileSearchCall": { # File Search content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -49849,257 +43729,461 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "serverName": "A String", # The name of the used MCP server. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. - "A String", - ], - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -50147,6 +44231,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -50190,6 +44280,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -50291,421 +44387,223 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", - }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, - }, - "top_k": 42, # Optional. The number of contexts to retrieve. - }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", - ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. - }, - }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -50717,208 +44615,82 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], }, - ], - }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - }, - "interactionCreatedEvent": { # The interaction data, used for interaction.created events. - "interaction": { # Response for InteractionService.CreateInteraction. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. - }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -50955,6 +44727,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -50962,1012 +44740,849 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "fileSearchCall": { # File Search call step. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - "url": "A String", # URI reference of the place. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], - "text": "A String", # Required. The text content. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + ], }, + "name": "A String", # Required. The name of the tool to call. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - "videoConfig": { # Configuration options for video generation. # Configuration for video generation. - "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. - }, - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, - ], - "url": "A String", # URI reference of the place. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + }, ], }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. + "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. "A String", ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + "retrievalType": "A String", # The type of retrieval tools. }, "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. + "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. "urls": [ # The URLs to fetch. "A String", @@ -51975,91 +45590,378 @@

Method Details

}, }, }, - "toolResult": { # Tool result content. + "toolResult": { # Tool result step. "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. + "codeExecutionResult": { # Code execution result step. "isError": True or False, # Whether the code execution resulted in an error. "result": "A String", # Required. The output of the code execution. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], + "fileSearchResult": { # File Search result step. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. + "googleMapsResult": { # Google Maps result step. + "result": [ { # The result of the Google Maps. - "places": [ # The places that were found. + "places": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. + "url": "A String", }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "widgetContextToken": "A String", }, ], }, - "googleSearchResult": { # Google Search result content. + "googleSearchResult": { # Google Search result step. "isError": True or False, # Whether the Google Search resulted in an error. "result": [ # Required. The results of the Google Search. { # The result of the Google Search. @@ -52067,387 +45969,353 @@

Method Details

}, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "mcpServerToolResult": { # MCPServer tool result step. + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "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. }, "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. + "urlContextResult": { # URL context result step. "isError": True or False, # Whether the URL context resulted in an error. "result": [ # Required. The results of the URL context. { # The result of the URL context. @@ -52457,76 +46325,236 @@

Method Details

], }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -52538,18 +46566,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -52586,6 +46618,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -52593,576 +46631,486 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, ], }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. + }, + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], + }, + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", + ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. + }, + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], + "text": "A String", # Required. The text content. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. + }, + }, + "top_k": 42, # Optional. The number of contexts to retrieve. + }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", + ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. + }, + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -53210,6 +47158,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -53253,6 +47207,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -53354,6 +47314,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -53434,6 +47400,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -53464,22 +47436,98 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + }, + "interactionCreatedEvent": { # The interaction data, used for interaction.created events. Used when steps are enabled. + "interaction": { # Response for InteractionService.CreateInteraction. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "antigravityConfig": { # Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration. # Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis. + "maxTotalTokens": "A String", # Max total tokens for the agent run. + "model": "A String", # The model to use for agent reasoning. }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "codeMenderConfig": { # Configuration for the CodeMender agent. + "find_request": { # Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase. # Parameters for finding vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the vulnerability analysis. + "finding_id": "A String", # The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability. + "mode": "A String", # The mode of the find session. + "source_files": [ # A list of source files to provide as context for the scan. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "fix_request": { # Request parameters specific to FIX sessions, used for generating and validating security patches. # Parameters for fixing vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the patch generation process. + "finding_id": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "source_files": [ # A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. + "session_config": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "max_rounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "session_id": "A String", # Parameter for grouping multiple interactions that belong to the same CodeMender session. + }, + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -53533,6 +47581,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -53576,6 +47630,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -53677,6 +47737,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -53757,6 +47823,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -53800,38 +47872,263 @@

Method Details

}, ], }, - }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + }, + }, + "content": { # The content of the response. # The content for the interaction. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -53867,287 +48164,106 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, + ], + "url": "A String", # URI reference of the place. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, + "text": "A String", # Required. The text content. }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -54183,167 +48299,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -54355,785 +48487,822 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "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", + }, + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. + }, + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "transcriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for speech recognition (transcription). If present, ASR is enabled. + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageHints": [ # Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to ["auto"] to enable automatic language detection. + "A String", + ], + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, + }, + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "environmentId": "A String", # Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool to call. }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + }, + ], }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - }, + ], }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -55181,6 +49350,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -55224,6 +49399,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -55325,6 +49506,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -55405,6 +49592,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -55435,397 +49628,622 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, - "searchType": "A String", # The type of search grounding enabled. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "url": "A String", }, - ], - "widgetContextToken": "A String", + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, ], }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -55837,18 +50255,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -55885,559 +50307,64 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -56485,6 +50412,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -56528,6 +50461,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -56590,62 +50529,627 @@

Method Details

}, ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "safety_settings": [ # Safety settings for the interaction. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. + "type": "A String", # Required. The type of harm category to be blocked. + }, + ], + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -56657,174 +51161,141 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "fileSearchCall": { # File Search content. }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -56836,77 +51307,125 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -56942,367 +51461,335 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, }, - ], - "text": "A String", # Required. The text content. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -57338,469 +51825,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -57812,259 +52015,141 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -58112,6 +52197,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -58155,6 +52246,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -58256,6 +52353,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -58336,6 +52439,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -58366,366 +52475,51 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "url": "A String", }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "widgetContextToken": "A String", }, ], }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -58773,6 +52567,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -58816,6 +52616,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -58917,6 +52723,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -58931,518 +52743,9 @@

Method Details

}, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -59454,257 +52757,461 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "serverName": "A String", # The name of the used MCP server. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, - "contentString": "A String", # The content of the step. A single string. }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. - "A String", - ], - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. - }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -59752,6 +53259,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -59795,6 +53308,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -59896,6 +53415,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -59976,6 +53501,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -60006,158 +53537,377 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "top_k": 42, # Optional. The number of contexts to retrieve. - }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", - ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. - }, - }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "fileSearchCall": { # File Search content. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -60193,171 +53943,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -60369,262 +54133,193 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - }, - "interactionStartEvent": { # The interaction data, used for interaction.start events. - "interaction": { # Response for InteractionService.CreateInteraction. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. - }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -60661,6 +54356,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -60668,281 +54369,281 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - }, - ], + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "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. + "A String", ], - "text": "A String", # Required. The text content. }, + "retrievalType": "A String", # The type of retrieval tools. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "fileSearchResult": { # File Search result step. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -60978,174 +54679,341 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + }, + ], }, - ], - "text": "A String", # Required. The text content. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", + }, + ], + "widgetContextToken": "A String", + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + "mcpServerToolResult": { # MCPServer tool result step. + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -61181,171 +55049,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -61355,474 +55237,498 @@

Method Details

"url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "serverName": "A String", # The name of the used MCP server. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. + "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. }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - "videoConfig": { # Configuration options for video generation. # Configuration for video generation. - "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. - }, - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "contentString": "A String", # The content of the step. A single string. }, }, ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", + ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -61858,91 +55764,185 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -61954,184 +55954,417 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", + }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. }, - ], + }, + "top_k": 42, # Optional. The number of contexts to retrieve. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -62143,18 +56376,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -62191,6 +56428,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62198,117 +56441,207 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + }, + "interactionStartEvent": { # The interaction data, used for interaction.start events. Legacy event, used when steps are disabled. + "interaction": { # Response for InteractionService.CreateInteraction. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "antigravityConfig": { # Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration. # Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis. + "maxTotalTokens": "A String", # Max total tokens for the agent run. + "model": "A String", # The model to use for agent reasoning. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "find_request": { # Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase. # Parameters for finding vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the vulnerability analysis. + "finding_id": "A String", # The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability. + "mode": "A String", # The mode of the find session. + "source_files": [ # A list of source files to provide as context for the scan. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "fix_request": { # Request parameters specific to FIX sessions, used for generating and validating security patches. # Parameters for fixing vulnerabilities. + "description": "A String", # Additional context or custom instructions provided by the user to guide the patch generation process. + "finding_id": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "source_files": [ # A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability. + { # Content of a single file in the codebase. + "content": "A String", # The UTF-8 encoded text content of the file. + "path": "A String", # The relative path of the file from the project root. + }, + ], + }, + "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. + "session_config": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "max_rounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "session_id": "A String", # Parameter for grouping multiple interactions that belong to the same CodeMender session. + }, + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -62320,141 +56653,141 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "fileSearchCall": { # File Search content. }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -62466,18 +56799,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -62514,6 +56851,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -62521,265 +56864,299 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + }, + "content": { # The content of the response. # The content for the interaction. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, + ], + "url": "A String", # URI reference of the place. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. - }, + ], }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -62815,167 +57192,232 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -62987,968 +57429,939 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "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", + }, + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. + }, + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "transcriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for speech recognition (transcription). If present, ASR is enabled. + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageHints": [ # Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to ["auto"] to enable automatic language detection. + "A String", + ], + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "url": "A String", # URI reference of the place. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, + }, + ], + "text": "A String", # Required. The text content. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # Configuration for video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # The delivery mode for the video output. - "duration": "A String", # The duration for the video output. - "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "environmentId": "A String", # Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "a_key": "", # Properties of the object. Contains field @type with type URL. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -63960,22 +58373,24 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -64012,6 +58427,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -64019,419 +58440,123 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "fileSearchCall": { # File Search content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -64443,18 +58568,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -64491,6 +58620,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -64498,117 +58633,131 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -64620,179 +58769,450 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + }, + ], }, }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -64829,6 +59249,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -64836,234 +59262,198 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - "text": "A String", # Required. The text content. + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + "text": "A String", # Required. The text content. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -65099,167 +59489,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -65271,166 +59677,653 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "safety_settings": [ # Safety settings for the interaction. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. + "type": "A String", # Required. The type of harm category to be blocked. + }, + ], + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", }, ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -65442,18 +60335,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -65490,6 +60387,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -65497,216 +60400,42 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], }, - ], + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -65760,6 +60489,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -65803,6 +60538,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -65904,6 +60645,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -65984,6 +60731,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -66027,491 +60780,44 @@

Method Details

}, ], }, + "name": "A String", # Required. The name of the tool to call. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -66547,286 +60853,391 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, }, - ], - "text": "A String", # Required. The text content. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, ], + "text": "A String", # Required. The text content. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -66863,6 +61274,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -66870,16 +61287,298 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", + }, + ], + "widgetContextToken": "A String", + }, + ], + }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -66891,22 +61590,24 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -66935,94 +61636,144 @@

Method Details

"title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -67034,18 +61785,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -67082,6 +61837,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -67089,280 +61850,285 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "serverName": "A String", # The name of the used MCP server. + }, + "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. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "fileSearchCall": { # File Search content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -67374,18 +62140,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -67422,6 +62192,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -67429,278 +62205,267 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -67712,18 +62477,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -67760,6 +62529,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -67767,216 +62542,382 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], + "text": "A String", # Required. The text content. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - "text": "A String", # Required. The text content. + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -68030,6 +62971,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -68073,6 +63020,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -68174,6 +63127,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -68249,395 +63208,80 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -68691,6 +63335,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -68734,6 +63384,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -68835,6 +63491,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -68915,6 +63577,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -68958,22 +63626,40 @@

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. + }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. }, "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -69021,6 +63707,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -69064,6 +63756,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -69165,6 +63863,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -69245,6 +63949,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -69275,437 +63985,404 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. - "A String", - ], - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. - }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", }, ], + "widgetContextToken": "A String", }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + ], + }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "text": "A String", # Required. The text content. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", - }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, + "serverName": "A String", # The name of the used MCP server. }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, + "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. }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "top_k": 42, # Optional. The number of contexts to retrieve. - }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. "contents": [ # The contents of the list. { # The content of the response. "audio": { # An audio content block. @@ -69755,6 +64432,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -69798,6 +64481,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -69899,6 +64588,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -69979,6 +64674,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -70011,192 +64712,265 @@

Method Details

}, ], }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. + "contentString": "A String", # The content of the step. A single string. }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - }, - "interactionStatusUpdate": { # The interaction status data, used for interaction.status_update events. - "interactionId": "A String", - "status": "A String", - }, - "metadata": { # Optional metadata accompanying ANY streamed event. - "totalUsage": { # Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. }, ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - "stepDelta": { # The step delta data, used for step.delta events. - "delta": { - "argumentsDelta": { - "arguments": "A String", - }, - "audio": { - "channels": 42, # The number of audio channels. - "data": "A String", - "mimeType": "A String", - "rate": 42, # Deprecated. Use sample_rate instead. The value is ignored. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", - }, - "document": { - "data": "A String", - "mimeType": "A String", - "uri": "A String", - }, - "functionResult": { - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. + }, + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], + }, + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", + ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. + }, + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -70208,234 +64982,191 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", + }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + ], + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. + }, }, + "top_k": 42, # Optional. The number of contexts to retrieve. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - ], + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", + ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. + }, + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. + }, }, - "isError": True or False, - "name": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -70483,6 +65214,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -70526,6 +65263,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -70627,6 +65370,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -70707,6 +65456,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -70737,481 +65492,289 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "image": { - "data": "A String", - "mimeType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], }, - "serverToolCall": { - "codeExecutionCall": { - "arguments": { # The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + }, + "interactionStatusUpdate": { # The interaction status data, used for interaction.status_update events. + "interactionId": "A String", + "status": "A String", + }, + "metadata": { # Optional metadata accompanying ANY streamed event. + "totalUsage": { # Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. }, - "fileSearchCall": { + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. }, - "googleMapsCall": { - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. }, - "googleSearchCall": { - "arguments": { # The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. }, - "mcpServerToolCall": { - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + "stepDelta": { # The step delta data, used for step.delta events. Step-based streaming event, used when steps are enabled. + "delta": { + "argumentsDelta": { + "arguments": "A String", + }, + "audio": { + "channels": 42, # The number of audio channels. + "data": "A String", + "mimeType": "A String", + "rate": 42, # Deprecated. Use sample_rate instead. The value is ignored. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", + }, + "document": { + "data": "A String", + "mimeType": "A String", + "uri": "A String", + }, + "functionResult": { + "isError": True or False, + "name": "A String", + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", - "serverName": "A String", - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { - "arguments": { # The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "serverToolResult": { - "codeExecutionResult": { - "isError": True or False, - "result": "A String", - }, - "fileSearchResult": { - "result": [ - { # The result of the File Search. - }, - ], - }, - "googleMapsResult": { - "result": [ # The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { - "isError": True or False, - "result": [ - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -71248,6 +65811,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -71255,216 +65824,157 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - "name": "A String", - "serverName": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "image": { + "data": "A String", + "mimeType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", + }, + "serverToolCall": { + "codeExecutionCall": { + "arguments": { # The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { + }, + "googleMapsCall": { + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { + "arguments": { # The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + }, + "mcpServerToolCall": { + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -71518,6 +66028,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -71561,6 +66077,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -71662,6 +66184,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -71742,6 +66270,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -71785,6 +66319,410 @@

Method Details

}, ], }, + "name": "A String", + "serverName": "A String", + }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { + "arguments": { # The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "serverToolResult": { + "codeExecutionResult": { + "isError": True or False, + "result": "A String", + }, + "fileSearchResult": { + "result": [ + { # The result of the File Search. + }, + ], + }, + "googleMapsResult": { + "result": [ # The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { + "isError": True or False, + "result": [ + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { + "name": "A String", + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "serverName": "A String", + }, + "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. }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { @@ -71829,6 +66767,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], }, @@ -71884,6 +66828,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -71927,6 +66877,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -72028,6 +66984,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -72108,6 +67070,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -72148,7 +67116,7 @@

Method Details

}, "index": 42, }, - "stepStart": { # The step start data, used for step.start events. + "stepStart": { # The step start data, used for step.start events. Step-based streaming event, used when steps are enabled. "index": 42, "step": { # A step in the interaction. "modelOutput": { # Output generated by the model. @@ -72201,6 +67169,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -72244,6 +67218,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -72345,6 +67325,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -72425,6 +67411,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -72517,6 +67509,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -72560,6 +67558,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -72655,475 +67659,147 @@

Method Details

}, ], "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "fileSearchCall": { # File Search call step. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -73177,6 +67853,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -73220,6 +67902,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -73321,460 +68009,161 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -73828,6 +68217,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -73871,6 +68266,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -73972,23 +68373,448 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "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. + "A String", + ], + }, + "retrievalType": "A String", # The type of retrieval tools. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -74000,100 +68826,56 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, "googleMapsResult": { # Google Maps result step. @@ -74126,334 +68908,71 @@

Method Details

], }, "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -74489,167 +69008,183 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -74661,101 +69196,61 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "serverName": "A String", # The name of the used MCP server. + }, + "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. }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result step. @@ -74819,6 +69314,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -74862,6 +69363,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -74963,6 +69470,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -75043,6 +69556,12 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], "text": "A String", # Required. The text content. @@ -75079,7 +69598,7 @@

Method Details

}, }, }, - "stepStop": { # The step stop data, used for step.stop events. + "stepStop": { # The step stop data, used for step.stop events. Step-based streaming event, used when steps are enabled. "index": 42, "stepUsage": { # Statistics on the interaction request's token usage. # Model usage stats for this specific step. "cachedTokensByModality": [ # A breakdown of cached token usage by modality. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html index 0e729efad6..80b7016728 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html @@ -87,10 +87,179 @@

Instance Methods

close()

Close httplib2 connections.

+

+ ingestEvents(parent, body=None, x__xgafv=None)

+

Ingests events for a Memory Bank.

Method Details

close()
Close httplib2 connections.
+
+ ingestEvents(parent, body=None, x__xgafv=None) +
Ingests events for a Memory Bank.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.IngestEvents.
+  "directContentsSource": { # Ingest events directly from the request. # Ingest events directly from the request.
+    "events": [ # Required. The events to ingest.
+      { # A single event to ingest.
+        "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event.
+          "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+            { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+              "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data.
+                "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set.
+                "text": "A String", # Required. The transcription text of this audio segment.
+                "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set.
+                  { # Information about a single recognized word.
+                    "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio.
+                    "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio.
+                    "word": "A String", # Required. Transcript of the word.
+                  },
+                ],
+              },
+              "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+                "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.
+                "outcome": "A String", # Required. Outcome of the code execution.
+                "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+              },
+              "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                "code": "A String", # Required. The code to be executed.
+                "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.
+                "language": "A String", # Required. Programming language of the `code`.
+              },
+              "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                  "a_key": "", # Properties of the object.
+                },
+                "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+                "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                  { # Partial argument value of the function call.
+                    "boolValue": True or False, # Optional. Represents a boolean value.
+                    "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                    "nullValue": "A String", # Optional. Represents a null value.
+                    "numberValue": 3.14, # Optional. Represents a double value.
+                    "stringValue": "A String", # Optional. Represents a string value.
+                    "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                  },
+                ],
+                "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+              },
+              "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+                "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                  { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                    "fileData": { # URI based data for function response. # URI based data.
+                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "fileUri": "A String", # Required. URI.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                      "data": "A String", # Required. Raw bytes.
+                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                  },
+                ],
+                "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                  "a_key": "", # Properties of the object.
+                },
+                "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+              },
+              "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                "data": "A String", # Required. The raw bytes of the data.
+                "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+                "level": "A String", # The tokenization quality used for given media.
+              },
+              "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+              "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+              "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+              "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                "endOffset": "A String", # Optional. The end offset of the video.
+                "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                "startOffset": "A String", # Optional. The start offset of the video.
+              },
+            },
+          ],
+          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+        },
+        "eventId": "A String", # Optional. A unique identifier for the event. If an event with the same event_id is ingested multiple times, it will be de-duplicated.
+        "eventTime": "A String", # Optional. The time at which the event occurred. If provided, this timestamp will be used for ordering events within a stream. If not provided, the server-side ingestion time will be used.
+      },
+    ],
+  },
+  "disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request.
+  "forceFlush": True or False, # Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`.
+  "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately.
+    "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately.
+      "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit.
+      "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity.
+      "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.
+      "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window.
+    },
+  },
+  "metadata": { # Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "metadataMergeStrategy": "A String", # Optional. The strategy to use when applying metadata to existing memories.
+  "revisionExpireTime": "A String", # Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. The TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. The scope of the memories that should be generated from the stream. Memories will be consolidated across memories with the same scope. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "streamId": "A String", # Optional. The ID of the stream to ingest events into. If not provided, a new one will be created.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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.memoryBanks.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html index ad896ad82b..02aacf7f45 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html @@ -79,18 +79,347 @@

Instance Methods

Returns the operations Resource.

+

+ revisions() +

+

Returns the revisions Resource.

+

close()

Close httplib2 connections.

+

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

+

Create a Memory.

+

+ delete(name, x__xgafv=None)

+

Delete a Memory.

+

+ generate(parent, body=None, x__xgafv=None)

+

Generate memories.

get(name, x__xgafv=None)

Get a Memory.

+

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

+

List Memories.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a Memory.

+

+ purge(parent, body=None, x__xgafv=None)

+

Purge memories.

+

+ retrieve(parent, body=None, x__xgafv=None)

+

Retrieve memories.

+

+ retrieveProfiles(parent, body=None, x__xgafv=None)

+

Retrieves profiles.

+

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

+

Rollback Memory to a specific revision.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, memoryId=None, x__xgafv=None) +
Create a Memory.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A memory.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+  "description": "A String", # Optional. Represents the description of the Memory.
+  "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+  "displayName": "A String", # Optional. Represents the display name of the Memory.
+  "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+  "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+  "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided.
+  "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+  "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory.
+    "data": { # Required. Represents the structured value of the memory.
+      "a_key": "", # Properties of the object.
+    },
+    "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to.
+  },
+  "topics": [ # Optional. Represents the Topics of the Memory.
+    { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+    },
+  ],
+  "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+}
+
+  memoryId: string, Optional. The user defined ID to use for memory, which will become the final component of the memory 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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete a Memory.
+
+Args:
+  name: string, Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ generate(parent, body=None, x__xgafv=None) +
Generate memories.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB.
+  "allowedTopics": [ # Optional. Restricts memory generation to a subset of memory topics.
+    { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+    },
+  ],
+  "directContentsSource": { # Defines a direct source of content from which to generate the memories. # Defines a direct source of content as the source content from which to generate memories.
+    "events": [ # Required. The source content (i.e. chat history) to generate memories from.
+      { # A single piece of conversation from which to generate memories.
+        "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single piece of content from which to generate memories.
+          "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+            { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+              "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data.
+                "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set.
+                "text": "A String", # Required. The transcription text of this audio segment.
+                "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set.
+                  { # Information about a single recognized word.
+                    "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio.
+                    "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio.
+                    "word": "A String", # Required. Transcript of the word.
+                  },
+                ],
+              },
+              "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+                "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.
+                "outcome": "A String", # Required. Outcome of the code execution.
+                "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+              },
+              "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                "code": "A String", # Required. The code to be executed.
+                "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.
+                "language": "A String", # Required. Programming language of the `code`.
+              },
+              "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                  "a_key": "", # Properties of the object.
+                },
+                "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+                "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                  { # Partial argument value of the function call.
+                    "boolValue": True or False, # Optional. Represents a boolean value.
+                    "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                    "nullValue": "A String", # Optional. Represents a null value.
+                    "numberValue": 3.14, # Optional. Represents a double value.
+                    "stringValue": "A String", # Optional. Represents a string value.
+                    "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                  },
+                ],
+                "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+              },
+              "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+                "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                  { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                    "fileData": { # URI based data for function response. # URI based data.
+                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "fileUri": "A String", # Required. URI.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                      "data": "A String", # Required. Raw bytes.
+                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                  },
+                ],
+                "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                  "a_key": "", # Properties of the object.
+                },
+                "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+              },
+              "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                "data": "A String", # Required. The raw bytes of the data.
+                "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+                "level": "A String", # The tokenization quality used for given media.
+              },
+              "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+              "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+              "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+              "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                "endOffset": "A String", # Optional. The end offset of the video.
+                "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                "startOffset": "A String", # Optional. The start offset of the video.
+              },
+            },
+          ],
+          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+        },
+      },
+    ],
+  },
+  "directMemoriesSource": { # Defines a direct source of memories that should be uploaded to Memory Bank with consolidation. # Defines a direct source of memories that should be uploaded to Memory Bank. This is similar to `CreateMemory`, but it allows for consolidation between these new memories and existing memories for the same scope.
+    "directMemories": [ # Required. The direct memories to upload to Memory Bank. At most 5 direct memories are allowed per request.
+      { # A direct memory to upload to Memory Bank.
+        "fact": "A String", # Required. The fact to consolidate with existing memories.
+        "topics": [ # Optional. The topics that the consolidated memories should be associated with.
+          { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+            "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+            "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+          },
+        ],
+      },
+    ],
+  },
+  "disableConsolidation": True or False, # Optional. If true, generated memories will not be consolidated with existing memories; all generated memories will be added as new memories regardless of whether they are duplicates of or contradictory to existing memories. By default, memory consolidation is enabled.
+  "disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request.
+  "metadata": { # Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "metadataMergeStrategy": "A String", # Optional. The strategy to use when applying metadata to existing memories.
+  "revisionExpireTime": "A String", # Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. The TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "vertexSessionSource": { # Defines an Agent Engine Session from which to generate the memories. If `scope` is not provided, the scope will be extracted from the Session (i.e. {"user_id": sesison.user_id}). # Defines a Vertex Session as the source content from which to generate memories.
+    "endTime": "A String", # Optional. End time (exclusive) of the time range. If not set, the end time is unbounded.
+    "session": "A String", # Required. The resource name of the Session to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`
+    "startTime": "A String", # Optional. Time range to define which session events should be used to generate memories. Start time (inclusive) of the time range. If not set, the start time is unbounded.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
get(name, x__xgafv=None)
Get a Memory.
@@ -147,4 +476,402 @@ 

Method Details

}
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
List Memories.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`)
+  orderBy: string, Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`
+  pageSize: integer, Optional. The standard list page size.
+  pageToken: string, Optional. The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for MemoryBankService.ListMemories.
+  "memories": [ # List of Memories in the requested page.
+    { # A memory.
+      "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+      "description": "A String", # Optional. Represents the description of the Memory.
+      "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+      "displayName": "A String", # Optional. Represents the display name of the Memory.
+      "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+      "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+      "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided.
+      "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+        "a_key": { # Memory metadata.
+          "boolValue": True or False, # Represents a boolean value.
+          "doubleValue": 3.14, # Represents a double value.
+          "stringValue": "A String", # Represents a string value.
+          "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+        },
+      },
+      "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+      "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+      "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+        "a_key": "A String",
+      },
+      "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+      "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+        "a_key": "A String",
+      },
+      "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory.
+        "data": { # Required. Represents the structured value of the memory.
+          "a_key": "", # Properties of the object.
+        },
+        "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to.
+      },
+      "topics": [ # Optional. Represents the Topics of the Memory.
+        { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+          "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+          "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+        },
+      ],
+      "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+      "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListMemoriesRequest.page_token to obtain that page.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update a Memory.
+
+Args:
+  name: string, Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A memory.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+  "description": "A String", # Optional. Represents the description of the Memory.
+  "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+  "displayName": "A String", # Optional. Represents the display name of the Memory.
+  "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+  "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+  "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided.
+  "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+  "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory.
+    "data": { # Required. Represents the structured value of the memory.
+      "a_key": "", # Properties of the object.
+    },
+    "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to.
+  },
+  "topics": [ # Optional. Represents the Topics of the Memory.
+    { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+    },
+  ],
+  "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+}
+
+  updateMask: string, Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ purge(parent, body=None, x__xgafv=None) +
Purge memories.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.PurgeMemories.
+  "filter": "A String", # Required. The standard list filter to determine which memories to purge. More detail in [AIP-160](https://google.aip.dev/160).
+  "filterGroups": [ # Optional. Metadata filters that will be applied to the memories to be purged. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`.
+    { # A conjunction of filters that will be combined using AND logic.
+      "filters": [ # Represents filters that will be combined using AND logic.
+        { # Filter to apply when retrieving memories.
+          "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author".
+          "negate": True or False, # Indicates whether the filter will be negated.
+          "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used.
+          "value": { # Memory metadata. # Represents the value to compare to.
+            "boolValue": True or False, # Represents a boolean value.
+            "doubleValue": 3.14, # Represents a double value.
+            "stringValue": "A String", # Represents a string value.
+            "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+          },
+        },
+      ],
+    },
+  ],
+  "force": True or False, # Optional. If true, the memories will actually be purged. If false, the purge request will be validated but not executed.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ retrieve(parent, body=None, x__xgafv=None) +
Retrieve memories.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.RetrieveMemories.
+  "filter": "A String", # Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time` * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`)
+  "filterGroups": [ # Optional. Metadata filters that will be applied to the retrieved memories' `metadata` using OR logic. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`.
+    { # A conjunction of filters that will be combined using AND logic.
+      "filters": [ # Represents filters that will be combined using AND logic.
+        { # Filter to apply when retrieving memories.
+          "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author".
+          "negate": True or False, # Indicates whether the filter will be negated.
+          "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used.
+          "value": { # Memory metadata. # Represents the value to compare to.
+            "boolValue": True or False, # Represents a boolean value.
+            "doubleValue": 3.14, # Represents a double value.
+            "stringValue": "A String", # Represents a string value.
+            "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+          },
+        },
+      ],
+    },
+  ],
+  "memoryTypes": [ # Optional. Specifies the types of memories to retrieve. If this field is empty or not provided, the request will default to retrieving only memories of type `NATURAL_LANGUAGE_COLLECTION`. If populated, the request will retrieve memories matching any of the specified `MemoryType` values.
+    "A String",
+  ],
+  "scope": { # Required. The scope of the memories to retrieve. A memory must have exactly the same scope (`Memory.scope`) as the scope provided here to be retrieved (same keys and values). Order does not matter, but it is case-sensitive.
+    "a_key": "A String",
+  },
+  "similaritySearchParams": { # Parameters for semantic similarity search based retrieval. # Parameters for semantic similarity search based retrieval.
+    "searchQuery": "A String", # Required. Query to use for similarity search retrieval. If provided, then the parent ReasoningEngine must have ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig set.
+    "topK": 42, # Optional. The maximum number of memories to return. The service may return fewer than this value. If unspecified, at most 3 memories will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  },
+  "simpleRetrievalParams": { # Parameters for simple (non-similarity search) retrieval. # Parameters for simple (non-similarity search) retrieval.
+    "pageSize": 42, # Optional. The maximum number of memories to return. The service may return fewer than this value. If unspecified, at most 3 memories will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+    "pageToken": "A String", # Optional. A page token, received from a previous `RetrieveMemories` call. Provide this to retrieve the subsequent page.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for MemoryBankService.RetrieveMemories.
+  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. This token is not set if similarity search was used for retrieval.
+  "retrievedMemories": [ # The retrieved memories.
+    { # A retrieved memory.
+      "distance": 3.14, # The distance between the query and the retrieved Memory. Smaller values indicate more similar memories. This is only set if similarity search was used for retrieval.
+      "memory": { # A memory. # The retrieved Memory.
+        "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+        "description": "A String", # Optional. Represents the description of the Memory.
+        "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+        "displayName": "A String", # Optional. Represents the display name of the Memory.
+        "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+        "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+        "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided.
+        "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+          "a_key": { # Memory metadata.
+            "boolValue": True or False, # Represents a boolean value.
+            "doubleValue": 3.14, # Represents a double value.
+            "stringValue": "A String", # Represents a string value.
+            "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+          },
+        },
+        "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+        "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+        "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+          "a_key": "A String",
+        },
+        "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+        "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+          "a_key": "A String",
+        },
+        "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory.
+          "data": { # Required. Represents the structured value of the memory.
+            "a_key": "", # Properties of the object.
+          },
+          "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to.
+        },
+        "topics": [ # Optional. Represents the Topics of the Memory.
+          { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+            "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+            "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+          },
+        ],
+        "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+        "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+      },
+    },
+  ],
+}
+
+ +
+ retrieveProfiles(parent, body=None, x__xgafv=None) +
Retrieves profiles.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.RetrieveProfiles.
+  "scope": { # Required. The scope of the profiles to retrieve.
+    "a_key": "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 MemoryBankService.RetrieveProfiles.
+  "profiles": { # The retrieved structured profiles, which match the schemas under the requested scope. The key is the ID of the schema that the profile is linked with, which corresponds to the `schema_id` defined inside the `SchemaConfig`, under `StructuredMemoryCustomizationConfig`.
+    "a_key": { # A memory profile.
+      "profile": { # Represents the profile data.
+        "a_key": "", # Properties of the object.
+      },
+      "schemaId": "A String", # Represents the ID of the schema. This ID corresponds to the `schema_id` defined inside the SchemaConfig, under StructuredMemoryCustomizationConfig.
+    },
+  },
+}
+
+ +
+ rollback(name, body=None, x__xgafv=None) +
Rollback Memory to a specific revision.
+
+Args:
+  name: string, Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.RollbackMemory.
+  "targetRevisionId": "A String", # Required. The ID of the revision to rollback to.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.revisions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.revisions.html new file mode 100644 index 0000000000..0215fa59d9 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.revisions.html @@ -0,0 +1,191 @@ + + + +

Agent Platform API . projects . locations . memoryBanks . memories . revisions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a Memory Revision.

+

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

+

List Memory Revisions for a Memory.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get a Memory Revision.
+
+Args:
+  name: string, Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A revision of a Memory.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory Revision was created.
+  "expireTime": "A String", # Output only. Represents the timestamp of when this resource is considered expired.
+  "extractedMemories": [ # Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.
+    { # An extracted memory that is the intermediate result before consolidation.
+      "context": "A String", # Output only. Represents the explanation of why the information was extracted from the source content.
+      "fact": "A String", # Output only. Represents the fact of the extracted memory.
+      "structuredData": { # Output only. Represents the structured value of the extracted memory.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  ],
+  "fact": "A String", # Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.
+  "labels": { # Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`
+  "structuredData": { # Output only. Represents the structured value of the memory at the time of revision creation.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
List Memory Revisions for a Memory.
+
+Args:
+  parent: string, Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`
+  pageSize: integer, Optional. The standard list page size.
+  pageToken: string, Optional. The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for MemoryBankService.ListMemoryRevisions.
+  "memoryRevisions": [ # The list of Memory Revisions in the request page.
+    { # A revision of a Memory.
+      "createTime": "A String", # Output only. Represents the timestamp when this Memory Revision was created.
+      "expireTime": "A String", # Output only. Represents the timestamp of when this resource is considered expired.
+      "extractedMemories": [ # Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.
+        { # An extracted memory that is the intermediate result before consolidation.
+          "context": "A String", # Output only. Represents the explanation of why the information was extracted from the source content.
+          "fact": "A String", # Output only. Represents the fact of the extracted memory.
+          "structuredData": { # Output only. Represents the structured value of the extracted memory.
+            "a_key": "", # Properties of the object.
+          },
+        },
+      ],
+      "fact": "A String", # Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.
+      "labels": { # Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`
+      "structuredData": { # Output only. Represents the structured value of the memory at the time of revision creation.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.models.html index 709826056f..4a8a2e7eef 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.models.html @@ -348,7 +348,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -726,7 +726,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -1115,7 +1115,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -1492,7 +1492,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -1824,7 +1824,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -2155,7 +2155,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -2630,7 +2630,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.analyzedInvocations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.analyzedInvocations.html index 98c2b49876..54551dc604 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.analyzedInvocations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.analyzedInvocations.html @@ -106,8 +106,8 @@

Method Details

Returns: An object of the form: - { # An analyzed invocation for monitored agent's session. - "assessment": { # Detailed assessment for an analyzed session. # Output only. The assessment of the invocation. + { # Represents an analyzed invocation for a monitored agent's session. + "assessment": { # Contains the detailed assessment for an analyzed session. # Output only. The assessment of the invocation. "detectorFindings": [ # The list of detector findings. { # The details of a detector's assessment within an analyzed session. "detectorId": "A String", # The detector ID. @@ -145,8 +145,8 @@

Method Details

{ # Response to list analyzed invocations. "analyzedInvocations": [ # The list of analyzed invocations. - { # An analyzed invocation for monitored agent's session. - "assessment": { # Detailed assessment for an analyzed session. # Output only. The assessment of the invocation. + { # Represents an analyzed invocation for a monitored agent's session. + "assessment": { # Contains the detailed assessment for an analyzed session. # Output only. The assessment of the invocation. "detectorFindings": [ # The list of detector findings. { # The details of a detector's assessment within an analyzed session. "detectorId": "A String", # The detector ID. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.html index 2f55b47ca6..2358270062 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.html @@ -104,7 +104,7 @@

Method Details

Args: parent: string, Required. The parent MonitoredAgent resource. Use the `-` wildcard for the monitored_agent segment to aggregate across multiple agents in the location. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}` (required) - filter: string, Optional. Filter expression restricting which AnalyzedSessions are included in the aggregation. Uses a subset of the `ListAnalyzedSessionsRequest.filter` grammar: a closed `detection_time` window with both bounds required, e.g. detection_time >= "2024-01-01T00:00:00Z" AND detection_time <= "2024-01-08T00:00:00Z" The `severity` clause supported on ListAnalyzedSessions is intentionally rejected here: this response groups by severity (one entry per bucket per agent), so a severity filter would collapse the rollup to a single bucket and produce a misleading per-agent view. If empty, the aggregation covers the last 3 days. + filter: string, Optional. Filter expression restricting which AnalyzedSessions are included in the aggregation. Supports a subset of the `ListAnalyzedSessionsRequest.filter` grammar: a closed `detection_time` window with both bounds required. The `severity` clause is not supported here. If empty, the aggregation covers the last 3 days. Example: ``` detection_time >= "2024-01-01T00:00:00Z" AND detection_time <= "2024-01-08T00:00:00Z" ``` pageSize: integer, Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 MonitoredAgents will be returned. pageToken: string, Optional. The standard list page token. x__xgafv: string, V1 error format. @@ -115,22 +115,22 @@

Method Details

Returns: An object of the form: - { # Response containing aggregated AnalyzedSession statistics, grouped by MonitoredAgent. + { # Contains aggregated AnalyzedSession statistics, grouped by MonitoredAgent. "agentAggregates": [ # Aggregated statistics — exactly one entry per unique MonitoredAgent matched by the request. - { # Aggregated statistics for one MonitoredAgent. - "agentDisplayName": "A String", # Output only. The human-readable display name of the MonitoredAgent, denormalized from `monitored_agents.display_name`. + { # Contains aggregated statistics for one MonitoredAgent. + "agentDisplayName": "A String", # Output only. The human-readable display name of the MonitoredAgent. "agentResourceName": "A String", # The agent resource name. Format: `projects/{project}/locations/{location}/reasoningEngines/{agent}` - "agentStatus": "A String", # Output only. The enablement state of the MonitoredAgent (e.g. ACTIVE, DISABLED, ENABLING, INELIGIBLE, NEEDS_ACTION), denormalized from `monitored_agents.state`. + "agentStatus": "A String", # Output only. The enablement state of the MonitoredAgent (for example, ACTIVE, DISABLED, or ENABLING). "anomalousSessionsCount": 42, # The number of anomalous (SESSION_STATE_FLAGGED) sessions for this agent. "latestSessionTime": "A String", # The latest session update_time observed for this agent. - "location": "A String", # Output only. The GCP location (region) of the agent (e.g. `us-central1`). Denormalized from `monitored_agents.location`; empty when the agent is not enrolled or its location column is empty. + "location": "A String", # Output only. The Google Cloud location (region) of the agent (for example, `us-central1`). Empty when the agent is not enrolled or its location is unknown. "monitoredAgent": "A String", # The MonitoredAgent resource name. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}` "severities": { # Map of severity level (string representation of Severity) to detector summaries aggregated across all sessions for this agent. The key is the string representation of Severity enum: "SEVERITY_UNSPECIFIED", "SEVERITY_CRITICAL", "SEVERITY_HIGH", "SEVERITY_MEDIUM", "SEVERITY_LOW". - "a_key": { # Breakdown of anomalies by severity. + "a_key": { # Breaks down anomalies by severity. "detectorIds": [ # The list of detectors summaries for this severity level. "A String", ], - "sessionsCount": 42, # Output only. The number of distinct sessions whose MAX severity equals `severity_level`. Each session is counted in exactly one bucket -- the highest severity that any of its detectors reached -- so summing `sessions_count` across all populated entries in a `severities` map equals the total anomalous session count for that scope (per-agent or view summary). Distinct from `detector_ids.size`: a session whose detectors fire at LOW and CRITICAL contributes one entry to `sessions_count` (in CRITICAL only) but contributes detector IDs to BOTH the LOW and CRITICAL buckets' `detector_ids` lists. For AAD audit landing-page scorecards, prefer `sessions_count` -- "Critical anomalies" means sessions ranked critical, not distinct critical-firing detectors. On AggregateAnalyzedSessionsResponse.summary, this is a TRUE GLOBAL count across all anomalous active agents in scope (not page-scoped). On per-agent entries within `agent_aggregates`, it's per-agent. On ListAnalyzedSessionsResponse, it is currently page-scoped to match the existing summary semantics on that API. + "sessionsCount": 42, # Output only. The number of distinct sessions whose maximum severity equals `severity_level`. Each session is counted in exactly one bucket (its highest severity). Scope depends on where this appears: a global count on `AggregateAnalyzedSessionsResponse.summary`, per-agent on `agent_aggregates` entries, and page-scoped on `ListAnalyzedSessionsResponse`. "severityLevel": "A String", # The severity level of the detector. }, }, @@ -139,15 +139,15 @@

Method Details

], "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "summary": { # The view summary. # Overall summary across every MonitoredAgent included in the response. - "anomalousAgentsCount": 42, # Output only. The number of distinct agents matching the request scope that have at least one anomalous session in the time window. On `AggregateAnalyzedSessionsResponse.summary` (wildcard parent), this is a true GLOBAL count across all anomalous active agents, NOT the page-row count. The denominator for an "anomalous active agents" scorecard pairs this with `ListMonitoredAgentsResponse.total_size` (filtered to `state = ACTIVE`). On `ListAnalyzedSessionsResponse.summary`, this field is not populated (the API is per-session, not per-agent). + "anomalousAgentsCount": 42, # Output only. The number of distinct agents in the request scope with at least one anomalous session in the time window. On `AggregateAnalyzedSessionsResponse.summary` this is a global count; it is not populated on `ListAnalyzedSessionsResponse.summary`. "anomalousSessionsCount": 42, # Number of anomalous sessions. - "llmScannedSessionsCount": 42, # Output only. The number of distinct sessions in the time window that were scanned by Stage 2 LLM judges. + "llmScannedSessionsCount": 42, # Output only. The number of distinct sessions in the time window that were scanned by the LLM judge. "severities": { # The list of severity summaries for the analyzed sessions. The key is the string representation of Severity enum: "SEVERITY_UNSPECIFIED", "SEVERITY_CRITICAL", "SEVERITY_HIGH", "SEVERITY_MEDIUM", "SEVERITY_LOW". - "a_key": { # Breakdown of anomalies by severity. + "a_key": { # Breaks down anomalies by severity. "detectorIds": [ # The list of detectors summaries for this severity level. "A String", ], - "sessionsCount": 42, # Output only. The number of distinct sessions whose MAX severity equals `severity_level`. Each session is counted in exactly one bucket -- the highest severity that any of its detectors reached -- so summing `sessions_count` across all populated entries in a `severities` map equals the total anomalous session count for that scope (per-agent or view summary). Distinct from `detector_ids.size`: a session whose detectors fire at LOW and CRITICAL contributes one entry to `sessions_count` (in CRITICAL only) but contributes detector IDs to BOTH the LOW and CRITICAL buckets' `detector_ids` lists. For AAD audit landing-page scorecards, prefer `sessions_count` -- "Critical anomalies" means sessions ranked critical, not distinct critical-firing detectors. On AggregateAnalyzedSessionsResponse.summary, this is a TRUE GLOBAL count across all anomalous active agents in scope (not page-scoped). On per-agent entries within `agent_aggregates`, it's per-agent. On ListAnalyzedSessionsResponse, it is currently page-scoped to match the existing summary semantics on that API. + "sessionsCount": 42, # Output only. The number of distinct sessions whose maximum severity equals `severity_level`. Each session is counted in exactly one bucket (its highest severity). Scope depends on where this appears: a global count on `AggregateAnalyzedSessionsResponse.summary`, per-agent on `agent_aggregates` entries, and page-scoped on `ListAnalyzedSessionsResponse`. "severityLevel": "A String", # The severity level of the detector. }, }, @@ -194,11 +194,11 @@

Method Details

Returns: An object of the form: - { # An analyzed session for a monitored agent. - "agentDisplayName": "A String", # Output only. The human-readable display name of the MonitoredAgent that owns this session, denormalized from `monitored_agents.display_name` so the UI can render an agent name in the per-session feed without an extra `getMonitoredAgent` round-trip. May be empty when the session's agent_id is not enrolled as a MonitoredAgent (i.e. the JOIN missed); the `agent_resource_name` URN is always present and can be used as a fallback identifier. + { # Represents an analyzed session for a monitored agent. + "agentDisplayName": "A String", # Output only. The human-readable display name of the MonitoredAgent that owns this session. May be empty when the session's agent is not enrolled as a MonitoredAgent; the `agent_resource_name` is always present and can be used as a fallback identifier. "agentResourceName": "A String", # Output only. The agent resource name. Format: `projects/{project}/locations/{location}/reasoningEngines/{agent}` - "agentState": "A String", # Output only. The current enablement state of the MonitoredAgent that owns this session (e.g. ACTIVE, DISABLED, ENABLING, INELIGIBLE, NEEDS_ACTION), denormalized from `monitored_agents.state`. Defaults to ENABLEMENT_STATE_UNSPECIFIED when the agent is not enrolled (the JOIN missed) or its state column is empty / unknown. - "assessment": { # Detailed assessment for an analyzed session. # Output only. Overall security assessment. Populated only in FULL view. + "agentState": "A String", # Output only. The current enablement state of the MonitoredAgent that owns this session (for example, ACTIVE, DISABLED, or ENABLING). Defaults to ENABLEMENT_STATE_UNSPECIFIED when the agent is not enrolled or its state is unknown. + "assessment": { # Contains the detailed assessment for an analyzed session. # Output only. Overall security assessment. Populated only in FULL view. "detectorFindings": [ # The list of detector findings. { # The details of a detector's assessment within an analyzed session. "detectorId": "A String", # The detector ID. @@ -214,16 +214,16 @@

Method Details

}, "createTime": "A String", # Output only. The creation time of the session. "latestAnalyzedTime": "A String", # Output only. The latest analyzed time of the session. - "location": "A String", # Output only. The GCP location (region) of the agent that ran this session (e.g. `us-central1`). Denormalized from `monitored_agents.location`; empty when the agent is not enrolled or its location column is empty. + "location": "A String", # Output only. The Google Cloud location (region) of the agent that ran this session (for example, `us-central1`). Empty when the agent is not enrolled or its location is unknown. "name": "A String", # Identifier. The resource name of the AnalyzedSession. "sessionId": "A String", # Output only. The session ID. "sessionState": "A String", # Output only. The state of the session. "severities": { # Output only. Map of severity counts for listing analyzed sessions. The key is the string representation of Severity. Populated in BASIC view only. - "a_key": { # Breakdown of anomalies by severity. + "a_key": { # Breaks down anomalies by severity. "detectorIds": [ # The list of detectors summaries for this severity level. "A String", ], - "sessionsCount": 42, # Output only. The number of distinct sessions whose MAX severity equals `severity_level`. Each session is counted in exactly one bucket -- the highest severity that any of its detectors reached -- so summing `sessions_count` across all populated entries in a `severities` map equals the total anomalous session count for that scope (per-agent or view summary). Distinct from `detector_ids.size`: a session whose detectors fire at LOW and CRITICAL contributes one entry to `sessions_count` (in CRITICAL only) but contributes detector IDs to BOTH the LOW and CRITICAL buckets' `detector_ids` lists. For AAD audit landing-page scorecards, prefer `sessions_count` -- "Critical anomalies" means sessions ranked critical, not distinct critical-firing detectors. On AggregateAnalyzedSessionsResponse.summary, this is a TRUE GLOBAL count across all anomalous active agents in scope (not page-scoped). On per-agent entries within `agent_aggregates`, it's per-agent. On ListAnalyzedSessionsResponse, it is currently page-scoped to match the existing summary semantics on that API. + "sessionsCount": 42, # Output only. The number of distinct sessions whose maximum severity equals `severity_level`. Each session is counted in exactly one bucket (its highest severity). Scope depends on where this appears: a global count on `AggregateAnalyzedSessionsResponse.summary`, per-agent on `agent_aggregates` entries, and page-scoped on `ListAnalyzedSessionsResponse`. "severityLevel": "A String", # The severity level of the detector. }, }, @@ -237,8 +237,8 @@

Method Details

Args: parent: string, Required. The parent MonitoredAgent resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}` (required) - filter: string, Optional. Filter expression restricting which AnalyzedSessions are returned. A subset of AIP-160 supporting two clauses joined by AND: 1. A closed time window on `detection_time`. If included, both bounds are required: detection_time >= "" AND detection_time <= "" 2. An equality on `severity`, where the value is the string representation of a Severity enum value (e.g., "CRITICAL", "HIGH", "MEDIUM", "LOW"). "SEVERITY_UNSPECIFIED" is not supported. The filter matches sessions whose maximum severity equals the requested bucket (a session whose detectors fire at LOW and CRITICAL is matched by `severity = "CRITICAL"`, not `severity = "LOW"`): severity = "CRITICAL" Both clauses are independently optional and may appear in either order. Each clause may appear at most once. Example (time window + severity): detection_time >= "2024-01-01T00:00:00Z" AND detection_time <= "2024-01-08T00:00:00Z" AND severity = "CRITICAL" If empty, results are restricted to the last 3 days with no severity restriction. Other fields, additional operators, set membership (IN), and boolean combinations (OR, NOT, parentheses) are not yet supported. - orderBy: string, Optional. Comma-separated list of fields to sort by, following AIP-132 syntax. The default sort direction is ascending; append " desc" to a field to sort descending. Subfields are not supported (no field listed below has any). Supported fields (any other field yields INVALID_ARGUMENT): * `latest_detection_time` - the session's most-recent flagged detection time. This is the column the landing page's "Detection time" header sorts on. Sorted by the underlying TIMESTAMP value (newer is "greater" so `latest_detection_time desc` puts the newest sessions first). * `max_severity_rank` - the session's bucketed maximum severity, ranked LOW=1 < MEDIUM=2 < HIGH=3 < CRITICAL=4 (matches `Severity` enum ordering). `max_severity_rank desc` puts the most-severe sessions first. The ranking is documented here per AIP-132 because the field is not a natural-comparator type. * `agent_display_name` - the MonitoredAgent's display name as shown in the UI's "Agent name" column. Sorted as a STRING using BigQuery default collation (case-sensitive, code-point order). The server always appends `session_id ASC` as a stable tiebreak so pagination remains consistent across pages when the primary sort field has duplicates (e.g. multiple sessions with the same latest_detection_time within a second). If empty, defaults to `latest_detection_time desc` (the prior implicit behavior). Multi-field sort (e.g. `max_severity_rank desc, latest_detection_time desc`) is supported. The `order_by` value MUST match the value used on the call that minted any supplied `page_token` (AIP-158). Mismatches yield INVALID_ARGUMENT. + filter: string, Optional. Filter expression restricting which AnalyzedSessions are returned. Supports a subset of AIP-160: a closed `detection_time` window (both bounds required) and/or an equality on `severity`, joined by `AND`. Each clause is optional, may appear at most once, and may appear in either order. The `severity` value is the string form of a `Severity` value (`CRITICAL`, `HIGH`, `MEDIUM`, or `LOW`; `SEVERITY_UNSPECIFIED` is not supported) and matches sessions whose maximum severity equals that bucket. For example, a session that fires at both LOW and CRITICAL matches `severity = "CRITICAL"`, not `severity = "LOW"`. Example (time window and severity): ``` detection_time >= "2024-01-01T00:00:00Z" AND detection_time <= "2024-01-08T00:00:00Z" AND severity = "CRITICAL" ``` If empty, results are restricted to the last 3 days with no severity restriction. Other fields, additional operators, set membership (`IN`), and boolean combinations (`OR`, `NOT`, parentheses) are not yet supported. + orderBy: string, Optional. Comma-separated list of fields to sort by, following AIP-132 syntax. The default sort direction is ascending; append " desc" to a field to sort descending. Supported fields (any other field yields INVALID_ARGUMENT): * `latest_detection_time` - the session's most-recent flagged detection time. `latest_detection_time desc` puts the newest sessions first. * `max_severity_rank` - the session's bucketed maximum severity, ranked LOW=1 < MEDIUM=2 < HIGH=3 < CRITICAL=4. `max_severity_rank desc` puts the most-severe sessions first. * `agent_display_name` - the MonitoredAgent's display name. Sorted as a STRING (case-sensitive, code-point order). If empty, defaults to `latest_detection_time desc`. Multi-field sort (for example, `max_severity_rank desc, latest_detection_time desc`) is supported. The `order_by` value MUST match the value used on the call that minted any supplied `page_token` (AIP-158). Mismatches yield INVALID_ARGUMENT. pageSize: integer, Optional. The maximum number of analyzed sessions to return. pageToken: string, Optional. A page token, received from a previous `ListAnalyzedSessions` call. view: string, Optional. Resource view to control which fields are returned. @@ -256,11 +256,11 @@

Method Details

{ # Response to list analyzed sessions. "analyzedSessions": [ # The list of analyzed sessions. - { # An analyzed session for a monitored agent. - "agentDisplayName": "A String", # Output only. The human-readable display name of the MonitoredAgent that owns this session, denormalized from `monitored_agents.display_name` so the UI can render an agent name in the per-session feed without an extra `getMonitoredAgent` round-trip. May be empty when the session's agent_id is not enrolled as a MonitoredAgent (i.e. the JOIN missed); the `agent_resource_name` URN is always present and can be used as a fallback identifier. + { # Represents an analyzed session for a monitored agent. + "agentDisplayName": "A String", # Output only. The human-readable display name of the MonitoredAgent that owns this session. May be empty when the session's agent is not enrolled as a MonitoredAgent; the `agent_resource_name` is always present and can be used as a fallback identifier. "agentResourceName": "A String", # Output only. The agent resource name. Format: `projects/{project}/locations/{location}/reasoningEngines/{agent}` - "agentState": "A String", # Output only. The current enablement state of the MonitoredAgent that owns this session (e.g. ACTIVE, DISABLED, ENABLING, INELIGIBLE, NEEDS_ACTION), denormalized from `monitored_agents.state`. Defaults to ENABLEMENT_STATE_UNSPECIFIED when the agent is not enrolled (the JOIN missed) or its state column is empty / unknown. - "assessment": { # Detailed assessment for an analyzed session. # Output only. Overall security assessment. Populated only in FULL view. + "agentState": "A String", # Output only. The current enablement state of the MonitoredAgent that owns this session (for example, ACTIVE, DISABLED, or ENABLING). Defaults to ENABLEMENT_STATE_UNSPECIFIED when the agent is not enrolled or its state is unknown. + "assessment": { # Contains the detailed assessment for an analyzed session. # Output only. Overall security assessment. Populated only in FULL view. "detectorFindings": [ # The list of detector findings. { # The details of a detector's assessment within an analyzed session. "detectorId": "A String", # The detector ID. @@ -276,16 +276,16 @@

Method Details

}, "createTime": "A String", # Output only. The creation time of the session. "latestAnalyzedTime": "A String", # Output only. The latest analyzed time of the session. - "location": "A String", # Output only. The GCP location (region) of the agent that ran this session (e.g. `us-central1`). Denormalized from `monitored_agents.location`; empty when the agent is not enrolled or its location column is empty. + "location": "A String", # Output only. The Google Cloud location (region) of the agent that ran this session (for example, `us-central1`). Empty when the agent is not enrolled or its location is unknown. "name": "A String", # Identifier. The resource name of the AnalyzedSession. "sessionId": "A String", # Output only. The session ID. "sessionState": "A String", # Output only. The state of the session. "severities": { # Output only. Map of severity counts for listing analyzed sessions. The key is the string representation of Severity. Populated in BASIC view only. - "a_key": { # Breakdown of anomalies by severity. + "a_key": { # Breaks down anomalies by severity. "detectorIds": [ # The list of detectors summaries for this severity level. "A String", ], - "sessionsCount": 42, # Output only. The number of distinct sessions whose MAX severity equals `severity_level`. Each session is counted in exactly one bucket -- the highest severity that any of its detectors reached -- so summing `sessions_count` across all populated entries in a `severities` map equals the total anomalous session count for that scope (per-agent or view summary). Distinct from `detector_ids.size`: a session whose detectors fire at LOW and CRITICAL contributes one entry to `sessions_count` (in CRITICAL only) but contributes detector IDs to BOTH the LOW and CRITICAL buckets' `detector_ids` lists. For AAD audit landing-page scorecards, prefer `sessions_count` -- "Critical anomalies" means sessions ranked critical, not distinct critical-firing detectors. On AggregateAnalyzedSessionsResponse.summary, this is a TRUE GLOBAL count across all anomalous active agents in scope (not page-scoped). On per-agent entries within `agent_aggregates`, it's per-agent. On ListAnalyzedSessionsResponse, it is currently page-scoped to match the existing summary semantics on that API. + "sessionsCount": 42, # Output only. The number of distinct sessions whose maximum severity equals `severity_level`. Each session is counted in exactly one bucket (its highest severity). Scope depends on where this appears: a global count on `AggregateAnalyzedSessionsResponse.summary`, per-agent on `agent_aggregates` entries, and page-scoped on `ListAnalyzedSessionsResponse`. "severityLevel": "A String", # The severity level of the detector. }, }, @@ -293,16 +293,16 @@

Method Details

}, ], "nextPageToken": "A String", # A token to retrieve the next page of results. - "summary": { # The view summary. # Summary statistics for the sessions returned on the current page. This is computed across the current page only (not the full result set) and is populated on every page. Callers that need aggregate statistics across the entire result set should use AggregateAnalyzedSessions. - "anomalousAgentsCount": 42, # Output only. The number of distinct agents matching the request scope that have at least one anomalous session in the time window. On `AggregateAnalyzedSessionsResponse.summary` (wildcard parent), this is a true GLOBAL count across all anomalous active agents, NOT the page-row count. The denominator for an "anomalous active agents" scorecard pairs this with `ListMonitoredAgentsResponse.total_size` (filtered to `state = ACTIVE`). On `ListAnalyzedSessionsResponse.summary`, this field is not populated (the API is per-session, not per-agent). + "summary": { # The view summary. # Summary statistics computed across the sessions on the current page only. For statistics across the entire result set, use AggregateAnalyzedSessions. + "anomalousAgentsCount": 42, # Output only. The number of distinct agents in the request scope with at least one anomalous session in the time window. On `AggregateAnalyzedSessionsResponse.summary` this is a global count; it is not populated on `ListAnalyzedSessionsResponse.summary`. "anomalousSessionsCount": 42, # Number of anomalous sessions. - "llmScannedSessionsCount": 42, # Output only. The number of distinct sessions in the time window that were scanned by Stage 2 LLM judges. + "llmScannedSessionsCount": 42, # Output only. The number of distinct sessions in the time window that were scanned by the LLM judge. "severities": { # The list of severity summaries for the analyzed sessions. The key is the string representation of Severity enum: "SEVERITY_UNSPECIFIED", "SEVERITY_CRITICAL", "SEVERITY_HIGH", "SEVERITY_MEDIUM", "SEVERITY_LOW". - "a_key": { # Breakdown of anomalies by severity. + "a_key": { # Breaks down anomalies by severity. "detectorIds": [ # The list of detectors summaries for this severity level. "A String", ], - "sessionsCount": 42, # Output only. The number of distinct sessions whose MAX severity equals `severity_level`. Each session is counted in exactly one bucket -- the highest severity that any of its detectors reached -- so summing `sessions_count` across all populated entries in a `severities` map equals the total anomalous session count for that scope (per-agent or view summary). Distinct from `detector_ids.size`: a session whose detectors fire at LOW and CRITICAL contributes one entry to `sessions_count` (in CRITICAL only) but contributes detector IDs to BOTH the LOW and CRITICAL buckets' `detector_ids` lists. For AAD audit landing-page scorecards, prefer `sessions_count` -- "Critical anomalies" means sessions ranked critical, not distinct critical-firing detectors. On AggregateAnalyzedSessionsResponse.summary, this is a TRUE GLOBAL count across all anomalous active agents in scope (not page-scoped). On per-agent entries within `agent_aggregates`, it's per-agent. On ListAnalyzedSessionsResponse, it is currently page-scoped to match the existing summary semantics on that API. + "sessionsCount": 42, # Output only. The number of distinct sessions whose maximum severity equals `severity_level`. Each session is counted in exactly one bucket (its highest severity). Scope depends on where this appears: a global count on `AggregateAnalyzedSessionsResponse.summary`, per-agent on `agent_aggregates` entries, and page-scoped on `ListAnalyzedSessionsResponse`. "severityLevel": "A String", # The severity level of the detector. }, }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html index 4be3d464b3..2efcae47b5 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html @@ -199,11 +199,12 @@

Method Details

Returns: An object of the form: - { # A monitored agent in a specific Location. + { # Represents a monitored agent in a specific Location. "agentResource": { # Defines the identity of an agent being monitored. # Required. The configuration for the agent being monitored. - "agent": "A String", # Required. The full resource name of the agent to monitor. For REASONING_ENGINE, format: `projects/{project}/locations/{location}/reasoningEngines/{agent}` - "agentType": "A String", # Required. The type of the agent. - "location": "A String", # Output only. The GCP location (region) of the agent resource (e.g. `us-central1`). + "agent": "A String", # Required. The resource name or identifier of the agent to monitor. The format depends on `agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent. + "agentFramework": "A String", # Optional. The framework used to build the agent, orthogonal to the runtime `agent_type`. + "agentType": "A String", # Required. The runtime type of the agent. + "location": "A String", # Output only. The Google Cloud location (region) of the agent resource (for example, `us-central1`). }, "createTime": "A String", # Output only. The time the MonitoredAgent was created. "displayName": "A String", # Optional. The display name of the MonitoredAgent. @@ -220,7 +221,7 @@

Method Details

Args: parent: string, Required. The resource name of the Location to list the MonitoredAgents from. Format: `projects/{project}/locations/{location}` (required) - filter: string, Optional. Optional AIP-160 filter, currently restricted to a single equality predicate on `state`: state = ACTIVE state = DISABLED state = ENABLING The value must be the exact name of a `MonitoredAgent.EnablementState` constant (case-sensitive): `ACTIVE`, `DISABLED`, `ENABLING`, or `ENABLEMENT_STATE_UNSPECIFIED`. (The proto reserves ordinals for additional future states like NEEDS_ACTION; this allow-list grows when the proto adds them.) A blank or absent filter returns every MonitoredAgent in the parent regardless of state. Anything else returns INVALID_ARGUMENT. + filter: string, Optional. An AIP-160 filter, currently restricted to a single equality predicate on `state`. The value must be the exact, case-sensitive name of a `MonitoredAgent.EnablementState` value: `ACTIVE`, `DISABLED`, `ENABLING`, or `ENABLEMENT_STATE_UNSPECIFIED`. A blank or absent filter returns every MonitoredAgent in the parent regardless of state; any other value returns `INVALID_ARGUMENT`. Example: ``` state = ACTIVE ``` pageSize: integer, Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 MonitoredAgents will be returned. pageToken: string, Optional. The standard list page token. x__xgafv: string, V1 error format. @@ -233,11 +234,12 @@

Method Details

{ # Response message for AgentAnomalyDetectionService.ListMonitoredAgents. "monitoredAgents": [ # A list of MonitoredAgents that matches the specified filter in the request. - { # A monitored agent in a specific Location. + { # Represents a monitored agent in a specific Location. "agentResource": { # Defines the identity of an agent being monitored. # Required. The configuration for the agent being monitored. - "agent": "A String", # Required. The full resource name of the agent to monitor. For REASONING_ENGINE, format: `projects/{project}/locations/{location}/reasoningEngines/{agent}` - "agentType": "A String", # Required. The type of the agent. - "location": "A String", # Output only. The GCP location (region) of the agent resource (e.g. `us-central1`). + "agent": "A String", # Required. The resource name or identifier of the agent to monitor. The format depends on `agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent. + "agentFramework": "A String", # Optional. The framework used to build the agent, orthogonal to the runtime `agent_type`. + "agentType": "A String", # Required. The runtime type of the agent. + "location": "A String", # Output only. The Google Cloud location (region) of the agent resource (for example, `us-central1`). }, "createTime": "A String", # Output only. The time the MonitoredAgent was created. "displayName": "A String", # Optional. The display name of the MonitoredAgent. @@ -248,7 +250,7 @@

Method Details

}, ], "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - "totalSize": 42, # The total number of MonitoredAgents in the request scope after the request `filter` (if any) is applied. With no filter this is the unconditional count of MonitoredAgents in the parent; with `filter = "state = ACTIVE"` it is the active-agent count, and so on. + "totalSize": 42, # The total number of MonitoredAgents matching the request, after any `filter` is applied. }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html index 8bbd52126b..180ca147ca 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html @@ -146,6 +146,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -185,6 +190,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, } @@ -329,6 +343,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -368,6 +387,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, } @@ -426,6 +454,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -465,6 +498,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html b/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html index 1a42119525..18fff3105f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html @@ -172,7 +172,7 @@

Method Details

"traceScope": { # If chosen, the online evaluator will evaluate single traces matching specified `filter`. # Scope online evaluation to single traces. "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. { # Defines a single filter predicate. - "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace. + "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace (in seconds). "comparisonOperator": "A String", # Required. The comparison operator to apply. "value": 3.14, # Required. The value to compare against. }, @@ -192,7 +192,7 @@

Method Details

}, }, "createTime": "A String", # Output only. Timestamp when the OnlineEvaluator was created. - "displayName": "A String", # Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. + "displayName": "A String", # Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. { # The metric source used for evaluation. "metric": { # The metric used for running evaluations. # Inline metric config. @@ -222,6 +222,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -382,6 +399,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -674,7 +708,7 @@

Method Details

"traceScope": { # If chosen, the online evaluator will evaluate single traces matching specified `filter`. # Scope online evaluation to single traces. "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. { # Defines a single filter predicate. - "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace. + "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace (in seconds). "comparisonOperator": "A String", # Required. The comparison operator to apply. "value": 3.14, # Required. The value to compare against. }, @@ -694,7 +728,7 @@

Method Details

}, }, "createTime": "A String", # Output only. Timestamp when the OnlineEvaluator was created. - "displayName": "A String", # Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. + "displayName": "A String", # Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. { # The metric source used for evaluation. "metric": { # The metric used for running evaluations. # Inline metric config. @@ -724,6 +758,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -884,6 +935,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1120,7 +1188,7 @@

Method Details

"traceScope": { # If chosen, the online evaluator will evaluate single traces matching specified `filter`. # Scope online evaluation to single traces. "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. { # Defines a single filter predicate. - "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace. + "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace (in seconds). "comparisonOperator": "A String", # Required. The comparison operator to apply. "value": 3.14, # Required. The value to compare against. }, @@ -1140,7 +1208,7 @@

Method Details

}, }, "createTime": "A String", # Output only. Timestamp when the OnlineEvaluator was created. - "displayName": "A String", # Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. + "displayName": "A String", # Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. { # The metric source used for evaluation. "metric": { # The metric used for running evaluations. # Inline metric config. @@ -1170,6 +1238,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1330,6 +1415,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1570,7 +1672,7 @@

Method Details

"traceScope": { # If chosen, the online evaluator will evaluate single traces matching specified `filter`. # Scope online evaluation to single traces. "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. { # Defines a single filter predicate. - "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace. + "duration": { # Defines a predicate for filtering based on a numeric value. # Filter on the duration of a trace (in seconds). "comparisonOperator": "A String", # Required. The comparison operator to apply. "value": 3.14, # Required. The value to compare against. }, @@ -1590,7 +1692,7 @@

Method Details

}, }, "createTime": "A String", # Output only. Timestamp when the OnlineEvaluator was created. - "displayName": "A String", # Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. + "displayName": "A String", # Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. { # The metric source used for evaluation. "metric": { # The metric used for running evaluations. # Inline metric config. @@ -1620,6 +1722,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1780,6 +1899,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.html index ff1290f52c..810c9992f7 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.html @@ -79,6 +79,11 @@

Instance Methods

Returns the models Resource.

+

+ v1() +

+

Returns the v1 Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index a2405a6af2..92564e2799 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -147,12 +147,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -264,12 +277,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -340,6 +366,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -487,12 +530,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -672,6 +728,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -829,12 +891,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content to be embedded. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1073,7 +1148,7 @@

Method Details

"cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. - "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). When enabled, logs are emitted for all publisher-model traffic on the model -- Provisioned Throughput and on-demand alike. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. @@ -1104,12 +1179,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1180,6 +1268,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1337,12 +1442,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1538,6 +1656,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1692,12 +1816,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2323,7 +2460,7 @@

Method Details

"cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. - "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). When enabled, logs are emitted for all publisher-model traffic on the model -- Provisioned Throughput and on-demand alike. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. @@ -2337,6 +2474,7 @@

Method Details

"samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. }, }, + "updateMask": "A String", # Optional. The fields of `publisher_model_config` to overwrite. If empty, the entire config is replaced. If set, only the listed fields are overwritten and the others are left unchanged; this lets you update one setting (for example `inference_event_logging_config`) without clearing its siblings. } x__xgafv: string, V1 error format. @@ -2383,12 +2521,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2459,6 +2610,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2616,12 +2784,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2817,6 +2998,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2971,12 +3158,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.v1.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.v1.html new file mode 100644 index 0000000000..5c763ec6a6 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.v1.html @@ -0,0 +1,91 @@ + + + +

Agent Platform API . projects . locations . publishers . v1

+

Instance Methods

+

+ responses() +

+

Returns the responses 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.publishers.v1.responses.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.v1.responses.html new file mode 100644 index 0000000000..e8ed287f9d --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.v1.responses.html @@ -0,0 +1,184 @@ + + + +

Agent Platform API . projects . locations . publishers . v1 . responses

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ compact(endpoint, body=None, deployedModelId=None, x__xgafv=None)

+

Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.

+

+ delete(name, x__xgafv=None)

+

Deletes the response from the endpoint.

+

+ get(name, x__xgafv=None)

+

Gets the response from the endpoint.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ compact(endpoint, body=None, deployedModelId=None, x__xgafv=None) +
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # 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.
+    },
+  ],
+}
+
+  deployedModelId: string, ID of the DeployedModel that serves the invoke request.
+  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.
+    },
+  ],
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the response from the endpoint.
+
+Args:
+  name: string, Required. The name of the Response resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}/responses/{response}` (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.
+    },
+  ],
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the response from the endpoint.
+
+Args:
+  name: string, Required. The name of the Response resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}/responses/{response}` (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.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.events.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.events.html index ca50f80af9..1a544c0205 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.events.html @@ -94,11 +94,11 @@

Method Details

Lists TaskEvents for an A2aTask.
 
 Args:
-  parent: string, Required. The resource name of the A2aTask to list the TaskEvents under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` (required)
+  parent: string, Required. The resource name of the A2aTask to list the TaskEvents under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}` (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 `event_sequence_number` in descending 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` * `event_sequence_number`
   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 hit exception.
-  pageToken: string, Optional. The next_page_token value returned from a previous list AgentEngineTaskStoreService.ListA2aTaskEvents call.
+  pageToken: string, Optional. The next_page_token value returned from a previous list ListA2aTaskEvents call.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -107,9 +107,118 @@ 

Method Details

Returns: An object of the form: - { # Response message for AgentEngineTaskStoreService.ListA2aTaskEvents. + { # Response message for ListA2aTaskEvents. + "events": [ # List of A2aTaskEvents in the requested page. Populated only by the TaskStoreService. + { # 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 A2aTaskEvent. Exactly one of the following changes is set per 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. Structured data content. + "a_key": "", # Properties of the object. + }, + "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. Structured data content. + "a_key": "", # Properties of the object. + }, + "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 complete task metadata after the change. + "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. Structured data content. + "a_key": "", # Properties of the object. + }, + "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. - "taskEvents": [ # List of TaskEvents in the requested page. + "taskEvents": [ # List of TaskEvents in the requested page. Populated only by the AgentEngineTaskStoreService. { # An event that occurred for a task. Note that TaskEvent is just a record of task's change. Hence, it's not a Cloud resource. "createTime": "A String", # Output only. The create time of the event. "eventData": { # Data for a TaskEvent. # Required. The delta associated with the event. @@ -131,12 +240,25 @@

Method Details

}, "parts": [ # Required. The content of the artifact. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -217,12 +339,25 @@

Method Details

}, "parts": [ # Required. The content of the artifact. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -304,12 +439,25 @@

Method Details

}, "parts": [ # Required. The parts of the message. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html index a751d74ec4..50b140a75a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html @@ -92,7 +92,7 @@

Instance Methods

delete(name, x__xgafv=None)

Deletes an A2aTask.

- get(name, x__xgafv=None)

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

Gets an A2aTask.

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

@@ -106,12 +106,122 @@

Method Details

Appends TaskEvents to an A2aTask.
 
 Args:
-  name: string, Required. The resource name of the A2aTask to append events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` (required)
+  name: string, Required. The resource name of the A2aTask to append events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for AgentEngineTaskStoreService.AppendA2aTaskEvents.
-  "taskEvents": [ # Required. The events to append. The number of events to append must be less than or equal to 100. Otherwise, an exception will be thrown.
+{ # Request message for AppendA2aTaskEvents.
+  "events": [ # Optional. The events to append. Used only if the parent is a TaskStore.
+    { # 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 A2aTaskEvent. Exactly one of the following changes is set per 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. Structured data content.
+                  "a_key": "", # Properties of the object.
+                },
+                "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. Structured data content.
+                  "a_key": "", # Properties of the object.
+                },
+                "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 complete task metadata after the change.
+            "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. Structured data content.
+                  "a_key": "", # Properties of the object.
+                },
+                "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", # Optional. The current task generation.
+  "taskEvents": [ # Required. The events to append. The number of events to append must be less than or equal to 100. Otherwise, an exception will be thrown. Used only if the parent is a ReasoningEngine.
     { # An event that occurred for a task. Note that TaskEvent is just a record of task's change. Hence, it's not a Cloud resource.
       "createTime": "A String", # Output only. The create time of the event.
       "eventData": { # Data for a TaskEvent. # Required. The delta associated with the event.
@@ -133,12 +243,25 @@ 

Method Details

}, "parts": [ # Required. The content of the artifact. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -219,12 +342,25 @@

Method Details

}, "parts": [ # Required. The content of the artifact. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -306,12 +442,25 @@

Method Details

}, "parts": [ # Required. The parts of the message. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -395,7 +544,8 @@

Method Details

Returns: An object of the form: - { # Response message for AgentEngineTaskStoreService.AppendA2aTaskEvents. + { # Response message for AppendA2aTaskEvents. + "generation": "A String", # Task generation matching the last event }
@@ -409,18 +559,78 @@

Method Details

Creates an A2aTask.
 
 Args:
-  parent: string, Required. The resource name of the ReasoningEngine to create the A2aTask under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  parent: string, Required. The resource name of the ReasoningEngine or TaskStore to create the A2aTask under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` or `projects/{project}/locations/{location}/taskStores/{task_store}` (required)
   body: object, The request body.
     The object takes the form of:
 
 { # An A2aTask represents a unit of work.
+  "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. Structured data content.
+            "a_key": "", # Properties of the object.
+          },
+          "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.
   "expireTime": "A String", # 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
+  "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. Structured data content.
+            "a_key": "", # Properties of the object.
+          },
+          "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. Arbitrary, user-defined metadata.
     "a_key": "", # Properties of the object.
   },
-  "name": "A String", # Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`
+  "name": "A String", # 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}`
   "nextEventSequenceNumber": "A String", # 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.
   "output": { # Represents the final output of a task. # Optional. The final output of the task.
     "artifacts": [ # Optional. A list of artifacts (files, data) produced by the task.
@@ -433,12 +643,25 @@ 

Method Details

}, "parts": [ # Required. The content of the artifact. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -508,6 +731,38 @@

Method Details

], }, "state": "A String", # 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. + "status": { # Represents the status of an A2aTask. # 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. Structured data content. + "a_key": "", # Properties of the object. + }, + "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. + }, "statusDetails": { # Represents the additional status details of a task. # Optional. The status details of the task. "taskMessage": { # Represents a single message in a conversation, compliant with the A2A specification. # Optional. The message associated with the single-turn interaction between the user and the agent or agent and agent. "messageId": "A String", # Required. The unique identifier of the message. @@ -516,12 +771,25 @@

Method Details

}, "parts": [ # Required. The parts of the message. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -592,9 +860,10 @@

Method Details

}, "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. } - a2aTaskId: string, Required. User-defined ID of the A2aTask. This ID must be unique within the ReasoningEngine. It must be 1-63 characters, start with a lowercase letter or number, end with a lowercase letter or number, and only contain lowercase letters, numbers, and hyphens [AIP-122](https://google.aip.dev/122). Starting with a number is allowed for compatibility with the auto-generated UUID from A2A SDK. + a2aTaskId: string, Required. User-defined ID of the A2aTask. This ID must be unique within the parent resource. It must be 1-63 characters, start with a lowercase letter or number, end with a lowercase letter or number, and only contain lowercase letters, numbers, and hyphens [AIP-122](https://google.aip.dev/122). Starting with a number is allowed for compatibility with the auto-generated UUID from A2A SDK. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -604,13 +873,73 @@

Method Details

An object of the form: { # An A2aTask represents a unit of work. + "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. Structured data content. + "a_key": "", # Properties of the object. + }, + "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. "expireTime": "A String", # 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 + "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. Structured data content. + "a_key": "", # Properties of the object. + }, + "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. Arbitrary, user-defined metadata. "a_key": "", # Properties of the object. }, - "name": "A String", # Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` + "name": "A String", # 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}` "nextEventSequenceNumber": "A String", # 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. "output": { # Represents the final output of a task. # Optional. The final output of the task. "artifacts": [ # Optional. A list of artifacts (files, data) produced by the task. @@ -623,12 +952,25 @@

Method Details

}, "parts": [ # Required. The content of the artifact. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -698,6 +1040,38 @@

Method Details

], }, "state": "A String", # 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. + "status": { # Represents the status of an A2aTask. # 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. Structured data content. + "a_key": "", # Properties of the object. + }, + "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. + }, "statusDetails": { # Represents the additional status details of a task. # Optional. The status details of the task. "taskMessage": { # Represents a single message in a conversation, compliant with the A2A specification. # Optional. The message associated with the single-turn interaction between the user and the agent or agent and agent. "messageId": "A String", # Required. The unique identifier of the message. @@ -706,12 +1080,25 @@

Method Details

}, "parts": [ # Required. The parts of the message. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -782,6 +1169,7 @@

Method Details

}, "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. }
@@ -790,7 +1178,7 @@

Method Details

Deletes an A2aTask.
 
 Args:
-  name: string, Required. The resource name of the A2aTask to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` (required)
+  name: string, Required. The resource name of the A2aTask to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -804,11 +1192,16 @@ 

Method Details

- get(name, x__xgafv=None) + get(name, view=None, x__xgafv=None)
Gets an A2aTask.
 
 Args:
-  name: string, Required. The resource name of the A2aTask. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` (required)
+  name: string, Required. The resource name of the A2aTask. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}` (required)
+  view: string, Optional. The view of the A2aTask to return.
+    Allowed values
+      A2A_TASK_VIEW_UNSPECIFIED - Task view unspecified.
+      A2A_TASK_VIEW_BASIC - Task header only (status, metadata, timestamps)
+      A2A_TASK_VIEW_FULL - Full materialized state (artifacts + history)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -818,13 +1211,73 @@ 

Method Details

An object of the form: { # An A2aTask represents a unit of work. + "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. Structured data content. + "a_key": "", # Properties of the object. + }, + "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. "expireTime": "A String", # 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 + "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. Structured data content. + "a_key": "", # Properties of the object. + }, + "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. Arbitrary, user-defined metadata. "a_key": "", # Properties of the object. }, - "name": "A String", # Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` + "name": "A String", # 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}` "nextEventSequenceNumber": "A String", # 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. "output": { # Represents the final output of a task. # Optional. The final output of the task. "artifacts": [ # Optional. A list of artifacts (files, data) produced by the task. @@ -837,12 +1290,25 @@

Method Details

}, "parts": [ # Required. The content of the artifact. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -912,6 +1378,38 @@

Method Details

], }, "state": "A String", # 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. + "status": { # Represents the status of an A2aTask. # 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. Structured data content. + "a_key": "", # Properties of the object. + }, + "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. + }, "statusDetails": { # Represents the additional status details of a task. # Optional. The status details of the task. "taskMessage": { # Represents a single message in a conversation, compliant with the A2A specification. # Optional. The message associated with the single-turn interaction between the user and the agent or agent and agent. "messageId": "A String", # Required. The unique identifier of the message. @@ -920,12 +1418,25 @@

Method Details

}, "parts": [ # Required. The parts of the message. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -996,6 +1507,7 @@

Method Details

}, "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. }
@@ -1004,11 +1516,11 @@

Method Details

Lists A2aTasks for a ReasoningEngine.
 
 Args:
-  parent: string, Required. The resource name of the ReasoningEngine to list the A2aTasks under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  parent: string, Required. The resource name of the ReasoningEngine or TaskStore to list the A2aTasks under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` or `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` * `state` Example: `context_id="abc"`, `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 hit exception.
-  pageToken: string, Optional. The next_page_token value returned from a previous list AgentEngineTaskStoreService.ListA2aTasks call.
+  pageToken: string, Optional. The next_page_token value returned from a previous list ListA2aTasks call.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1017,16 +1529,76 @@ 

Method Details

Returns: An object of the form: - { # Response message for AgentEngineTaskStoreService.ListA2aTasks. + { # Response message for ListA2aTasks. "a2aTasks": [ # List of A2aTasks in the requested page. { # An A2aTask represents a unit of work. + "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. Structured data content. + "a_key": "", # Properties of the object. + }, + "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. "expireTime": "A String", # 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 + "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. Structured data content. + "a_key": "", # Properties of the object. + }, + "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. Arbitrary, user-defined metadata. "a_key": "", # Properties of the object. }, - "name": "A String", # Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` + "name": "A String", # 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}` "nextEventSequenceNumber": "A String", # 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. "output": { # Represents the final output of a task. # Optional. The final output of the task. "artifacts": [ # Optional. A list of artifacts (files, data) produced by the task. @@ -1039,12 +1611,25 @@

Method Details

}, "parts": [ # Required. The content of the artifact. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1114,6 +1699,38 @@

Method Details

], }, "state": "A String", # 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. + "status": { # Represents the status of an A2aTask. # 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. Structured data content. + "a_key": "", # Properties of the object. + }, + "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. + }, "statusDetails": { # Represents the additional status details of a task. # Optional. The status details of the task. "taskMessage": { # Represents a single message in a conversation, compliant with the A2A specification. # Optional. The message associated with the single-turn interaction between the user and the agent or agent and agent. "messageId": "A String", # Required. The unique identifier of the message. @@ -1122,12 +1739,25 @@

Method Details

}, "parts": [ # Required. The parts of the message. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1198,6 +1828,7 @@

Method Details

}, "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 ListA2aTasksRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.feedbackEntries.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.feedbackEntries.html index f0147c47cb..f533bc9c4b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.feedbackEntries.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.feedbackEntries.html @@ -82,10 +82,793 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates a new FeedbackEntry.

+

+ delete(name, x__xgafv=None)

+

Deletes a FeedbackEntry and its associated FeedbackContext.

+

+ get(name, x__xgafv=None)

+

Retrieves a single FeedbackEntry by its resource name.

+

+ getFeedbackContext(name, x__xgafv=None)

+

Retrieves the FeedbackContext associated with a FeedbackEntry.

+

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

+

Lists FeedbackEntries in a ReasoningEngine.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates an existing FeedbackEntry. Only the fields specified in update_mask are modified. If the mask is empty, all mutable fields are replaced with the values supplied in the request.

+

+ updateFeedbackContext(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the FeedbackContext associated with a FeedbackEntry. Only the fields specified in update_mask are modified. If the mask is empty, all mutable fields are replaced with the values supplied in the request.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) +
Creates a new FeedbackEntry.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine in which to create the FeedbackEntry. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # FeedbackEntry is a resource that represents a user's feedback on a conversation with an agent.
+  "createTime": "A String", # Output only. The time at which the entry was created.
+  "customMetadata": { # Optional. Additional key-value metadata associated with the feedback.
+    "a_key": "A String",
+  },
+  "eventId": "A String", # Required. The ID of the event within the session that the feedback relates to.
+  "feedbackLabels": [
+    "A String",
+  ],
+  "feedbackText": "A String", # Optional. Qualitative free-form comments provided by the user.
+  "feedbackType": "A String", # Required. The coarse-grained type of feedback provided by the user. Must be set to a value other than `FEEDBACK_TYPE_UNSPECIFIED`.
+  "name": "A String", # Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`
+  "sessionId": "A String", # Required. The ID of the session that the feedback relates to.
+  "source": "A String", # Optional. The surface that the feedback originated from.
+  "updateTime": "A String", # Output only. The time at which the entry was most recently updated.
+  "userId": "A String", # Optional. A caller-supplied identifier for the user who provided the feedback. The semantics of this field (for example whether it is an opaque token, a hashed value, or a user-visible identifier) are determined by the calling application.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a FeedbackEntry and its associated FeedbackContext.
+
+Args:
+  name: string, Required. The resource name of the FeedbackEntry to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves a single FeedbackEntry by its resource name.
+
+Args:
+  name: string, Required. The resource name of the FeedbackEntry to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # FeedbackEntry is a resource that represents a user's feedback on a conversation with an agent.
+  "createTime": "A String", # Output only. The time at which the entry was created.
+  "customMetadata": { # Optional. Additional key-value metadata associated with the feedback.
+    "a_key": "A String",
+  },
+  "eventId": "A String", # Required. The ID of the event within the session that the feedback relates to.
+  "feedbackLabels": [
+    "A String",
+  ],
+  "feedbackText": "A String", # Optional. Qualitative free-form comments provided by the user.
+  "feedbackType": "A String", # Required. The coarse-grained type of feedback provided by the user. Must be set to a value other than `FEEDBACK_TYPE_UNSPECIFIED`.
+  "name": "A String", # Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`
+  "sessionId": "A String", # Required. The ID of the session that the feedback relates to.
+  "source": "A String", # Optional. The surface that the feedback originated from.
+  "updateTime": "A String", # Output only. The time at which the entry was most recently updated.
+  "userId": "A String", # Optional. A caller-supplied identifier for the user who provided the feedback. The semantics of this field (for example whether it is an opaque token, a hashed value, or a user-visible identifier) are determined by the calling application.
+}
+
+ +
+ getFeedbackContext(name, x__xgafv=None) +
Retrieves the FeedbackContext associated with a FeedbackEntry.
+
+Args:
+  name: string, Required. The resource name of the FeedbackContext to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}/feedbackContext` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Feedback context is a resource that represents additional information about the conversation where the feedback was given, such as the conversation history, system instructions, etc. If provided, feedback context allows to correlate the feedback with the conversation, even if the original session is deleted or not available.
+  "contextEvents": [ # Optional. The session events from the originating session.
+    { # An event represents a message from either the user or agent.
+      "actions": { # Actions are parts of events that are executed by the agent. # Optional. Actions executed by the agent.
+        "artifactDelta": { # Optional. Indicates that the event is updating an artifact. key is the filename, value is the version.
+          "a_key": 42,
+        },
+        "escalate": True or False, # Optional. The agent is escalating to a higher level agent.
+        "requestedAuthConfigs": { # Optional. Will only be set by a tool response indicating tool request euc. Struct key is the function call id since one function call response (from model) could correspond to multiple function calls. Struct value is the required auth config, which can be another struct.
+          "a_key": "", # Properties of the object.
+        },
+        "skipSummarization": True or False, # Optional. If true, it won't call model to summarize function response. Only used for function_response event.
+        "stateDelta": { # Optional. Indicates that the event is updating the state with the given delta.
+          "a_key": "", # Properties of the object.
+        },
+        "transferAgent": "A String", # Optional. If set, the event transfers to the specified agent.
+      },
+      "author": "A String", # Required. The name of the agent that sent the event, or user.
+      "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Content of the event provided by the author.
+        "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+          { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+            "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data.
+              "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set.
+              "text": "A String", # Required. The transcription text of this audio segment.
+              "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set.
+                { # Information about a single recognized word.
+                  "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio.
+                  "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio.
+                  "word": "A String", # Required. Transcript of the word.
+                },
+              ],
+            },
+            "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+              "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.
+              "outcome": "A String", # Required. Outcome of the code execution.
+              "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+            },
+            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+              "code": "A String", # Required. The code to be executed.
+              "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.
+              "language": "A String", # Required. Programming language of the `code`.
+            },
+            "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+              "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+              "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+            },
+            "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+              "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                "a_key": "", # Properties of the object.
+              },
+              "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+              "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+              "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                { # Partial argument value of the function call.
+                  "boolValue": True or False, # Optional. Represents a boolean value.
+                  "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                  "nullValue": "A String", # Optional. Represents a null value.
+                  "numberValue": 3.14, # Optional. Represents a double value.
+                  "stringValue": "A String", # Optional. Represents a string value.
+                  "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                },
+              ],
+              "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+            },
+            "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+              "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+              "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+              "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                  "fileData": { # URI based data for function response. # URI based data.
+                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "fileUri": "A String", # Required. URI.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                    "data": "A String", # Required. Raw bytes.
+                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                },
+              ],
+              "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                "a_key": "", # Properties of the object.
+              },
+              "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+            },
+            "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+              "data": "A String", # Required. The raw bytes of the data.
+              "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+            },
+            "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+              "level": "A String", # The tokenization quality used for given media.
+            },
+            "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+            "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+            "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+            "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+              "endOffset": "A String", # Optional. The end offset of the video.
+              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+              "startOffset": "A String", # Optional. The start offset of the video.
+            },
+          },
+        ],
+        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+      },
+      "errorCode": "A String", # Optional. Error code if the response is an error. Code varies by model.
+      "errorMessage": "A String", # Optional. Error message if the response is an error.
+      "eventMetadata": { # Metadata relating to a LLM response event. # Optional. Metadata relating to this event.
+        "branch": "A String", # Optional. The branch of the event. The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3. Branch is used when multiple child agents shouldn't see their siblings' conversation history.
+        "customMetadata": { # The custom metadata of the LlmResponse.
+          "a_key": "", # Properties of the object.
+        },
+        "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Optional. Metadata returned to client when grounding is enabled.
+          "googleMapsWidgetContextToken": "A String", # Optional. Output only. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and will no longer be populated once removed. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.
+          "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.
+            { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.
+              "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details.
+                "domain": "A String", # The domain of the image search result page.
+                "imageUri": "A String", # The URI of the image.
+                "sourceUri": "A String", # The URI of the image search result page.
+                "title": "A String", # The title of the image search result page.
+              },
+              "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details.
+                "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.
+                  "reviewSnippets": [ # Snippets of reviews that were used to generate the answer.
+                    { # A review snippet that is used to generate the answer.
+                      "googleMapsUri": "A String", # A link to show the review on Google Maps.
+                      "reviewId": "A String", # The ID of the review that is being referenced.
+                      "title": "A String", # The title of the review.
+                    },
+                  ],
+                },
+                "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.
+                "route": { # Route information from Google Maps. # Output only. Route information.
+                  "distanceMeters": 42, # The total distance of the route, in meters.
+                  "duration": "A String", # The total duration of the route.
+                  "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm
+                },
+                "text": "A String", # The text of the place answer.
+                "title": "A String", # The title of the place.
+                "uri": "A String", # The URI of the place.
+              },
+              "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details
+                "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
+                "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used.
+                  "chunkId": "A String", # The ID of the chunk.
+                  "fileId": "A String", # The ID of the file that the chunk belongs to.
+                  "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
+                    "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
+                    "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
+                  },
+                  "text": "A String", # The content of the chunk.
+                },
+                "text": "A String", # The content of the retrieved data source.
+                "title": "A String", # The title of the retrieved data source.
+                "uri": "A String", # The URI of the retrieved data source.
+              },
+              "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details.
+                "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.
+                "title": "A String", # The title of the web page that contains the evidence.
+                "uri": "A String", # The URI of the web page that contains the evidence.
+              },
+            },
+          ],
+          "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.
+            { # A collection of supporting references for a segment or part of the model's response.
+              "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.
+                3.14,
+              ],
+              "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.
+                42,
+              ],
+              "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message.
+                42,
+              ],
+              "segment": { # A segment of the content. # The content segment that this support message applies to.
+                "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.
+                "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.
+                "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.
+                "text": "A String", # Output only. The text of the segment.
+              },
+            },
+          ],
+          "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled.
+            "A String",
+          ],
+          "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source.
+            "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.
+          },
+          "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.
+            "A String",
+          ],
+          "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search.
+            "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.
+            "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.
+          },
+          "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.
+            { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.
+              "flagContentUri": "A String", # The URI that can be used to flag the content.
+              "sourceId": "A String", # The ID of the place or review.
+            },
+          ],
+          "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.
+            "A String",
+          ],
+        },
+        "inputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of user input.
+          "finished": True or False, # Optional. The bool indicates the end of the transcription.
+          "text": "A String", # Optional. Transcription text.
+        },
+        "interrupted": True or False, # Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.
+        "longRunningToolIds": [ # Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event.
+          "A String",
+        ],
+        "outputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of model output.
+          "finished": True or False, # Optional. The bool indicates the end of the transcription.
+          "text": "A String", # Optional. Transcription text.
+        },
+        "partial": True or False, # Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text.
+        "turnComplete": True or False, # Optional. Indicates whether the response from the model is complete. Only used for streaming mode.
+      },
+      "invocationId": "A String", # Required. The invocation id of the event, multiple events can have the same invocation id.
+      "name": "A String", # Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`.
+      "rawEvent": { # Optional. Weakly typed raw event data in proto struct format.
+        "a_key": "", # Properties of the object.
+      },
+      "timestamp": "A String", # Required. Timestamp when the event was created on client side.
+    },
+  ],
+  "name": "A String", # Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}/feedbackContext`
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists FeedbackEntries in a ReasoningEngine.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine from which to list FeedbackEntries. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. Standard list filter. Supported fields: * `session_id` * `user_id` * `feedback_type` * `feedback_labels`: Supports the HAS operator (`:`). For example: `feedback_labels:"inaccurate"`. * `create_time` * `update_time` Example: `feedback_type="THUMBS_DOWN" AND feedback_labels:"hallucination"`.
+  orderBy: string, Optional. A comma-separated list of fields to order results by, sorted in ascending order by default. Append ` desc` after a field name to sort that field in descending order. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.
+  pageSize: integer, Optional. The maximum number of FeedbackEntries to return per page.
+  pageToken: string, Optional. A page token, received from a previous ListFeedbackEntries 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 ListFeedbackEntries.
+  "feedbackEntries": [ # The page of FeedbackEntries matching the request.
+    { # FeedbackEntry is a resource that represents a user's feedback on a conversation with an agent.
+      "createTime": "A String", # Output only. The time at which the entry was created.
+      "customMetadata": { # Optional. Additional key-value metadata associated with the feedback.
+        "a_key": "A String",
+      },
+      "eventId": "A String", # Required. The ID of the event within the session that the feedback relates to.
+      "feedbackLabels": [
+        "A String",
+      ],
+      "feedbackText": "A String", # Optional. Qualitative free-form comments provided by the user.
+      "feedbackType": "A String", # Required. The coarse-grained type of feedback provided by the user. Must be set to a value other than `FEEDBACK_TYPE_UNSPECIFIED`.
+      "name": "A String", # Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`
+      "sessionId": "A String", # Required. The ID of the session that the feedback relates to.
+      "source": "A String", # Optional. The surface that the feedback originated from.
+      "updateTime": "A String", # Output only. The time at which the entry was most recently updated.
+      "userId": "A String", # Optional. A caller-supplied identifier for the user who provided the feedback. The semantics of this field (for example whether it is an opaque token, a hashed value, or a user-visible identifier) are determined by the calling application.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates an existing FeedbackEntry. Only the fields specified in update_mask are modified. If the mask is empty, all mutable fields are replaced with the values supplied in the request.
+
+Args:
+  name: string, Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # FeedbackEntry is a resource that represents a user's feedback on a conversation with an agent.
+  "createTime": "A String", # Output only. The time at which the entry was created.
+  "customMetadata": { # Optional. Additional key-value metadata associated with the feedback.
+    "a_key": "A String",
+  },
+  "eventId": "A String", # Required. The ID of the event within the session that the feedback relates to.
+  "feedbackLabels": [
+    "A String",
+  ],
+  "feedbackText": "A String", # Optional. Qualitative free-form comments provided by the user.
+  "feedbackType": "A String", # Required. The coarse-grained type of feedback provided by the user. Must be set to a value other than `FEEDBACK_TYPE_UNSPECIFIED`.
+  "name": "A String", # Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`
+  "sessionId": "A String", # Required. The ID of the session that the feedback relates to.
+  "source": "A String", # Optional. The surface that the feedback originated from.
+  "updateTime": "A String", # Output only. The time at which the entry was most recently updated.
+  "userId": "A String", # Optional. A caller-supplied identifier for the user who provided the feedback. The semantics of this field (for example whether it is an opaque token, a hashed value, or a user-visible identifier) are determined by the calling application.
+}
+
+  updateMask: string, Optional. The field mask that controls which fields are updated. If unset or empty, all mutable fields of the FeedbackEntry are replaced with the values from feedback_entry.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ updateFeedbackContext(name, body=None, updateMask=None, x__xgafv=None) +
Updates the FeedbackContext associated with a FeedbackEntry. Only the fields specified in update_mask are modified. If the mask is empty, all mutable fields are replaced with the values supplied in the request.
+
+Args:
+  name: string, Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}/feedbackContext` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Feedback context is a resource that represents additional information about the conversation where the feedback was given, such as the conversation history, system instructions, etc. If provided, feedback context allows to correlate the feedback with the conversation, even if the original session is deleted or not available.
+  "contextEvents": [ # Optional. The session events from the originating session.
+    { # An event represents a message from either the user or agent.
+      "actions": { # Actions are parts of events that are executed by the agent. # Optional. Actions executed by the agent.
+        "artifactDelta": { # Optional. Indicates that the event is updating an artifact. key is the filename, value is the version.
+          "a_key": 42,
+        },
+        "escalate": True or False, # Optional. The agent is escalating to a higher level agent.
+        "requestedAuthConfigs": { # Optional. Will only be set by a tool response indicating tool request euc. Struct key is the function call id since one function call response (from model) could correspond to multiple function calls. Struct value is the required auth config, which can be another struct.
+          "a_key": "", # Properties of the object.
+        },
+        "skipSummarization": True or False, # Optional. If true, it won't call model to summarize function response. Only used for function_response event.
+        "stateDelta": { # Optional. Indicates that the event is updating the state with the given delta.
+          "a_key": "", # Properties of the object.
+        },
+        "transferAgent": "A String", # Optional. If set, the event transfers to the specified agent.
+      },
+      "author": "A String", # Required. The name of the agent that sent the event, or user.
+      "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Content of the event provided by the author.
+        "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+          { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+            "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data.
+              "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set.
+              "text": "A String", # Required. The transcription text of this audio segment.
+              "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set.
+                { # Information about a single recognized word.
+                  "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio.
+                  "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio.
+                  "word": "A String", # Required. Transcript of the word.
+                },
+              ],
+            },
+            "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+              "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.
+              "outcome": "A String", # Required. Outcome of the code execution.
+              "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+            },
+            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+              "code": "A String", # Required. The code to be executed.
+              "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.
+              "language": "A String", # Required. Programming language of the `code`.
+            },
+            "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+              "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+              "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+            },
+            "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+              "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                "a_key": "", # Properties of the object.
+              },
+              "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+              "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+              "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                { # Partial argument value of the function call.
+                  "boolValue": True or False, # Optional. Represents a boolean value.
+                  "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                  "nullValue": "A String", # Optional. Represents a null value.
+                  "numberValue": 3.14, # Optional. Represents a double value.
+                  "stringValue": "A String", # Optional. Represents a string value.
+                  "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                },
+              ],
+              "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+            },
+            "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+              "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+              "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+              "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                  "fileData": { # URI based data for function response. # URI based data.
+                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "fileUri": "A String", # Required. URI.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                    "data": "A String", # Required. Raw bytes.
+                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                },
+              ],
+              "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                "a_key": "", # Properties of the object.
+              },
+              "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+            },
+            "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+              "data": "A String", # Required. The raw bytes of the data.
+              "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+            },
+            "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+              "level": "A String", # The tokenization quality used for given media.
+            },
+            "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+            "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+            "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+            "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+              "endOffset": "A String", # Optional. The end offset of the video.
+              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+              "startOffset": "A String", # Optional. The start offset of the video.
+            },
+          },
+        ],
+        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+      },
+      "errorCode": "A String", # Optional. Error code if the response is an error. Code varies by model.
+      "errorMessage": "A String", # Optional. Error message if the response is an error.
+      "eventMetadata": { # Metadata relating to a LLM response event. # Optional. Metadata relating to this event.
+        "branch": "A String", # Optional. The branch of the event. The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3. Branch is used when multiple child agents shouldn't see their siblings' conversation history.
+        "customMetadata": { # The custom metadata of the LlmResponse.
+          "a_key": "", # Properties of the object.
+        },
+        "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Optional. Metadata returned to client when grounding is enabled.
+          "googleMapsWidgetContextToken": "A String", # Optional. Output only. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and will no longer be populated once removed. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.
+          "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.
+            { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.
+              "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details.
+                "domain": "A String", # The domain of the image search result page.
+                "imageUri": "A String", # The URI of the image.
+                "sourceUri": "A String", # The URI of the image search result page.
+                "title": "A String", # The title of the image search result page.
+              },
+              "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details.
+                "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.
+                  "reviewSnippets": [ # Snippets of reviews that were used to generate the answer.
+                    { # A review snippet that is used to generate the answer.
+                      "googleMapsUri": "A String", # A link to show the review on Google Maps.
+                      "reviewId": "A String", # The ID of the review that is being referenced.
+                      "title": "A String", # The title of the review.
+                    },
+                  ],
+                },
+                "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.
+                "route": { # Route information from Google Maps. # Output only. Route information.
+                  "distanceMeters": 42, # The total distance of the route, in meters.
+                  "duration": "A String", # The total duration of the route.
+                  "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm
+                },
+                "text": "A String", # The text of the place answer.
+                "title": "A String", # The title of the place.
+                "uri": "A String", # The URI of the place.
+              },
+              "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details
+                "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
+                "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used.
+                  "chunkId": "A String", # The ID of the chunk.
+                  "fileId": "A String", # The ID of the file that the chunk belongs to.
+                  "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
+                    "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
+                    "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
+                  },
+                  "text": "A String", # The content of the chunk.
+                },
+                "text": "A String", # The content of the retrieved data source.
+                "title": "A String", # The title of the retrieved data source.
+                "uri": "A String", # The URI of the retrieved data source.
+              },
+              "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details.
+                "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.
+                "title": "A String", # The title of the web page that contains the evidence.
+                "uri": "A String", # The URI of the web page that contains the evidence.
+              },
+            },
+          ],
+          "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.
+            { # A collection of supporting references for a segment or part of the model's response.
+              "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.
+                3.14,
+              ],
+              "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.
+                42,
+              ],
+              "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message.
+                42,
+              ],
+              "segment": { # A segment of the content. # The content segment that this support message applies to.
+                "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.
+                "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.
+                "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.
+                "text": "A String", # Output only. The text of the segment.
+              },
+            },
+          ],
+          "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled.
+            "A String",
+          ],
+          "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source.
+            "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.
+          },
+          "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.
+            "A String",
+          ],
+          "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search.
+            "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.
+            "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.
+          },
+          "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.
+            { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.
+              "flagContentUri": "A String", # The URI that can be used to flag the content.
+              "sourceId": "A String", # The ID of the place or review.
+            },
+          ],
+          "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.
+            "A String",
+          ],
+        },
+        "inputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of user input.
+          "finished": True or False, # Optional. The bool indicates the end of the transcription.
+          "text": "A String", # Optional. Transcription text.
+        },
+        "interrupted": True or False, # Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.
+        "longRunningToolIds": [ # Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event.
+          "A String",
+        ],
+        "outputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of model output.
+          "finished": True or False, # Optional. The bool indicates the end of the transcription.
+          "text": "A String", # Optional. Transcription text.
+        },
+        "partial": True or False, # Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text.
+        "turnComplete": True or False, # Optional. Indicates whether the response from the model is complete. Only used for streaming mode.
+      },
+      "invocationId": "A String", # Required. The invocation id of the event, multiple events can have the same invocation id.
+      "name": "A String", # Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`.
+      "rawEvent": { # Optional. Weakly typed raw event data in proto struct format.
+        "a_key": "", # Properties of the object.
+      },
+      "timestamp": "A String", # Required. Timestamp when the event was created on client side.
+    },
+  ],
+  "name": "A String", # Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}/feedbackContext`
+}
+
+  updateMask: string, Optional. The field mask that controls which fields are updated. If unset or empty, all mutable fields of the FeedbackContext are replaced with the values from feedback_context.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index ff0ba9822e..4d63ed8c95 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -275,12 +275,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -400,6 +413,7 @@

Method Details

"schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. { # Schema configuration for structured memories. "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "jsonSchema": "", # Optional. Represents the JSON Schema of the structured memories. "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. "schema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. @@ -475,6 +489,7 @@

Method Details

}, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -484,6 +499,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. @@ -735,12 +751,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -860,6 +889,7 @@

Method Details

"schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. { # Schema configuration for structured memories. "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "jsonSchema": "", # Optional. Represents the JSON Schema of the structured memories. "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. "schema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. @@ -935,6 +965,7 @@

Method Details

}, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -944,6 +975,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. @@ -1126,12 +1158,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1251,6 +1296,7 @@

Method Details

"schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. { # Schema configuration for structured memories. "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "jsonSchema": "", # Optional. Represents the JSON Schema of the structured memories. "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. "schema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. @@ -1326,6 +1372,7 @@

Method Details

}, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -1335,6 +1382,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. @@ -1487,12 +1535,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1612,6 +1673,7 @@

Method Details

"schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. { # Schema configuration for structured memories. "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "jsonSchema": "", # Optional. Represents the JSON Schema of the structured memories. "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. "schema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. @@ -1687,6 +1749,7 @@

Method Details

}, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -1696,6 +1759,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html index 47f5631b76..cef71c5d6a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html @@ -266,12 +266,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single piece of content from which to generate memories. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -482,12 +495,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html index 3a725be8ff..923e15023b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html @@ -169,6 +169,7 @@

Method Details

}, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -178,6 +179,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. @@ -304,6 +306,7 @@

Method Details

}, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -313,6 +316,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html index 84247618b8..41750a8f65 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html @@ -146,7 +146,16 @@

Method Details

}, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. + "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into. + "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC. + { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC. + "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. + "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. + "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. + }, + ], "internetAccess": True or False, # Optional. Whether to allow internet access. + "networkAttachment": "A String", # Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress. }, "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. @@ -265,7 +274,16 @@

Method Details

}, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. + "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into. + "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC. + { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC. + "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. + "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. + "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. + }, + ], "internetAccess": True or False, # Optional. Whether to allow internet access. + "networkAttachment": "A String", # Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress. }, "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. @@ -327,7 +345,16 @@

Method Details

}, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. + "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into. + "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC. + { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC. + "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. + "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. + "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. + }, + ], "internetAccess": True or False, # Optional. Whether to allow internet access. + "networkAttachment": "A String", # Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress. }, "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. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html index ec7c7ce32d..8ececcdfb1 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html @@ -129,12 +129,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Content of the event provided by the author. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html index 9bd2b05cee..72e0660db0 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html @@ -137,12 +137,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Content of the event provided by the author. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html index c95d8c5959..961cfdc257 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html @@ -476,6 +476,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -515,6 +520,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, "notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob. @@ -1190,6 +1204,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -1229,6 +1248,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, "notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob. @@ -1946,6 +1974,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -1985,6 +2018,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, "notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob. @@ -2674,6 +2716,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -2713,6 +2760,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, "notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob. @@ -3406,6 +3462,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -3445,6 +3506,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, "notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob. @@ -4121,6 +4191,11 @@

Method Details

"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, + "shieldedInstanceConfig": { # A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. # Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + "enableIntegrityMonitoring": True or False, # Optional. Whether the VM instance has integrity monitoring enabled. + "enableSecureBoot": True or False, # Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + "enableVtpm": True or False, # Optional. Whether the VM instance has vTPM enabled. + }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD. @@ -4160,6 +4235,15 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated. "workbenchRuntime": { # Configuration for a Workbench Instances-based environment. # The Workbench runtime configuration to use for the notebook execution. + "customContainerImage": { # The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. # A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`. + "tag": "A String", # Optional. The tag of the container image. If unset, defaults to `latest`. + }, + "vmImage": { # The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. # A specific Compute Engine VM image to run the notebook on. + "family": "A String", # Use this VM image family to find the image; the newest image in this family is used. + "name": "A String", # Use this VM image name to find the image. + "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`. + }, }, }, "notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicyEngine.html b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicyEngine.html index b6caa0094b..70749aa6c3 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicyEngine.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicyEngine.html @@ -96,6 +96,7 @@

Method Details

The object takes the form of: { # Request message for SemanticGovernancePolicyEngineService.DeprovisionSemanticGovernancePolicyEngine. + "force": True or False, # Optional. If true, the operation bypass checks on current state and force the deprovisioning operation. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.servingProfiles.html b/docs/dyn/aiplatform_v1beta1.projects.locations.servingProfiles.html index 44d99447e6..c9685a190f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.servingProfiles.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.servingProfiles.html @@ -82,10 +82,225 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates a ServingProfile.

+

+ delete(name, x__xgafv=None)

+

Deletes a ServingProfile.

+

+ get(name, x__xgafv=None)

+

Gets a ServingProfile.

+

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

+

Lists ServingProfiles in a Location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a ServingProfile.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, servingProfileId=None, x__xgafv=None) +
Creates a ServingProfile.
+
+Args:
+  parent: string, Required. The resource name of the Location to create the ServingProfile in. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Configures the serving behavior for a resource-less GenAI serving.
+  "cmekConfig": { # Configuration for Customer-Managed Encryption Keys (CMEK). # CMEK configuration for the ServingProfile.
+    "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Required. The customer-managed encryption key spec for the Serving Profile.
+      "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+    },
+  },
+  "createTime": "A String", # Output only. Timestamp when the ServingProfile was created.
+  "description": "A String", # Optional. The description of the ServingProfile.
+  "displayName": "A String", # Required. The display name of the ServingProfile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "name": "A String", # Identifier. The resource name of the ServingProfile.
+  "scope": "A String", # Required. The specific API this ServingProfile applies to.
+  "updateTime": "A String", # Output only. Timestamp when the ServingProfile was last updated.
+}
+
+  servingProfileId: string, Required. The ID to use for the ServingProfile, which will become the final component of the ServingProfile's resource name. This value should be 1-63 characters, and valid characters are `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a ServingProfile.
+
+Args:
+  name: string, Required. The name of the ServingProfile resource to be deleted. Format: `projects/{project}/locations/{location}/servingProfiles/{serving_profile}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a ServingProfile.
+
+Args:
+  name: string, Required. The name of the ServingProfile resource. Format: `projects/{project}/locations/{location}/servingProfiles/{serving_profile}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configures the serving behavior for a resource-less GenAI serving.
+  "cmekConfig": { # Configuration for Customer-Managed Encryption Keys (CMEK). # CMEK configuration for the ServingProfile.
+    "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Required. The customer-managed encryption key spec for the Serving Profile.
+      "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+    },
+  },
+  "createTime": "A String", # Output only. Timestamp when the ServingProfile was created.
+  "description": "A String", # Optional. The description of the ServingProfile.
+  "displayName": "A String", # Required. The display name of the ServingProfile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "name": "A String", # Identifier. The resource name of the ServingProfile.
+  "scope": "A String", # Required. The specific API this ServingProfile applies to.
+  "updateTime": "A String", # Output only. Timestamp when the ServingProfile was last updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists ServingProfiles in a Location.
+
+Args:
+  parent: string, Required. The resource name of the Location to list the ServingProfiles from. Format: `projects/{project}/locations/{location}` (required)
+  pageSize: integer, Optional. The standard list page size. If unspecified, at most 100 ServingProfiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ServingProfileService.ListServingProfiles.
+  "nextPageToken": "A String", # Output only. A token to retrieve the next page of results.
+  "servingProfiles": [ # Output only. A list of ServingProfiles.
+    { # Configures the serving behavior for a resource-less GenAI serving.
+      "cmekConfig": { # Configuration for Customer-Managed Encryption Keys (CMEK). # CMEK configuration for the ServingProfile.
+        "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Required. The customer-managed encryption key spec for the Serving Profile.
+          "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+        },
+      },
+      "createTime": "A String", # Output only. Timestamp when the ServingProfile was created.
+      "description": "A String", # Optional. The description of the ServingProfile.
+      "displayName": "A String", # Required. The display name of the ServingProfile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+      "name": "A String", # Identifier. The resource name of the ServingProfile.
+      "scope": "A String", # Required. The specific API this ServingProfile applies to.
+      "updateTime": "A String", # Output only. Timestamp when the ServingProfile was last updated.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a ServingProfile.
+
+Args:
+  name: string, Identifier. The resource name of the ServingProfile. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Configures the serving behavior for a resource-less GenAI serving.
+  "cmekConfig": { # Configuration for Customer-Managed Encryption Keys (CMEK). # CMEK configuration for the ServingProfile.
+    "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Required. The customer-managed encryption key spec for the Serving Profile.
+      "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+    },
+  },
+  "createTime": "A String", # Output only. Timestamp when the ServingProfile was created.
+  "description": "A String", # Optional. The description of the ServingProfile.
+  "displayName": "A String", # Required. The display name of the ServingProfile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "name": "A String", # Identifier. The resource name of the ServingProfile.
+  "scope": "A String", # Required. The specific API this ServingProfile applies to.
+  "updateTime": "A String", # Output only. Timestamp when the ServingProfile was last updated.
+}
+
+  updateMask: string, Optional. The list of fields to update; see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. If omitted, all populated (non-empty) mutable fields are updated; if set to `["*"]`, all mutable fields are fully replaced (unpopulated values are cleared).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configures the serving behavior for a resource-less GenAI serving.
+  "cmekConfig": { # Configuration for Customer-Managed Encryption Keys (CMEK). # CMEK configuration for the ServingProfile.
+    "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Required. The customer-managed encryption key spec for the Serving Profile.
+      "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+    },
+  },
+  "createTime": "A String", # Output only. Timestamp when the ServingProfile was created.
+  "description": "A String", # Optional. The description of the ServingProfile.
+  "displayName": "A String", # Required. The display name of the ServingProfile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "name": "A String", # Identifier. The resource name of the ServingProfile.
+  "scope": "A String", # Required. The specific API this ServingProfile applies to.
+  "updateTime": "A String", # Output only. Timestamp when the ServingProfile was last updated.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.trainingPipelines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.trainingPipelines.html index a39d0469d2..798fdeeaf7 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.trainingPipelines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.trainingPipelines.html @@ -216,7 +216,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -613,7 +613,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -1052,7 +1052,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], @@ -1463,7 +1463,7 @@

Method Details

"step": "A String", # The step of the checkpoint. }, ], - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index 701560e708..66c461d5ac 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -307,6 +307,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -502,6 +519,7 @@

Method Details

"learningRateMultiplier": 3.14, # Optional. Learning rate multiplier for Reinforcement Tuning. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate per prompt. Default to 32768. "samplesPerPrompt": 42, # Optional. Number of different responses to generate per prompt during tuning. + "stepCount": "A String", # Optional. Number of steps for the tuning job (mutually exclusive with epoch_count). "thinkingBudget": 42, # Optional. The thinking budget for the tuning job to optimize for (Gemini 2.5 only). * -1 means dynamic thinking * 0 means no thinking * > 0 means thinking budget in tokens If not set, default to -1 (dynamic thinking). "thinkingLevel": "A String", # Indicates the maximum thinking depth during tuning. Starting from Gemini 3.5 models, the old thinking_budget will no longer be supported and will result in a user error if set. Instead, users should use the thinking_level parameter to control the maximum thinking depth. }, @@ -512,6 +530,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -709,6 +744,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -859,6 +911,23 @@

Method Details

], "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1027,6 +1096,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1187,6 +1273,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1442,12 +1545,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1522,12 +1638,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Corresponds to system_instruction in user-facing GenerateContentRequest. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1607,12 +1736,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1780,12 +1922,25 @@

Method Details

"completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1860,12 +2015,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1999,12 +2167,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2079,12 +2260,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Corresponds to system_instruction in user-facing GenerateContentRequest. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2164,12 +2358,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2304,12 +2511,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2631,6 +2851,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -2826,6 +3063,7 @@

Method Details

"learningRateMultiplier": 3.14, # Optional. Learning rate multiplier for Reinforcement Tuning. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate per prompt. Default to 32768. "samplesPerPrompt": 42, # Optional. Number of different responses to generate per prompt during tuning. + "stepCount": "A String", # Optional. Number of steps for the tuning job (mutually exclusive with epoch_count). "thinkingBudget": 42, # Optional. The thinking budget for the tuning job to optimize for (Gemini 2.5 only). * -1 means dynamic thinking * 0 means no thinking * > 0 means thinking budget in tokens If not set, default to -1 (dynamic thinking). "thinkingLevel": "A String", # Indicates the maximum thinking depth during tuning. Starting from Gemini 3.5 models, the old thinking_budget will no longer be supported and will result in a user error if set. Instead, users should use the thinking_level parameter to control the maximum thinking depth. }, @@ -2836,6 +3074,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3033,6 +3288,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3183,6 +3455,23 @@

Method Details

], "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3351,6 +3640,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3511,6 +3817,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3766,12 +4089,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3846,12 +4182,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Corresponds to system_instruction in user-facing GenerateContentRequest. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3931,12 +4280,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4104,12 +4466,25 @@

Method Details

"completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4184,12 +4559,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4323,12 +4711,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4403,12 +4804,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Corresponds to system_instruction in user-facing GenerateContentRequest. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4488,12 +4902,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4628,12 +5055,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4962,6 +5402,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5157,6 +5614,7 @@

Method Details

"learningRateMultiplier": 3.14, # Optional. Learning rate multiplier for Reinforcement Tuning. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate per prompt. Default to 32768. "samplesPerPrompt": 42, # Optional. Number of different responses to generate per prompt during tuning. + "stepCount": "A String", # Optional. Number of steps for the tuning job (mutually exclusive with epoch_count). "thinkingBudget": 42, # Optional. The thinking budget for the tuning job to optimize for (Gemini 2.5 only). * -1 means dynamic thinking * 0 means no thinking * > 0 means thinking budget in tokens If not set, default to -1 (dynamic thinking). "thinkingLevel": "A String", # Indicates the maximum thinking depth during tuning. Starting from Gemini 3.5 models, the old thinking_budget will no longer be supported and will result in a user error if set. Instead, users should use the thinking_level parameter to control the maximum thinking depth. }, @@ -5167,6 +5625,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5364,6 +5839,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5514,6 +6006,23 @@

Method Details

], "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5682,6 +6191,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -5842,6 +6368,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -6097,12 +6640,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6177,12 +6733,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Corresponds to system_instruction in user-facing GenerateContentRequest. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6262,12 +6831,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6435,12 +7017,25 @@

Method Details

"completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6515,12 +7110,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6654,12 +7262,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6734,12 +7355,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Corresponds to system_instruction in user-facing GenerateContentRequest. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6819,12 +7453,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -6959,12 +7606,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -7299,6 +7959,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -7494,6 +8171,7 @@

Method Details

"learningRateMultiplier": 3.14, # Optional. Learning rate multiplier for Reinforcement Tuning. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate per prompt. Default to 32768. "samplesPerPrompt": 42, # Optional. Number of different responses to generate per prompt during tuning. + "stepCount": "A String", # Optional. Number of steps for the tuning job (mutually exclusive with epoch_count). "thinkingBudget": 42, # Optional. The thinking budget for the tuning job to optimize for (Gemini 2.5 only). * -1 means dynamic thinking * 0 means no thinking * > 0 means thinking budget in tokens If not set, default to -1 (dynamic thinking). "thinkingLevel": "A String", # Indicates the maximum thinking depth during tuning. Starting from Gemini 3.5 models, the old thinking_budget will no longer be supported and will result in a user error if set. Instead, users should use the thinking_level parameter to control the maximum thinking depth. }, @@ -7504,6 +8182,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -7701,6 +8396,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -7851,6 +8563,23 @@

Method Details

], "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -8019,6 +8748,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -8179,6 +8925,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -8434,12 +9197,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8514,12 +9290,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Corresponds to system_instruction in user-facing GenerateContentRequest. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8599,12 +9388,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8772,12 +9574,25 @@

Method Details

"completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8852,12 +9667,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -8991,12 +9819,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9071,12 +9912,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Corresponds to system_instruction in user-facing GenerateContentRequest. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9156,12 +10010,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9296,12 +10163,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9486,12 +10366,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the prompt to optimize. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9574,12 +10467,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The optimized prompt. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -9882,6 +10788,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -10077,6 +11000,7 @@

Method Details

"learningRateMultiplier": 3.14, # Optional. Learning rate multiplier for Reinforcement Tuning. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate per prompt. Default to 32768. "samplesPerPrompt": 42, # Optional. Number of different responses to generate per prompt during tuning. + "stepCount": "A String", # Optional. Number of steps for the tuning job (mutually exclusive with epoch_count). "thinkingBudget": 42, # Optional. The thinking budget for the tuning job to optimize for (Gemini 2.5 only). * -1 means dynamic thinking * 0 means no thinking * > 0 means thinking budget in tokens If not set, default to -1 (dynamic thinking). "thinkingLevel": "A String", # Indicates the maximum thinking depth during tuning. Starting from Gemini 3.5 models, the old thinking_budget will no longer be supported and will result in a user error if set. Instead, users should use the thinking_level parameter to control the maximum thinking depth. }, @@ -10087,6 +11011,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -10284,6 +11225,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -10434,6 +11392,23 @@

Method Details

], "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -10602,6 +11577,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -10762,6 +11754,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -11017,12 +12026,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11097,12 +12119,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Corresponds to system_instruction in user-facing GenerateContentRequest. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11182,12 +12217,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11355,12 +12403,25 @@

Method Details

"completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11435,12 +12496,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11574,12 +12648,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11654,12 +12741,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Corresponds to system_instruction in user-facing GenerateContentRequest. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11739,12 +12839,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -11879,12 +12992,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -12089,6 +13215,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -12280,12 +13423,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -12360,12 +13516,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Corresponds to system_instruction in user-facing GenerateContentRequest. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -12437,12 +13606,25 @@

Method Details

"sampleResponse": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The sample response for validating the reward configuration. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -12517,6 +13699,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 042f1507af..44f1b6363a 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -127,12 +127,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -244,12 +257,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -320,6 +346,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -467,12 +510,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -652,6 +708,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -852,12 +914,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -928,6 +1003,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1085,12 +1177,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1286,6 +1391,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1440,12 +1551,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3050,12 +3174,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3126,6 +3263,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3283,12 +3437,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3484,6 +3651,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -3638,12 +3811,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html index 785556ac2c..d41392c479 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html @@ -260,12 +260,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -385,6 +398,7 @@

Method Details

"schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. { # Schema configuration for structured memories. "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "jsonSchema": "", # Optional. Represents the JSON Schema of the structured memories. "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. "schema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. @@ -460,6 +474,7 @@

Method Details

}, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -469,6 +484,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. @@ -721,12 +737,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -846,6 +875,7 @@

Method Details

"schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. { # Schema configuration for structured memories. "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "jsonSchema": "", # Optional. Represents the JSON Schema of the structured memories. "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. "schema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. @@ -921,6 +951,7 @@

Method Details

}, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -930,6 +961,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. @@ -1077,12 +1109,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1202,6 +1247,7 @@

Method Details

"schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. { # Schema configuration for structured memories. "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "jsonSchema": "", # Optional. Represents the JSON Schema of the structured memories. "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. "schema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. @@ -1277,6 +1323,7 @@

Method Details

}, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -1286,6 +1333,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. @@ -1438,12 +1486,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Represents the content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1563,6 +1624,7 @@

Method Details

"schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. { # Schema configuration for structured memories. "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "jsonSchema": "", # Optional. Represents the JSON Schema of the structured memories. "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. "schema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. @@ -1638,6 +1700,7 @@

Method Details

}, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. @@ -1647,6 +1710,7 @@

Method Details

], "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands. "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. + "port": 42, # Optional. The port the container listens on. Defaults to 8080 if unset. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html index 57a6cd3b62..0ed45baf4b 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html @@ -266,12 +266,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single piece of content from which to generate memories. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -482,12 +495,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html index 8d5df403ca..632220d0ad 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html @@ -146,7 +146,16 @@

Method Details

}, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. + "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into. + "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC. + { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC. + "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. + "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. + "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. + }, + ], "internetAccess": True or False, # Optional. Whether to allow internet access. + "networkAttachment": "A String", # Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress. }, "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. @@ -265,7 +274,16 @@

Method Details

}, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. + "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into. + "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC. + { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC. + "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. + "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. + "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. + }, + ], "internetAccess": True or False, # Optional. Whether to allow internet access. + "networkAttachment": "A String", # Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress. }, "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. @@ -327,7 +345,16 @@

Method Details

}, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. + "customerVpcNetwork": "A String", # Optional. The customer VPC network that sandbox egress is routed into. + "dnsPeeringConfigs": [ # Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC. + { # Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC. + "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. + "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. + "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. + }, + ], "internetAccess": True or False, # Optional. Whether to allow internet access. + "networkAttachment": "A String", # Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress. }, "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. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html index 3a8e6643f3..b4736d67cc 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html @@ -129,12 +129,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Content of the event provided by the author. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html index bd833235f4..6c0ec50625 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html @@ -137,12 +137,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Content of the event provided by the author. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/docs/dyn/aiplatform_v1beta1.v1beta1.html b/docs/dyn/aiplatform_v1beta1.v1beta1.html index 7e5f79ea93..195acef704 100644 --- a/docs/dyn/aiplatform_v1beta1.v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.v1beta1.html @@ -106,6 +106,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -287,6 +304,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -447,6 +481,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -689,6 +740,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -910,12 +978,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1103,6 +1184,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1238,12 +1325,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1431,6 +1531,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1562,12 +1668,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1644,12 +1763,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1832,6 +1964,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2071,6 +2209,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2196,12 +2340,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2402,6 +2559,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2641,6 +2804,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2766,12 +2935,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2858,12 +3040,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -2943,12 +3138,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3026,12 +3234,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3109,12 +3330,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -3235,6 +3469,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3395,6 +3646,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3617,6 +3885,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3777,6 +4062,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -3990,12 +4292,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4114,12 +4429,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4753,12 +5081,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -4946,6 +5287,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -5074,12 +5421,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -5162,6 +5522,23 @@

Method Details

"flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index aad338ba3b..73bb409b8c 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -15805,6 +15805,12 @@ "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Optional. The update mask applies to the resource. The supported paths are `automatic_resources`, `dedicated_resources`, `enable_access_logging` and `deployed_index_auth_config`. When omitted, the service will perform a full update of all fields. See google.protobuf.FieldMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, "path": "v1/{+indexEndpoint}:mutateDeployedIndex", @@ -16446,29 +16452,30 @@ } }, "memoryBanks": { -"resources": { -"memories": { "methods": { -"get": { -"description": "Get a Memory.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.memoryBanks.memories.get", +"ingestEvents": { +"description": "Ingests events for a Memory Bank.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}:ingestEvents", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.ingestEvents", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"parent": { +"description": "Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+parent}:ingestEvents", +"request": { +"$ref": "GoogleCloudAiplatformV1IngestEventsRequest" +}, "response": { -"$ref": "GoogleCloudAiplatformV1Memory" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -16476,171 +16483,292 @@ } }, "resources": { -"operations": { +"memories": { "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}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", +"create": { +"description": "Create a Memory.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories", "httpMethod": "POST", -"id": "aiplatform.projects.locations.memoryBanks.memories.operations.cancel", +"id": "aiplatform.projects.locations.memoryBanks.memories.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"memoryId": { +"description": "Optional. The user defined ID to use for memory, which will become the final component of the memory 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 ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:cancel", +"path": "v1/{+parent}/memories", +"request": { +"$ref": "GoogleCloudAiplatformV1Memory" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", +"description": "Delete a Memory.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.memoryBanks.memories.operations.delete", +"id": "aiplatform.projects.locations.memoryBanks.memories.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"generate": { +"description": "Generate memories.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:generate", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.memories.generate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/memories:generate", +"request": { +"$ref": "GoogleCloudAiplatformV1GenerateMemoriesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", +"description": "Get a Memory.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.memoryBanks.memories.operations.get", +"id": "aiplatform.projects.locations.memoryBanks.memories.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1Memory" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", +"description": "List Memories.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories", "httpMethod": "GET", -"id": "aiplatform.projects.locations.memoryBanks.memories.operations.list", +"id": "aiplatform.projects.locations.memoryBanks.memories.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { "filter": { -"description": "The standard list filter.", +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)", "location": "query", "type": "string" }, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", -"required": true, +"orderBy": { +"description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", +"location": "query", "type": "string" }, "pageSize": { -"description": "The standard list page size.", +"description": "Optional. The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "Optional. The standard list page token.", "location": "query", "type": "string" }, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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" +"parent": { +"description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1/{+name}/operations", +"path": "v1/{+parent}/memories", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAiplatformV1ListMemoriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.memoryBanks.memories.operations.wait", +"patch": { +"description": "Update a Memory.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.memoryBanks.memories.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to wait on.", +"description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" }, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", +"updateMask": { +"description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", +"format": "google-fieldmask", "location": "query", "type": "string" } }, -"path": "v1/{+name}:wait", +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1Memory" +}, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"purge": { +"description": "Purge memories.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:purge", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.memories.purge", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", +"required": true, +"type": "string" } +}, +"path": "v1/{+parent}/memories:purge", +"request": { +"$ref": "GoogleCloudAiplatformV1PurgeMemoriesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"retrieve": { +"description": "Retrieve memories.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:retrieve", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.memories.retrieve", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", +"required": true, +"type": "string" } +}, +"path": "v1/{+parent}/memories:retrieve", +"request": { +"$ref": "GoogleCloudAiplatformV1RetrieveMemoriesRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1RetrieveMemoriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"rollback": { +"description": "Rollback Memory to a specific revision.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}:rollback", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.memories.rollback", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" } +}, +"path": "v1/{+name}:rollback", +"request": { +"$ref": "GoogleCloudAiplatformV1RollbackMemoryRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, +"resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.memoryBanks.operations.cancel", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.cancel", "parameterOrder": [ "name" ], @@ -16648,7 +16776,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16663,9 +16791,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.memoryBanks.operations.delete", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.delete", "parameterOrder": [ "name" ], @@ -16673,7 +16801,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16688,9 +16816,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.memoryBanks.operations.get", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.get", "parameterOrder": [ "name" ], @@ -16698,7 +16826,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16713,9 +16841,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.memoryBanks.operations.list", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.list", "parameterOrder": [ "name" ], @@ -16728,7 +16856,235 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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/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}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"revisions": { +"methods": { +"get": { +"description": "Get a Memory Revision.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions/{revisionsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.memoryBanks.memories.revisions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1MemoryRevision" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "List Memory Revisions for a Memory.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.memoryBanks.memories.revisions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/revisions", +"response": { +"$ref": "GoogleCloudAiplatformV1ListMemoryRevisionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.memoryBanks.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/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}/memoryBanks/{memoryBanksId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.memoryBanks.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.memoryBanks.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/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" }, @@ -23066,6 +23422,84 @@ } } } +}, +"v1": { +"methods": { +"responses": { +"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.publishers.v1.responses", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"deployedModelId": { +"description": "ID of the DeployedModel that serves the invoke request.", +"location": "query", +"type": "string" +}, +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+endpoint}/v1/responses", +"request": { +"$ref": "GoogleApiHttpBody" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +}, +"resources": { +"responses": { +"methods": { +"compact": { +"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses/compact", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.publishers.v1.responses.compact", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"deployedModelId": { +"description": "ID of the DeployedModel that serves the invoke request.", +"location": "query", +"type": "string" +}, +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+endpoint}/v1/responses/compact", +"request": { +"$ref": "GoogleApiHttpBody" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +} +} +} } } }, @@ -26884,6 +27318,166 @@ } } }, +"servingProfiles": { +"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}/servingProfiles/{servingProfilesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.servingProfiles.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.servingProfiles.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/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}/servingProfiles/{servingProfilesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.servingProfiles.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.servingProfiles.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/[^/]+/servingProfiles/[^/]+$", +"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/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}/servingProfiles/{servingProfilesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.servingProfiles.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "skills": { "resources": { "operations": { @@ -32693,9 +33287,171 @@ }, "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/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.sessions.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"schedules": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.schedules.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^schedules/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.schedules.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^schedules/[^/]+/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/schedules/{schedulesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.schedules.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^schedules/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/schedules/{schedulesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.schedules.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^schedules/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.sessions.operations.wait", +"id": "aiplatform.schedules.operations.wait", "parameterOrder": [ "name" ], @@ -32703,7 +33459,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", +"pattern": "^schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -32725,18 +33481,16 @@ } } } -} -} }, -"schedules": { +"semanticGovernancePolicies": { "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/schedules/{schedulesId}/operations/{operationsId}:cancel", +"flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.schedules.operations.cancel", +"id": "aiplatform.semanticGovernancePolicies.operations.cancel", "parameterOrder": [ "name" ], @@ -32744,7 +33498,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^schedules/[^/]+/operations/[^/]+$", +"pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32759,9 +33513,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}", +"flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.schedules.operations.delete", +"id": "aiplatform.semanticGovernancePolicies.operations.delete", "parameterOrder": [ "name" ], @@ -32769,7 +33523,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^schedules/[^/]+/operations/[^/]+$", +"pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32784,9 +33538,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}", +"flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.schedules.operations.get", +"id": "aiplatform.semanticGovernancePolicies.operations.get", "parameterOrder": [ "name" ], @@ -32794,7 +33548,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^schedules/[^/]+/operations/[^/]+$", +"pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32809,9 +33563,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/schedules/{schedulesId}/operations", +"flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations", "httpMethod": "GET", -"id": "aiplatform.schedules.operations.list", +"id": "aiplatform.semanticGovernancePolicies.operations.list", "parameterOrder": [ "name" ], @@ -32824,7 +33578,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^schedules/[^/]+$", +"pattern": "^semanticGovernancePolicies/[^/]+$", "required": true, "type": "string" }, @@ -32855,9 +33609,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}:wait", +"flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.schedules.operations.wait", +"id": "aiplatform.semanticGovernancePolicies.operations.wait", "parameterOrder": [ "name" ], @@ -32865,7 +33619,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^schedules/[^/]+/operations/[^/]+$", +"pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -32888,15 +33642,15 @@ } } }, -"semanticGovernancePolicies": { +"servingProfiles": { "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/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:cancel", +"flatPath": "v1/servingProfiles/{servingProfilesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.semanticGovernancePolicies.operations.cancel", +"id": "aiplatform.servingProfiles.operations.cancel", "parameterOrder": [ "name" ], @@ -32904,7 +33658,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", +"pattern": "^servingProfiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32919,9 +33673,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", +"flatPath": "v1/servingProfiles/{servingProfilesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.semanticGovernancePolicies.operations.delete", +"id": "aiplatform.servingProfiles.operations.delete", "parameterOrder": [ "name" ], @@ -32929,7 +33683,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", +"pattern": "^servingProfiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32944,9 +33698,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", +"flatPath": "v1/servingProfiles/{servingProfilesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.semanticGovernancePolicies.operations.get", +"id": "aiplatform.servingProfiles.operations.get", "parameterOrder": [ "name" ], @@ -32954,7 +33708,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", +"pattern": "^servingProfiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32969,9 +33723,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations", +"flatPath": "v1/servingProfiles/{servingProfilesId}/operations", "httpMethod": "GET", -"id": "aiplatform.semanticGovernancePolicies.operations.list", +"id": "aiplatform.servingProfiles.operations.list", "parameterOrder": [ "name" ], @@ -32984,7 +33738,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^semanticGovernancePolicies/[^/]+$", +"pattern": "^servingProfiles/[^/]+$", "required": true, "type": "string" }, @@ -33015,9 +33769,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait", +"flatPath": "v1/servingProfiles/{servingProfilesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.semanticGovernancePolicies.operations.wait", +"id": "aiplatform.servingProfiles.operations.wait", "parameterOrder": [ "name" ], @@ -33025,7 +33779,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", +"pattern": "^servingProfiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -34707,7 +35461,7 @@ } } }, -"revision": "20260703", +"revision": "20260725", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -34718,6 +35472,11 @@ "description": "Optional. If true, anchors the last frame in video generation by generating a custom border mask.", "type": "boolean" }, +"cfgScale": { +"description": "CFG scale for video-transform, perf-generation, a2v, video-textures models.", +"format": "float", +"type": "number" +}, "codec": { "description": "Optional. Video codec to use for output.", "enum": [ @@ -34734,6 +35493,10 @@ ], "type": "string" }, +"colorAlignment": { +"$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig", +"description": "Optional. Color alignment configuration." +}, "conditioningFrames": { "description": "Conditioning frames for veo experimental models ONLY, not to be confused with keyframes (ID:31) in GenerateVideoRequest.", "items": { @@ -34749,6 +35512,10 @@ "description": "Generic key-value pairs for experimental parameters. This allows adding new parameters without changing the dataplane binary.", "type": "object" }, +"exrColorSpaceOverride": { +"description": "Optional. Colorspace to be used for all EXR inputs.", +"type": "string" +}, "humanPose": { "$ref": "CloudAiLargeModelsVisionHumanPose", "description": "Human pose parameters for Pose Control" @@ -34762,6 +35529,10 @@ "format": "int32", "type": "integer" }, +"omniRewriter": { +"$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig", +"description": "Optional. Omni Rewriter configuration." +}, "originalRequestJson": { "description": "The original REST API request JSON sent by the user, in the instances/parameters format. Preserved for saving alongside output artifacts so users can reproduce their requests. This field is populated by the API handler and is not user-settable.", "type": "string" @@ -34782,6 +35553,10 @@ "$ref": "CloudAiLargeModelsVisionSeamless", "description": "Parameters for seamless (edge-continuous) video generation, enabling temporal looping and/or spatial tessellation." }, +"spatialAlignment": { +"$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig", +"description": "Optional. Spatial alignment configuration." +}, "truncateInputVideo": { "description": "If true (default), truncate input videos that exceed the model's maximum frame count by applying a frame_selection_config to __video_file__ inputs. Set to false to preserve the existing fail-fast behavior.", "type": "boolean" @@ -34798,6 +35573,17 @@ }, "type": "object" }, +"CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig": { +"description": "Configuration for color alignment.", +"id": "CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig", +"properties": { +"enable": { +"description": "Optional. If true, enable alignment.", +"type": "boolean" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame": { "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame", "properties": { @@ -34813,6 +35599,34 @@ }, "type": "object" }, +"CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig": { +"description": "Configuration for Omni Rewriter.", +"id": "CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig", +"properties": { +"maxChunkDuration": { +"description": "Optional. Maximum duration of a chunk in seconds.", +"format": "float", +"type": "number" +}, +"rewriterInputFps": { +"description": "Optional. FPS used to generate gemini chunks for video inputs.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig": { +"description": "Configuration for spatial alignment.", +"id": "CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig", +"properties": { +"enable": { +"description": "Optional. If true, enable alignment.", +"type": "boolean" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig": { "description": "Scheduling configuration for Veo Experimental.", "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig", @@ -36127,6 +36941,107 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1AudioTranscription": { +"description": "The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label.", +"id": "GoogleCloudAiplatformV1AudioTranscription", +"properties": { +"speakerLabel": { +"description": "Optional. A label identifying the speaker of this audio segment (e.g. \"spk_1\", \"spk_2\"). Present when diarization is set.", +"type": "string" +}, +"text": { +"description": "Required. The transcription text of this audio segment.", +"type": "string" +}, +"words": { +"description": "Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set.", +"items": { +"$ref": "GoogleCloudAiplatformV1AudioTranscriptionWordInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1AudioTranscriptionConfig": { +"description": "Configuration for speech recognition (transcription).", +"id": "GoogleCloudAiplatformV1AudioTranscriptionConfig", +"properties": { +"adaptationPhrases": { +"deprecated": true, +"description": "Optional. A list of phrases to bias the ASR model towards.", +"items": { +"type": "string" +}, +"type": "array" +}, +"customVocabulary": { +"description": "Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms.", +"items": { +"type": "string" +}, +"type": "array" +}, +"diarization": { +"description": "Optional. Configures speaker diarization.", +"type": "boolean" +}, +"languageAuto": { +"$ref": "GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto", +"description": "Optional. The model will detect the language automatically." +}, +"languageHints": { +"$ref": "GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints", +"description": "Optional. Specifies one or more languages in the audio." +}, +"wordTimestamp": { +"description": "Optional. Configures word-level timestamp generation.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto": { +"description": "Indicates the language of the audio should be automatically detected.", +"id": "GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto", +"properties": {}, +"type": "object" +}, +"GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints": { +"description": "Provides hints to the model about possible languages present in the audio.", +"id": "GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints", +"properties": { +"languageCodes": { +"description": "Required. BCP-47 language codes. At least one must be specified.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1AudioTranscriptionWordInfo": { +"description": "Information about a single recognized word.", +"id": "GoogleCloudAiplatformV1AudioTranscriptionWordInfo", +"properties": { +"endOffset": { +"description": "Optional. End offset in time of the word relative to the start of the audio.", +"format": "google-duration", +"type": "string" +}, +"startOffset": { +"description": "Optional. Start offset in time of the word relative to the start of the audio.", +"format": "google-duration", +"type": "string" +}, +"word": { +"description": "Required. Transcript of the word.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1AugmentPromptRequest": { "description": "Request message for AugmentPrompt.", "id": "GoogleCloudAiplatformV1AugmentPromptRequest", @@ -37820,6 +38735,10 @@ "description": "Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used.", "id": "GoogleCloudAiplatformV1CodeExecutionResult", "properties": { +"id": { +"description": "Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.", +"type": "string" +}, "outcome": { "description": "Required. Outcome of the code execution.", "enum": [ @@ -40357,7 +41276,12 @@ "GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest": { "description": "Request message for SemanticGovernancePolicyEngineService.DeprovisionSemanticGovernancePolicyEngine.", "id": "GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest", -"properties": {}, +"properties": { +"force": { +"description": "Optional. If true, the operation bypass checks on current state and force the deprovisioning operation.", +"type": "boolean" +} +}, "type": "object" }, "GoogleCloudAiplatformV1DestinationFeatureSetting": { @@ -41824,6 +42748,10 @@ "description": "Required. The user-friendly display name for the EvaluationMetric.", "type": "string" }, +"encryptionSpec": { +"$ref": "GoogleCloudAiplatformV1EncryptionSpec", +"description": "Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key." +}, "gcsUri": { "description": "Optional. The Google Cloud Storage URI that stores the metric specification..", "type": "string" @@ -42566,6 +43494,10 @@ "description": "Required. The display name of the EvaluationSet.", "type": "string" }, +"encryptionSpec": { +"$ref": "GoogleCloudAiplatformV1EncryptionSpec", +"description": "Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key." +}, "evaluationItems": { "description": "Required. The EvaluationItems that are part of this dataset.", "items": { @@ -42915,6 +43847,10 @@ "description": "Required. The code to be executed.", "type": "string" }, +"id": { +"description": "Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.", +"type": "string" +}, "language": { "description": "Required. Programming language of the `code`.", "enum": [ @@ -45568,6 +46504,10 @@ "description": "Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.", "type": "object" }, +"id": { +"description": "Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.", +"type": "string" +}, "name": { "description": "Optional. The name of the function to call. Matches FunctionDeclaration.name.", "type": "string" @@ -45671,6 +46611,10 @@ "description": "The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction.", "id": "GoogleCloudAiplatformV1FunctionResponse", "properties": { +"id": { +"description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.", +"type": "string" +}, "name": { "description": "Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.", "type": "string" @@ -45767,6 +46711,13 @@ "description": "Configuration for a single gateway.", "id": "GoogleCloudAiplatformV1GatewayConfig", "properties": { +"allowedProjects": { +"description": "Optional. Additional consumer projects permitted to attach their own PSC endpoint to this gateway's ServiceAttachment. This is the \"decoupled\" mode, where the customer creates the PSC endpoint in a project other than this gateway's `network` project. Each listed project is VPC-SC enforced: it must be within the caller's service perimeter. The owning SemanticGovernancePolicyEngine's own project is always permitted implicitly and need not be listed. Format: project ID or number.", +"items": { +"type": "string" +}, +"type": "array" +}, "dnsRecord": { "description": "Output only. The fully qualified record name of the created A-record in Cloud DNS.", "readOnly": true, @@ -46555,6 +47506,10 @@ "description": "Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.", "type": "boolean" }, +"audioTranscriptionConfig": { +"$ref": "GoogleCloudAiplatformV1AudioTranscriptionConfig", +"description": "Optional. Config for audio transcription (speech recognition)." +}, "candidateCount": { "description": "Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.", "format": "int32", @@ -46862,10 +47817,41 @@ "deprecated": true, "description": "Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response.", "type": "boolean" +}, +"groundingTypes": { +"$ref": "GoogleCloudAiplatformV1GoogleMapsGroundingTypes", +"description": "Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1GoogleMapsGroundingTypes": { +"description": "Defines the types of Google Maps grounding that can be enabled and their configurations.", +"id": "GoogleCloudAiplatformV1GoogleMapsGroundingTypes", +"properties": { +"places": { +"$ref": "GoogleCloudAiplatformV1GoogleMapsPlaces", +"description": "Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified." +}, +"routing": { +"$ref": "GoogleCloudAiplatformV1GoogleMapsRouting", +"description": "Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute)." } }, "type": "object" }, +"GoogleCloudAiplatformV1GoogleMapsPlaces": { +"description": "Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified.", +"id": "GoogleCloudAiplatformV1GoogleMapsPlaces", +"properties": {}, +"type": "object" +}, +"GoogleCloudAiplatformV1GoogleMapsRouting": { +"description": "Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute).", +"id": "GoogleCloudAiplatformV1GoogleMapsRouting", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1GoogleSearchRetrieval": { "description": "Tool to retrieve public web data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1GoogleSearchRetrieval", @@ -47158,6 +48144,13 @@ "description": "Optional. Output only. Metadata related to the retrieval grounding source.", "readOnly": true }, +"retrievalQueries": { +"description": "Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.", +"items": { +"type": "string" +}, +"type": "array" +}, "searchEntryPoint": { "$ref": "GoogleCloudAiplatformV1SearchEntryPoint", "description": "Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search." @@ -51344,7 +52337,7 @@ false }, "containerSpec": { "$ref": "GoogleCloudAiplatformV1ModelContainerSpec", -"description": "Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models." +"description": "The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models." }, "createTime": { "description": "Output only. Timestamp when this Model was uploaded into Vertex AI.", @@ -53467,6 +54460,29 @@ false "persistentDiskSpec": { "$ref": "GoogleCloudAiplatformV1PersistentDiskSpec", "description": "The specification of a persistent disk to attach for the execution job." +}, +"shieldedInstanceConfig": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig", +"description": "Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig": { +"description": "A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm.", +"id": "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig", +"properties": { +"enableIntegrityMonitoring": { +"description": "Optional. Whether the VM instance has integrity monitoring enabled.", +"type": "boolean" +}, +"enableSecureBoot": { +"description": "Optional. Whether the VM instance has Secure Boot enabled. Disabled by default.", +"type": "boolean" +}, +"enableVtpm": { +"description": "Optional. Whether the VM instance has vTPM enabled.", +"type": "boolean" } }, "type": "object" @@ -53516,7 +54532,50 @@ false "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime": { "description": "Configuration for a Workbench Instances-based environment.", "id": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime", -"properties": {}, +"properties": { +"customContainerImage": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage", +"description": "A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM." +}, +"vmImage": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage", +"description": "A specific Compute Engine VM image to run the notebook on." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage": { +"description": "The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`.", +"id": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage", +"properties": { +"repository": { +"description": "Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`.", +"type": "string" +}, +"tag": { +"description": "Optional. The tag of the container image. If unset, defaults to `latest`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage": { +"description": "The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`.", +"id": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage", +"properties": { +"family": { +"description": "Use this VM image family to find the image; the newest image in this family is used.", +"type": "string" +}, +"name": { +"description": "Use this VM image name to find the image.", +"type": "string" +}, +"project": { +"description": "Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`.", +"type": "string" +} +}, "type": "object" }, "GoogleCloudAiplatformV1NotebookIdleShutdownConfig": { @@ -53926,7 +54985,7 @@ false "type": "string" }, "displayName": { -"description": "Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned.", "type": "string" }, "metricSources": { @@ -54064,7 +55123,7 @@ false "properties": { "duration": { "$ref": "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate", -"description": "Filter on the duration of a trace." +"description": "Filter on the duration of a trace (in seconds)." }, "totalTokenUsage": { "$ref": "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate", @@ -54495,6 +55554,10 @@ false "description": "A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", "id": "GoogleCloudAiplatformV1Part", "properties": { +"audioTranscription": { +"$ref": "GoogleCloudAiplatformV1AudioTranscription", +"description": "Optional. Audio (input or output) transcription. This is only set when this Part contains audio data." +}, "codeExecutionResult": { "$ref": "GoogleCloudAiplatformV1CodeExecutionResult", "description": "Optional. The result of executing the ExecutableCode." @@ -57996,6 +59059,10 @@ false "description": "Specification for building container image.", "id": "GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec", "properties": { +"serviceAccount": { +"description": "Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com`", +"type": "string" +}, "workerPool": { "description": "Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`", "type": "string" @@ -58010,6 +59077,11 @@ false "imageUri": { "description": "Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.", "type": "string" +}, +"port": { +"description": "Optional. The port the container listens on. Defaults to 8080 if unset.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -59742,11 +60814,13 @@ false "description": "Required. The category of the default container image.", "enum": [ "DEFAULT_CONTAINER_CATEGORY_UNSPECIFIED", -"DEFAULT_CONTAINER_CATEGORY_COMPUTER_USE" +"DEFAULT_CONTAINER_CATEGORY_COMPUTER_USE", +"DEFAULT_CONTAINER_CATEGORY_SHELL_SANDBOX" ], "enumDescriptions": [ "The default value. This value is unused.", -"The default container image for Computer Use." +"The default container image for Computer Use.", +"The default container image for Shell Sandbox." ], "type": "string" }, @@ -59761,9 +60835,43 @@ false "description": "Configuration for egress control of sandbox instances.", "id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig", "properties": { +"customerVpcNetwork": { +"description": "Optional. The customer VPC network that sandbox egress is routed into.", +"type": "string" +}, +"dnsPeeringConfigs": { +"description": "Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC.", +"items": { +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig" +}, +"type": "array" +}, "internetAccess": { "description": "Optional. Whether to allow internet access.", "type": "boolean" +}, +"networkAttachment": { +"description": "Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig": { +"description": "Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC.", +"id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig", +"properties": { +"domain": { +"description": "Required. The DNS name suffix of the zone being peered to, e.g., \"my-internal-domain.corp.\". Must end with a dot.", +"type": "string" +}, +"targetNetwork": { +"description": "Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.", +"type": "string" +}, +"targetProject": { +"description": "Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index b12747c318..556678aa25 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -5876,9 +5876,125 @@ } }, "memoryBanks": { +"methods": { +"ingestEvents": { +"description": "Ingests events for a Memory Bank.", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}:ingestEvents", +"httpMethod": "POST", +"id": "aiplatform.memoryBanks.ingestEvents", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^memoryBanks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}:ingestEvents", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1IngestEventsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "memories": { "methods": { +"create": { +"description": "Create a Memory.", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories", +"httpMethod": "POST", +"id": "aiplatform.memoryBanks.memories.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"memoryId": { +"description": "Optional. The user defined ID to use for memory, which will become the final component of the memory 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 ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^memoryBanks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/memories", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1Memory" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete a Memory.", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}", +"httpMethod": "DELETE", +"id": "aiplatform.memoryBanks.memories.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"location": "path", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"generate": { +"description": "Generate memories.", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories:generate", +"httpMethod": "POST", +"id": "aiplatform.memoryBanks.memories.generate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^memoryBanks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/memories:generate", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Get a Memory.", "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}", @@ -5903,6 +6019,198 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"list": { +"description": "List Memories.", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories", +"httpMethod": "GET", +"id": "aiplatform.memoryBanks.memories.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^memoryBanks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/memories", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update a Memory.", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}", +"httpMethod": "PATCH", +"id": "aiplatform.memoryBanks.memories.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"location": "path", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1Memory" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"purge": { +"description": "Purge memories.", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories:purge", +"httpMethod": "POST", +"id": "aiplatform.memoryBanks.memories.purge", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^memoryBanks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/memories:purge", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1PurgeMemoriesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"retrieve": { +"description": "Retrieve memories.", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories:retrieve", +"httpMethod": "POST", +"id": "aiplatform.memoryBanks.memories.retrieve", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^memoryBanks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/memories:retrieve", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"retrieveProfiles": { +"description": "Retrieves profiles.", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories:retrieveProfiles", +"httpMethod": "POST", +"id": "aiplatform.memoryBanks.memories.retrieveProfiles", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^memoryBanks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/memories:retrieveProfiles", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"rollback": { +"description": "Rollback Memory to a specific revision.", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}:rollback", +"httpMethod": "POST", +"id": "aiplatform.memoryBanks.memories.rollback", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"location": "path", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:rollback", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -6061,6 +6369,76 @@ ] } } +}, +"revisions": { +"methods": { +"get": { +"description": "Get a Memory Revision.", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions/{revisionsId}", +"httpMethod": "GET", +"id": "aiplatform.memoryBanks.memories.revisions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`", +"location": "path", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "List Memory Revisions for a Memory.", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions", +"httpMethod": "GET", +"id": "aiplatform.memoryBanks.memories.revisions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"location": "path", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/revisions", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} } } }, @@ -20848,6 +21226,12 @@ "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Optional. The update mask applies to the resource. The supported paths are `automatic_resources`, `dedicated_resources`, `enable_access_logging` and `deployed_index_auth_config`. When omitted, the service will perform a full update of all fields. See google.protobuf.FieldMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, "path": "v1beta1/{+indexEndpoint}:mutateDeployedIndex", @@ -21610,29 +21994,30 @@ } }, "memoryBanks": { -"resources": { -"memories": { "methods": { -"get": { -"description": "Get a Memory.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.memoryBanks.memories.get", +"ingestEvents": { +"description": "Ingests events for a Memory Bank.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}:ingestEvents", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.ingestEvents", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"parent": { +"description": "Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+parent}:ingestEvents", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1IngestEventsRequest" +}, "response": { -"$ref": "GoogleCloudAiplatformV1beta1Memory" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -21640,171 +22025,320 @@ } }, "resources": { -"operations": { +"memories": { "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}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", +"create": { +"description": "Create a Memory.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories", "httpMethod": "POST", -"id": "aiplatform.projects.locations.memoryBanks.memories.operations.cancel", +"id": "aiplatform.projects.locations.memoryBanks.memories.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"memoryId": { +"description": "Optional. The user defined ID to use for memory, which will become the final component of the memory 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 ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:cancel", +"path": "v1beta1/{+parent}/memories", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1Memory" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", +"description": "Delete a Memory.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.memoryBanks.memories.operations.delete", +"id": "aiplatform.projects.locations.memoryBanks.memories.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"generate": { +"description": "Generate memories.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:generate", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.memories.generate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/memories:generate", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets the latest 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}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", +"description": "Get a Memory.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.memoryBanks.memories.operations.get", +"id": "aiplatform.projects.locations.memoryBanks.memories.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1Memory" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", +"description": "List Memories.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories", "httpMethod": "GET", -"id": "aiplatform.projects.locations.memoryBanks.memories.operations.list", +"id": "aiplatform.projects.locations.memoryBanks.memories.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { "filter": { -"description": "The standard list filter.", +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)", "location": "query", "type": "string" }, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", -"required": true, +"orderBy": { +"description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", +"location": "query", "type": "string" }, "pageSize": { -"description": "The standard list page size.", +"description": "Optional. The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "Optional. The standard list page token.", "location": "query", "type": "string" }, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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" +"parent": { +"description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1beta1/{+name}/operations", +"path": "v1beta1/{+parent}/memories", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.memoryBanks.memories.operations.wait", +"patch": { +"description": "Update a Memory.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.memoryBanks.memories.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to wait on.", +"description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" }, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", +"updateMask": { +"description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", +"format": "google-fieldmask", "location": "query", "type": "string" } }, -"path": "v1beta1/{+name}:wait", +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1Memory" +}, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"purge": { +"description": "Purge memories.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:purge", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.memories.purge", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", +"required": true, +"type": "string" } +}, +"path": "v1beta1/{+parent}/memories:purge", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1PurgeMemoriesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"retrieve": { +"description": "Retrieve memories.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:retrieve", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.memories.retrieve", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", +"required": true, +"type": "string" } +}, +"path": "v1beta1/{+parent}/memories:retrieve", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"retrieveProfiles": { +"description": "Retrieves profiles.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:retrieveProfiles", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.memories.retrieveProfiles", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/memories:retrieveProfiles", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"rollback": { +"description": "Rollback Memory to a specific revision.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}:rollback", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.memories.rollback", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" } +}, +"path": "v1beta1/{+name}:rollback", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, +"resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.memoryBanks.operations.cancel", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.cancel", "parameterOrder": [ "name" ], @@ -21812,7 +22346,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -21827,9 +22361,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.memoryBanks.operations.delete", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.delete", "parameterOrder": [ "name" ], @@ -21837,7 +22371,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -21852,9 +22386,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.memoryBanks.operations.get", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.get", "parameterOrder": [ "name" ], @@ -21862,7 +22396,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -21877,9 +22411,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.memoryBanks.operations.list", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.list", "parameterOrder": [ "name" ], @@ -21892,7 +22426,235 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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/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}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"revisions": { +"methods": { +"get": { +"description": "Get a Memory Revision.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions/{revisionsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.memoryBanks.memories.revisions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "List Memory Revisions for a Memory.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.memoryBanks.memories.revisions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/revisions", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.memoryBanks.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/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}/memoryBanks/{memoryBanksId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.memoryBanks.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.memoryBanks.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/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" }, @@ -25877,7 +26639,7 @@ ], "parameters": { "filter": { -"description": "Optional. Optional AIP-160 filter, currently restricted to a single equality predicate on `state`: state = ACTIVE state = DISABLED state = ENABLING The value must be the exact name of a `MonitoredAgent.EnablementState` constant (case-sensitive): `ACTIVE`, `DISABLED`, `ENABLING`, or `ENABLEMENT_STATE_UNSPECIFIED`. (The proto reserves ordinals for additional future states like NEEDS_ACTION; this allow-list grows when the proto adds them.) A blank or absent filter returns every MonitoredAgent in the parent regardless of state. Anything else returns INVALID_ARGUMENT.", +"description": "Optional. An AIP-160 filter, currently restricted to a single equality predicate on `state`. The value must be the exact, case-sensitive name of a `MonitoredAgent.EnablementState` value: `ACTIVE`, `DISABLED`, `ENABLING`, or `ENABLEMENT_STATE_UNSPECIFIED`. A blank or absent filter returns every MonitoredAgent in the parent regardless of state; any other value returns `INVALID_ARGUMENT`. Example: ``` state = ACTIVE ```", "location": "query", "type": "string" }, @@ -25922,7 +26684,7 @@ ], "parameters": { "filter": { -"description": "Optional. Filter expression restricting which AnalyzedSessions are included in the aggregation. Uses a subset of the `ListAnalyzedSessionsRequest.filter` grammar: a closed `detection_time` window with both bounds required, e.g. detection_time >= \"2024-01-01T00:00:00Z\" AND detection_time <= \"2024-01-08T00:00:00Z\" The `severity` clause supported on ListAnalyzedSessions is intentionally rejected here: this response groups by severity (one entry per bucket per agent), so a severity filter would collapse the rollup to a single bucket and produce a misleading per-agent view. If empty, the aggregation covers the last 3 days.", +"description": "Optional. Filter expression restricting which AnalyzedSessions are included in the aggregation. Supports a subset of the `ListAnalyzedSessionsRequest.filter` grammar: a closed `detection_time` window with both bounds required. The `severity` clause is not supported here. If empty, the aggregation covers the last 3 days. Example: ``` detection_time >= \"2024-01-01T00:00:00Z\" AND detection_time <= \"2024-01-08T00:00:00Z\" ```", "location": "query", "type": "string" }, @@ -26003,12 +26765,12 @@ ], "parameters": { "filter": { -"description": "Optional. Filter expression restricting which AnalyzedSessions are returned. A subset of AIP-160 supporting two clauses joined by AND: 1. A closed time window on `detection_time`. If included, both bounds are required: detection_time >= \"\" AND detection_time <= \"\" 2. An equality on `severity`, where the value is the string representation of a Severity enum value (e.g., \"CRITICAL\", \"HIGH\", \"MEDIUM\", \"LOW\"). \"SEVERITY_UNSPECIFIED\" is not supported. The filter matches sessions whose maximum severity equals the requested bucket (a session whose detectors fire at LOW and CRITICAL is matched by `severity = \"CRITICAL\"`, not `severity = \"LOW\"`): severity = \"CRITICAL\" Both clauses are independently optional and may appear in either order. Each clause may appear at most once. Example (time window + severity): detection_time >= \"2024-01-01T00:00:00Z\" AND detection_time <= \"2024-01-08T00:00:00Z\" AND severity = \"CRITICAL\" If empty, results are restricted to the last 3 days with no severity restriction. Other fields, additional operators, set membership (IN), and boolean combinations (OR, NOT, parentheses) are not yet supported.", +"description": "Optional. Filter expression restricting which AnalyzedSessions are returned. Supports a subset of AIP-160: a closed `detection_time` window (both bounds required) and/or an equality on `severity`, joined by `AND`. Each clause is optional, may appear at most once, and may appear in either order. The `severity` value is the string form of a `Severity` value (`CRITICAL`, `HIGH`, `MEDIUM`, or `LOW`; `SEVERITY_UNSPECIFIED` is not supported) and matches sessions whose maximum severity equals that bucket. For example, a session that fires at both LOW and CRITICAL matches `severity = \"CRITICAL\"`, not `severity = \"LOW\"`. Example (time window and severity): ``` detection_time >= \"2024-01-01T00:00:00Z\" AND detection_time <= \"2024-01-08T00:00:00Z\" AND severity = \"CRITICAL\" ``` If empty, results are restricted to the last 3 days with no severity restriction. Other fields, additional operators, set membership (`IN`), and boolean combinations (`OR`, `NOT`, parentheses) are not yet supported.", "location": "query", "type": "string" }, "orderBy": { -"description": "Optional. Comma-separated list of fields to sort by, following AIP-132 syntax. The default sort direction is ascending; append \" desc\" to a field to sort descending. Subfields are not supported (no field listed below has any). Supported fields (any other field yields INVALID_ARGUMENT): * `latest_detection_time` - the session's most-recent flagged detection time. This is the column the landing page's \"Detection time\" header sorts on. Sorted by the underlying TIMESTAMP value (newer is \"greater\" so `latest_detection_time desc` puts the newest sessions first). * `max_severity_rank` - the session's bucketed maximum severity, ranked LOW=1 < MEDIUM=2 < HIGH=3 < CRITICAL=4 (matches `Severity` enum ordering). `max_severity_rank desc` puts the most-severe sessions first. The ranking is documented here per AIP-132 because the field is not a natural-comparator type. * `agent_display_name` - the MonitoredAgent's display name as shown in the UI's \"Agent name\" column. Sorted as a STRING using BigQuery default collation (case-sensitive, code-point order). The server always appends `session_id ASC` as a stable tiebreak so pagination remains consistent across pages when the primary sort field has duplicates (e.g. multiple sessions with the same latest_detection_time within a second). If empty, defaults to `latest_detection_time desc` (the prior implicit behavior). Multi-field sort (e.g. `max_severity_rank desc, latest_detection_time desc`) is supported. The `order_by` value MUST match the value used on the call that minted any supplied `page_token` (AIP-158). Mismatches yield INVALID_ARGUMENT.", +"description": "Optional. Comma-separated list of fields to sort by, following AIP-132 syntax. The default sort direction is ascending; append \" desc\" to a field to sort descending. Supported fields (any other field yields INVALID_ARGUMENT): * `latest_detection_time` - the session's most-recent flagged detection time. `latest_detection_time desc` puts the newest sessions first. * `max_severity_rank` - the session's bucketed maximum severity, ranked LOW=1 < MEDIUM=2 < HIGH=3 < CRITICAL=4. `max_severity_rank desc` puts the most-severe sessions first. * `agent_display_name` - the MonitoredAgent's display name. Sorted as a STRING (case-sensitive, code-point order). If empty, defaults to `latest_detection_time desc`. Multi-field sort (for example, `max_severity_rank desc, latest_detection_time desc`) is supported. The `order_by` value MUST match the value used on the call that minted any supplied `page_token` (AIP-158). Mismatches yield INVALID_ARGUMENT.", "location": "query", "type": "string" }, @@ -29320,6 +30082,136 @@ } } } +}, +"v1": { +"methods": { +"responses": { +"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.publishers.v1.responses", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"deployedModelId": { +"description": "ID of the DeployedModel that serves the invoke request.", +"location": "query", +"type": "string" +}, +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+endpoint}/v1/responses", +"request": { +"$ref": "GoogleApiHttpBody" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +}, +"resources": { +"responses": { +"methods": { +"compact": { +"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses/compact", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.publishers.v1.responses.compact", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"deployedModelId": { +"description": "ID of the DeployedModel that serves the invoke request.", +"location": "query", +"type": "string" +}, +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+endpoint}/v1/responses/compact", +"request": { +"$ref": "GoogleApiHttpBody" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"delete": { +"description": "Deletes the response from the endpoint.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses/{responsesId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.publishers.v1.responses.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Response resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}/responses/{response}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/v1/responses/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"get": { +"description": "Gets the response from the endpoint.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses/{responsesId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.publishers.v1.responses.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Response resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}/responses/{response}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/v1/responses/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +} +} +} } } }, @@ -31734,7 +32626,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the A2aTask to append events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`", +"description": "Required. The resource name of the A2aTask to append events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$", "required": true, @@ -31762,12 +32654,12 @@ ], "parameters": { "a2aTaskId": { -"description": "Required. User-defined ID of the A2aTask. This ID must be unique within the ReasoningEngine. It must be 1-63 characters, start with a lowercase letter or number, end with a lowercase letter or number, and only contain lowercase letters, numbers, and hyphens [AIP-122](https://google.aip.dev/122). Starting with a number is allowed for compatibility with the auto-generated UUID from A2A SDK.", +"description": "Required. User-defined ID of the A2aTask. This ID must be unique within the parent resource. It must be 1-63 characters, start with a lowercase letter or number, end with a lowercase letter or number, and only contain lowercase letters, numbers, and hyphens [AIP-122](https://google.aip.dev/122). Starting with a number is allowed for compatibility with the auto-generated UUID from A2A SDK.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the ReasoningEngine to create the A2aTask under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"description": "Required. The resource name of the ReasoningEngine or TaskStore to create the A2aTask under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` or `projects/{project}/locations/{location}/taskStores/{task_store}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, @@ -31795,7 +32687,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the A2aTask to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`", +"description": "Required. The resource name of the A2aTask to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$", "required": true, @@ -31820,11 +32712,26 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the A2aTask. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`", +"description": "Required. The resource name of the A2aTask. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. The view of the A2aTask to return.", +"enum": [ +"A2A_TASK_VIEW_UNSPECIFIED", +"A2A_TASK_VIEW_BASIC", +"A2A_TASK_VIEW_FULL" +], +"enumDescriptions": [ +"Task view unspecified.", +"Task header only (status, metadata, timestamps)", +"Full materialized state (artifacts + history)" +], +"location": "query", +"type": "string" } }, "path": "v1beta1/{+name}", @@ -31861,12 +32768,12 @@ "type": "integer" }, "pageToken": { -"description": "Optional. The next_page_token value returned from a previous list AgentEngineTaskStoreService.ListA2aTasks call.", +"description": "Optional. The next_page_token value returned from a previous list ListA2aTasks call.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the ReasoningEngine to list the A2aTasks under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"description": "Required. The resource name of the ReasoningEngine or TaskStore to list the A2aTasks under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` or `projects/{project}/locations/{location}/taskStores/{task_store}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, @@ -31911,12 +32818,12 @@ "type": "integer" }, "pageToken": { -"description": "Optional. The next_page_token value returned from a previous list AgentEngineTaskStoreService.ListA2aTaskEvents call.", +"description": "Optional. The next_page_token value returned from a previous list ListA2aTaskEvents call.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the A2aTask to list the TaskEvents under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`", +"description": "Required. The resource name of the A2aTask to list the TaskEvents under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$", "required": true, @@ -32050,6 +32957,225 @@ } }, "feedbackEntries": { +"methods": { +"create": { +"description": "Creates a new FeedbackEntry.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine in which to create the FeedbackEntry. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/feedbackEntries", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1FeedbackEntry" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a FeedbackEntry and its associated FeedbackContext.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the FeedbackEntry to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Retrieves a single FeedbackEntry by its resource name.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the FeedbackEntry to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1FeedbackEntry" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"getFeedbackContext": { +"description": "Retrieves the FeedbackContext associated with a FeedbackEntry.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/feedbackContext", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.getFeedbackContext", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the FeedbackContext to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}/feedbackContext`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/feedbackContext$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1FeedbackContext" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists FeedbackEntries in a ReasoningEngine.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Standard list filter. Supported fields: * `session_id` * `user_id` * `feedback_type` * `feedback_labels`: Supports the HAS operator (`:`). For example: `feedback_labels:\"inaccurate\"`. * `create_time` * `update_time` Example: `feedback_type=\"THUMBS_DOWN\" AND feedback_labels:\"hallucination\"`.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order results by, sorted in ascending order by default. Append ` desc` after a field name to sort that field in descending order. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of FeedbackEntries to return per page.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous ListFeedbackEntries call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the ReasoningEngine from which to list FeedbackEntries. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/feedbackEntries", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates an existing FeedbackEntry. Only the fields specified in update_mask are modified. If the mask is empty, all mutable fields are replaced with the values supplied in the request.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The field mask that controls which fields are updated. If unset or empty, all mutable fields of the FeedbackEntry are replaced with the values from feedback_entry.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1FeedbackEntry" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"updateFeedbackContext": { +"description": "Updates the FeedbackContext associated with a FeedbackEntry. Only the fields specified in update_mask are modified. If the mask is empty, all mutable fields are replaced with the values supplied in the request.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/feedbackContext", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.updateFeedbackContext", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}/feedbackContext`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/feedbackContext$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The field mask that controls which fields are updated. If unset or empty, all mutable fields of the FeedbackContext are replaced with the values from feedback_context.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1FeedbackContext" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "operations": { "methods": { @@ -36164,6 +37290,161 @@ } }, "servingProfiles": { +"methods": { +"create": { +"description": "Creates a ServingProfile.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.servingProfiles.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to create the ServingProfile in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"servingProfileId": { +"description": "Required. The ID to use for the ServingProfile, which will become the final component of the ServingProfile's resource name. This value should be 1-63 characters, and valid characters are `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/servingProfiles", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1ServingProfile" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a ServingProfile.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.servingProfiles.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the ServingProfile resource to be deleted. Format: `projects/{project}/locations/{location}/servingProfiles/{serving_profile}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a ServingProfile.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.servingProfiles.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the ServingProfile resource. Format: `projects/{project}/locations/{location}/servingProfiles/{serving_profile}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ServingProfile" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists ServingProfiles in a Location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.servingProfiles.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The standard list page size. If unspecified, at most 100 ServingProfiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location to list the ServingProfiles from. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/servingProfiles", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListServingProfilesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a ServingProfile.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.servingProfiles.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the ServingProfile.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update; see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. If omitted, all populated (non-empty) mutable fields are updated; if set to `[\"*\"]`, all mutable fields are fully replaced (unpopulated values are cleared).", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1ServingProfile" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ServingProfile" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "operations": { "methods": { @@ -47962,7 +49243,7 @@ } } }, -"revision": "20260703", +"revision": "20260725", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -47973,6 +49254,11 @@ "description": "Optional. If true, anchors the last frame in video generation by generating a custom border mask.", "type": "boolean" }, +"cfgScale": { +"description": "CFG scale for video-transform, perf-generation, a2v, video-textures models.", +"format": "float", +"type": "number" +}, "codec": { "description": "Optional. Video codec to use for output.", "enum": [ @@ -47989,6 +49275,10 @@ ], "type": "string" }, +"colorAlignment": { +"$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig", +"description": "Optional. Color alignment configuration." +}, "conditioningFrames": { "description": "Conditioning frames for veo experimental models ONLY, not to be confused with keyframes (ID:31) in GenerateVideoRequest.", "items": { @@ -48004,6 +49294,10 @@ "description": "Generic key-value pairs for experimental parameters. This allows adding new parameters without changing the dataplane binary.", "type": "object" }, +"exrColorSpaceOverride": { +"description": "Optional. Colorspace to be used for all EXR inputs.", +"type": "string" +}, "humanPose": { "$ref": "CloudAiLargeModelsVisionHumanPose", "description": "Human pose parameters for Pose Control" @@ -48017,6 +49311,10 @@ "format": "int32", "type": "integer" }, +"omniRewriter": { +"$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig", +"description": "Optional. Omni Rewriter configuration." +}, "originalRequestJson": { "description": "The original REST API request JSON sent by the user, in the instances/parameters format. Preserved for saving alongside output artifacts so users can reproduce their requests. This field is populated by the API handler and is not user-settable.", "type": "string" @@ -48037,6 +49335,10 @@ "$ref": "CloudAiLargeModelsVisionSeamless", "description": "Parameters for seamless (edge-continuous) video generation, enabling temporal looping and/or spatial tessellation." }, +"spatialAlignment": { +"$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig", +"description": "Optional. Spatial alignment configuration." +}, "truncateInputVideo": { "description": "If true (default), truncate input videos that exceed the model's maximum frame count by applying a frame_selection_config to __video_file__ inputs. Set to false to preserve the existing fail-fast behavior.", "type": "boolean" @@ -48053,6 +49355,17 @@ }, "type": "object" }, +"CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig": { +"description": "Configuration for color alignment.", +"id": "CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig", +"properties": { +"enable": { +"description": "Optional. If true, enable alignment.", +"type": "boolean" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame": { "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame", "properties": { @@ -48068,6 +49381,34 @@ }, "type": "object" }, +"CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig": { +"description": "Configuration for Omni Rewriter.", +"id": "CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig", +"properties": { +"maxChunkDuration": { +"description": "Optional. Maximum duration of a chunk in seconds.", +"format": "float", +"type": "number" +}, +"rewriterInputFps": { +"description": "Optional. FPS used to generate gemini chunks for video inputs.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig": { +"description": "Configuration for spatial alignment.", +"id": "CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig", +"properties": { +"enable": { +"description": "Optional. If true, enable alignment.", +"type": "boolean" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig": { "description": "Scheduling configuration for Veo Experimental.", "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig", @@ -48592,6 +49933,13 @@ "description": "The name of the `Agent` used for generating the completion.", "type": "string" }, +"antigravityConfig": { +"$ref": "GenaiVertexV1beta1AntigravityAgentConfig", +"description": "Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis." +}, +"codeMenderConfig": { +"$ref": "GenaiVertexV1beta1CodeMenderAgentConfig" +}, "deepResearchConfig": { "$ref": "GenaiVertexV1beta1DeepResearchAgentConfig" }, @@ -48633,6 +49981,22 @@ }, "type": "object" }, +"GenaiVertexV1beta1AntigravityAgentConfig": { +"description": "Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration.", +"id": "GenaiVertexV1beta1AntigravityAgentConfig", +"properties": { +"maxTotalTokens": { +"description": "Max total tokens for the agent run.", +"format": "int64", +"type": "string" +}, +"model": { +"description": "The model to use for agent reasoning.", +"type": "string" +} +}, +"type": "object" +}, "GenaiVertexV1beta1ArgumentsDelta": { "id": "GenaiVertexV1beta1ArgumentsDelta", "properties": { @@ -48824,6 +50188,7 @@ "type": "object" }, "GenaiVertexV1beta1CodeExecutionCallContent": { +"deprecated": true, "description": "Code execution content.", "id": "GenaiVertexV1beta1CodeExecutionCallContent", "properties": { @@ -48901,6 +50266,7 @@ "type": "object" }, "GenaiVertexV1beta1CodeExecutionResultContent": { +"deprecated": true, "description": "Code execution result content.", "id": "GenaiVertexV1beta1CodeExecutionResultContent", "properties": { @@ -48942,6 +50308,118 @@ }, "type": "object" }, +"GenaiVertexV1beta1CodeMenderAgentConfig": { +"description": "Configuration for the CodeMender agent.", +"id": "GenaiVertexV1beta1CodeMenderAgentConfig", +"properties": { +"find_request": { +"$ref": "GenaiVertexV1beta1CodeMenderAgentConfigFindRequest", +"description": "Parameters for finding vulnerabilities." +}, +"fix_request": { +"$ref": "GenaiVertexV1beta1CodeMenderAgentConfigFixRequest", +"description": "Parameters for fixing vulnerabilities." +}, +"model": { +"description": "The name of the model to use for the CodeMender agent. One CodeMender session will only use one model.", +"type": "string" +}, +"session_config": { +"$ref": "GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig", +"description": "Optional session-specific configurations to override default agent behavior." +}, +"session_id": { +"description": "Parameter for grouping multiple interactions that belong to the same CodeMender session.", +"type": "string" +} +}, +"type": "object" +}, +"GenaiVertexV1beta1CodeMenderAgentConfigFileContent": { +"description": "Content of a single file in the codebase.", +"id": "GenaiVertexV1beta1CodeMenderAgentConfigFileContent", +"properties": { +"content": { +"description": "The UTF-8 encoded text content of the file.", +"type": "string" +}, +"path": { +"description": "The relative path of the file from the project root.", +"type": "string" +} +}, +"type": "object" +}, +"GenaiVertexV1beta1CodeMenderAgentConfigFindRequest": { +"description": "Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase.", +"id": "GenaiVertexV1beta1CodeMenderAgentConfigFindRequest", +"properties": { +"description": { +"description": "Additional context or custom instructions provided by the user to guide the vulnerability analysis.", +"type": "string" +}, +"finding_id": { +"description": "The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability.", +"type": "string" +}, +"mode": { +"description": "The mode of the find session.", +"enum": [ +"MODE_UNSPECIFIED", +"MODE_SCAN", +"MODE_VERIFY" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Fast scan using only the initial classifier.", +"Performs classification followed by detailed investigation." +], +"type": "string" +}, +"source_files": { +"description": "A list of source files to provide as context for the scan.", +"items": { +"$ref": "GenaiVertexV1beta1CodeMenderAgentConfigFileContent" +}, +"type": "array" +} +}, +"type": "object" +}, +"GenaiVertexV1beta1CodeMenderAgentConfigFixRequest": { +"description": "Request parameters specific to FIX sessions, used for generating and validating security patches.", +"id": "GenaiVertexV1beta1CodeMenderAgentConfigFixRequest", +"properties": { +"description": { +"description": "Additional context or custom instructions provided by the user to guide the patch generation process.", +"type": "string" +}, +"finding_id": { +"description": "The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability.", +"type": "string" +}, +"source_files": { +"description": "A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability.", +"items": { +"$ref": "GenaiVertexV1beta1CodeMenderAgentConfigFileContent" +}, +"type": "array" +} +}, +"type": "object" +}, +"GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig": { +"description": "The configuration of CodeMender sessions.", +"id": "GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig", +"properties": { +"max_rounds": { +"description": "The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GenaiVertexV1beta1ComputerUse": { "description": "A tool that can be used by the model to interact with the computer.", "id": "GenaiVertexV1beta1ComputerUse", @@ -49267,6 +50745,10 @@ "description": "Configuration for a custom environment.", "id": "GenaiVertexV1beta1EnvironmentConfig", "properties": { +"environmentId": { +"description": "Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one.", +"type": "string" +}, "networkAllowlist": { "$ref": "GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist", "description": "Allow only specific domains." @@ -49476,6 +50958,7 @@ "type": "object" }, "GenaiVertexV1beta1FileSearchCallContent": { +"deprecated": true, "description": "File Search content.", "id": "GenaiVertexV1beta1FileSearchCallContent", "properties": {}, @@ -49493,6 +50976,7 @@ "type": "object" }, "GenaiVertexV1beta1FileSearchResultContent": { +"deprecated": true, "description": "File Search result content.", "id": "GenaiVertexV1beta1FileSearchResultContent", "properties": { @@ -49550,6 +51034,7 @@ "type": "object" }, "GenaiVertexV1beta1FunctionCallContent": { +"deprecated": true, "description": "A function tool call content block.", "id": "GenaiVertexV1beta1FunctionCallContent", "properties": { @@ -49592,6 +51077,7 @@ "type": "object" }, "GenaiVertexV1beta1FunctionResultContent": { +"deprecated": true, "description": "A function tool result content block.", "id": "GenaiVertexV1beta1FunctionResultContent", "properties": { @@ -49618,20 +51104,14 @@ "GenaiVertexV1beta1FunctionResultDelta": { "id": "GenaiVertexV1beta1FunctionResultDelta", "properties": { -"contentList": { -"$ref": "GenaiVertexV1beta1ContentList" -}, "isError": { "type": "boolean" }, "name": { "type": "string" }, -"stringResult": { -"type": "string" -}, -"structResult": { -"$ref": "GenaiVertexV1beta1Struct" +"result": { +"$ref": "GenaiVertexV1beta1Value" } }, "type": "object" @@ -49640,9 +51120,6 @@ "description": "Result of a function tool call.", "id": "GenaiVertexV1beta1FunctionResultStep", "properties": { -"contentList": { -"$ref": "GenaiVertexV1beta1ContentList" -}, "isError": { "description": "Whether the tool call resulted in an error.", "type": "boolean" @@ -49651,11 +51128,9 @@ "description": "The name of the tool that was called.", "type": "string" }, -"stringResult": { -"type": "string" -}, -"structResult": { -"$ref": "GenaiVertexV1beta1Struct" +"result": { +"$ref": "GenaiVertexV1beta1Value", +"description": "Required. The result of the tool call." } }, "type": "object" @@ -49688,11 +51163,6 @@ "description": "Configuration parameters for model interactions.", "id": "GenaiVertexV1beta1GenerationConfig", "properties": { -"frequency_penalty": { -"description": "Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].", -"format": "float", -"type": "number" -}, "imageConfig": { "$ref": "GenaiVertexV1beta1ImageConfig", "deprecated": true, @@ -49703,11 +51173,6 @@ "format": "int32", "type": "integer" }, -"presence_penalty": { -"description": "Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].", -"format": "float", -"type": "number" -}, "seed": { "description": "Seed used in decoding for reproducibility.", "format": "int32", @@ -49791,6 +51256,10 @@ "format": "float", "type": "number" }, +"transcriptionConfig": { +"$ref": "GenaiVertexV1beta1TranscriptionConfig", +"description": "Optional. Configuration for speech recognition (transcription). If present, ASR is enabled." +}, "videoConfig": { "$ref": "GenaiVertexV1beta1VideoConfig", "description": "Configuration for video generation." @@ -49820,6 +51289,7 @@ "type": "object" }, "GenaiVertexV1beta1GoogleMapsCallContent": { +"deprecated": true, "description": "Google Maps content.", "id": "GenaiVertexV1beta1GoogleMapsCallContent", "properties": { @@ -49880,6 +51350,7 @@ "type": "object" }, "GenaiVertexV1beta1GoogleMapsResultContent": { +"deprecated": true, "description": "Google Maps result content.", "id": "GenaiVertexV1beta1GoogleMapsResultContent", "properties": { @@ -50026,6 +51497,7 @@ "type": "object" }, "GenaiVertexV1beta1GoogleSearchCallContent": { +"deprecated": true, "description": "Google Search content.", "id": "GenaiVertexV1beta1GoogleSearchCallContent", "properties": { @@ -50117,6 +51589,7 @@ "type": "object" }, "GenaiVertexV1beta1GoogleSearchResultContent": { +"deprecated": true, "description": "Google Search result content.", "id": "GenaiVertexV1beta1GoogleSearchResultContent", "properties": { @@ -50445,6 +51918,17 @@ "readOnly": true, "type": "string" }, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "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.", +"type": "object" +}, +"localEnvironment": { +"$ref": "GenaiVertexV1beta1LocalEnvironmentConfig", +"description": "The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.)" +}, "modelInteraction": { "$ref": "GenaiVertexV1beta1ModelInteraction", "description": "Interaction for generating the completion using models." @@ -50511,6 +51995,13 @@ "readOnly": true, "type": "string" }, +"safety_settings": { +"description": "Safety settings for the interaction.", +"items": { +"$ref": "GenaiVertexV1beta1SafetySetting" +}, +"type": "array" +}, "status": { "description": "Required. Output only. The status of the interaction.", "enum": [ @@ -50521,7 +52012,8 @@ "FAILED", "CANCELLED", "INCOMPLETE", -"BUDGET_EXCEEDED" +"BUDGET_EXCEEDED", +"QUEUED" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -50531,7 +52023,8 @@ "The interaction failed.", "The interaction was cancelled.", "The interaction is completed, but contains incomplete results (e.g. hitting max_tokens).", -"The interaction was halted because the token budget was exceeded." +"The interaction was halted because the token budget was exceeded.", +"The interaction is queued, waiting for processing (e.g. waiting for off-peak capacity)." ], "readOnly": true, "type": "string" @@ -50636,7 +52129,8 @@ "FAILED", "CANCELLED", "INCOMPLETE", -"BUDGET_EXCEEDED" +"BUDGET_EXCEEDED", +"QUEUED" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -50646,7 +52140,8 @@ "The interaction failed.", "The interaction was cancelled.", "The interaction is completed, but contains incomplete results (e.g. hitting max_tokens).", -"The interaction was halted because the token budget was exceeded." +"The interaction was halted because the token budget was exceeded.", +"The interaction is queued, waiting for processing (e.g. waiting for off-peak capacity)." ], "type": "string" } @@ -50658,15 +52153,15 @@ "properties": { "contentDelta": { "$ref": "GenaiVertexV1beta1ContentDelta", -"description": "The content block delta data, used for content.delta events." +"description": "The content block delta data, used for content.delta events. Legacy content-based streaming event, used when steps are disabled." }, "contentStart": { "$ref": "GenaiVertexV1beta1ContentStart", -"description": "The content block start data, used for content.start events." +"description": "The content block start data, used for content.start events. Legacy content-based streaming event, used when steps are disabled." }, "contentStop": { "$ref": "GenaiVertexV1beta1ContentStop", -"description": "The content block stop data, used for content.stop events." +"description": "The content block stop data, used for content.stop events. Legacy content-based streaming event, used when steps are disabled." }, "errorEvent": { "$ref": "GenaiVertexV1beta1ErrorEvent", @@ -50679,20 +52174,20 @@ "interactionCompleteEvent": { "$ref": "GenaiVertexV1beta1InteractionCompleteEvent", "deprecated": true, -"description": "The interaction data, used for interaction.complete events." +"description": "The interaction data, used for interaction.complete events. Legacy event, used when steps are disabled." }, "interactionCompletedEvent": { "$ref": "GenaiVertexV1beta1InteractionCompletedSseEvent", -"description": "The interaction data, used for interaction.completed events." +"description": "The interaction data, used for interaction.completed events. Used when steps are enabled." }, "interactionCreatedEvent": { "$ref": "GenaiVertexV1beta1InteractionCreatedSseEvent", -"description": "The interaction data, used for interaction.created events." +"description": "The interaction data, used for interaction.created events. Used when steps are enabled." }, "interactionStartEvent": { "$ref": "GenaiVertexV1beta1InteractionStartEvent", "deprecated": true, -"description": "The interaction data, used for interaction.start events." +"description": "The interaction data, used for interaction.start events. Legacy event, used when steps are disabled." }, "interactionStatusUpdate": { "$ref": "GenaiVertexV1beta1InteractionStatusUpdate", @@ -50704,15 +52199,15 @@ }, "stepDelta": { "$ref": "GenaiVertexV1beta1StepDelta", -"description": "The step delta data, used for step.delta events." +"description": "The step delta data, used for step.delta events. Step-based streaming event, used when steps are enabled." }, "stepStart": { "$ref": "GenaiVertexV1beta1StepStart", -"description": "The step start data, used for step.start events." +"description": "The step start data, used for step.start events. Step-based streaming event, used when steps are enabled." }, "stepStop": { "$ref": "GenaiVertexV1beta1StepStop", -"description": "The step stop data, used for step.stop events." +"description": "The step stop data, used for step.stop events. Step-based streaming event, used when steps are enabled." } }, "type": "object" @@ -50863,6 +52358,12 @@ }, "type": "object" }, +"GenaiVertexV1beta1LocalEnvironmentConfig": { +"description": "Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field.", +"id": "GenaiVertexV1beta1LocalEnvironmentConfig", +"properties": {}, +"type": "object" +}, "GenaiVertexV1beta1McpServer": { "description": "A MCPServer is a server that can be called by the model to perform actions.", "id": "GenaiVertexV1beta1McpServer", @@ -50972,20 +52473,14 @@ "GenaiVertexV1beta1McpServerToolResultDelta": { "id": "GenaiVertexV1beta1McpServerToolResultDelta", "properties": { -"contentList": { -"$ref": "GenaiVertexV1beta1ContentList" -}, "name": { "type": "string" }, -"serverName": { -"type": "string" +"result": { +"$ref": "GenaiVertexV1beta1Value" }, -"stringResult": { +"serverName": { "type": "string" -}, -"structResult": { -"$ref": "GenaiVertexV1beta1Struct" } }, "type": "object" @@ -50994,22 +52489,17 @@ "description": "MCPServer tool result step.", "id": "GenaiVertexV1beta1McpServerToolResultStep", "properties": { -"contentList": { -"$ref": "GenaiVertexV1beta1ContentList" -}, "name": { "description": "Name of the tool which is called for this specific tool call.", "type": "string" }, +"result": { +"$ref": "GenaiVertexV1beta1Value", +"description": "Required. The output from the MCP server call. Can be simple text or rich content." +}, "serverName": { "description": "The name of the used MCP server.", "type": "string" -}, -"stringResult": { -"type": "string" -}, -"structResult": { -"$ref": "GenaiVertexV1beta1Struct" } }, "type": "object" @@ -51018,10 +52508,6 @@ "description": "Interaction for generating the completion using models.", "id": "GenaiVertexV1beta1ModelInteraction", "properties": { -"cached_content": { -"description": "The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`", -"type": "string" -}, "generationConfig": { "$ref": "GenaiVertexV1beta1GenerationConfig", "description": "Input only. Configuration parameters for the model interaction." @@ -51300,6 +52786,100 @@ }, "type": "object" }, +"GenaiVertexV1beta1RetrievalCallDelta": { +"description": "Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.", +"id": "GenaiVertexV1beta1RetrievalCallDelta", +"properties": { +"arguments": { +"$ref": "GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments", +"description": "Required. The arguments to pass to the Retrieval tool." +}, +"retrievalType": { +"description": "The type of retrieval tools.", +"enum": [ +"RETRIEVAL_TYPE_UNSPECIFIED", +"RETRIEVAL_TYPE_VERTEX_AI_SEARCH", +"RETRIEVAL_TYPE_RAG_STORE", +"RETRIEVAL_TYPE_EXA_AI_SEARCH", +"RETRIEVAL_TYPE_PARALLEL_AI_SEARCH" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"GenaiVertexV1beta1RetrievalCallStep": { +"description": "Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.", +"id": "GenaiVertexV1beta1RetrievalCallStep", +"properties": { +"arguments": { +"$ref": "GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments", +"description": "Required. The arguments to pass to the retrieval tool." +}, +"retrievalType": { +"description": "The type of retrieval tools.", +"enum": [ +"RETRIEVAL_TYPE_UNSPECIFIED", +"RETRIEVAL_TYPE_VERTEX_AI_SEARCH", +"RETRIEVAL_TYPE_RAG_STORE", +"RETRIEVAL_TYPE_EXA_AI_SEARCH", +"RETRIEVAL_TYPE_PARALLEL_AI_SEARCH" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments": { +"description": "The arguments to pass to Retrieval tools.", +"id": "GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments", +"properties": { +"queries": { +"description": "Queries for Retrieval information.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GenaiVertexV1beta1RetrievalResultDelta": { +"description": "Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. ToolResultDelta.type", +"id": "GenaiVertexV1beta1RetrievalResultDelta", +"properties": { +"isError": { +"description": "Whether the retrieval resulted in an error.", +"type": "boolean" +} +}, +"type": "object" +}, +"GenaiVertexV1beta1RetrievalResultStep": { +"description": "Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.", +"id": "GenaiVertexV1beta1RetrievalResultStep", +"properties": { +"isError": { +"description": "Whether the retrieval resulted in an error.", +"type": "boolean" +} +}, +"type": "object" +}, "GenaiVertexV1beta1ReviewSnippet": { "description": "Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.", "id": "GenaiVertexV1beta1ReviewSnippet", @@ -51319,6 +52899,90 @@ }, "type": "object" }, +"GenaiVertexV1beta1SafetySetting": { +"description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.", +"id": "GenaiVertexV1beta1SafetySetting", +"properties": { +"method": { +"description": "Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.", +"enum": [ +"HARM_BLOCK_METHOD_UNSPECIFIED", +"SEVERITY", +"PROBABILITY" +], +"enumDescriptions": [ +"The harm block method is unspecified.", +"The harm block method uses both probability and severity scores.", +"The harm block method uses the probability score." +], +"type": "string" +}, +"threshold": { +"description": "Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.", +"enum": [ +"HARM_BLOCK_THRESHOLD_UNSPECIFIED", +"BLOCK_LOW_AND_ABOVE", +"BLOCK_MEDIUM_AND_ABOVE", +"BLOCK_ONLY_HIGH", +"BLOCK_NONE", +"OFF" +], +"enumDescriptions": [ +"The harm block threshold is unspecified.", +"Block content with a low harm probability or higher.", +"Block content with a medium harm probability or higher.", +"Block content with a high harm probability.", +"Do not block any content, regardless of its harm probability.", +"Turn off the safety filter entirely." +], +"type": "string" +}, +"type": { +"description": "Required. The type of harm category to be blocked.", +"enum": [ +"HARM_CATEGORY_UNSPECIFIED", +"HARM_CATEGORY_HATE_SPEECH", +"HARM_CATEGORY_DANGEROUS_CONTENT", +"HARM_CATEGORY_HARASSMENT", +"HARM_CATEGORY_SEXUALLY_EXPLICIT", +"HARM_CATEGORY_CIVIC_INTEGRITY", +"HARM_CATEGORY_IMAGE_HATE", +"HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT", +"HARM_CATEGORY_IMAGE_HARASSMENT", +"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT", +"HARM_CATEGORY_JAILBREAK" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", +"Content that promotes, facilitates, or enables dangerous activities.", +"Abusive, threatening, or content intended to bully, torment, or ridicule.", +"Content that contains sexually explicit material.", +"Deprecated: Election filter is not longer supported. The harm category is civic integrity.", +"Images that contain hate speech.", +"Images that contain dangerous content.", +"Images that contain harassment.", +"Images that contain sexually explicit content.", +"Prompts designed to bypass safety filters." +], +"type": "string" +} +}, +"type": "object" +}, "GenaiVertexV1beta1ServerToolCallDelta": { "id": "GenaiVertexV1beta1ServerToolCallDelta", "properties": { @@ -51337,6 +53001,9 @@ "mcpServerToolCall": { "$ref": "GenaiVertexV1beta1McpServerToolCallDelta" }, +"retrievalCall": { +"$ref": "GenaiVertexV1beta1RetrievalCallDelta" +}, "signature": { "description": "A signature hash for backend validation.", "format": "byte", @@ -51366,6 +53033,9 @@ "mcpServerToolResult": { "$ref": "GenaiVertexV1beta1McpServerToolResultDelta" }, +"retrievalResult": { +"$ref": "GenaiVertexV1beta1RetrievalResultDelta" +}, "signature": { "description": "A signature hash for backend validation.", "format": "byte", @@ -51598,6 +53268,10 @@ "urlCitation": { "$ref": "GenaiVertexV1beta1UrlCitation", "description": "A URL citation annotation." +}, +"wordInfo": { +"$ref": "GenaiVertexV1beta1WordInfo", +"description": "Word-level ASR annotation with timing and speaker info." } }, "type": "object" @@ -51637,6 +53311,7 @@ "type": "object" }, "GenaiVertexV1beta1ThoughtContent": { +"deprecated": true, "description": "A thought content block.", "id": "GenaiVertexV1beta1ThoughtContent", "properties": { @@ -51751,6 +53426,7 @@ "type": "object" }, "GenaiVertexV1beta1ToolCallContent": { +"deprecated": true, "description": "Tool call content.", "id": "GenaiVertexV1beta1ToolCallContent", "properties": { @@ -51849,6 +53525,9 @@ "mcpServerToolCall": { "$ref": "GenaiVertexV1beta1McpServerToolCallStep" }, +"retrievalCall": { +"$ref": "GenaiVertexV1beta1RetrievalCallStep" +}, "signature": { "description": "A signature hash for backend validation.", "format": "byte", @@ -51872,6 +53551,7 @@ "type": "object" }, "GenaiVertexV1beta1ToolResultContent": { +"deprecated": true, "description": "Tool result content.", "id": "GenaiVertexV1beta1ToolResultContent", "properties": { @@ -51970,6 +53650,9 @@ "mcpServerToolResult": { "$ref": "GenaiVertexV1beta1McpServerToolResultStep" }, +"retrievalResult": { +"$ref": "GenaiVertexV1beta1RetrievalResultStep" +}, "signature": { "description": "A signature hash for backend validation.", "format": "byte", @@ -51981,6 +53664,46 @@ }, "type": "object" }, +"GenaiVertexV1beta1TranscriptionConfig": { +"description": "Configuration for speech recognition (transcription).", +"id": "GenaiVertexV1beta1TranscriptionConfig", +"properties": { +"adaptationPhrases": { +"deprecated": true, +"description": "Optional. A list of phrases to bias the ASR model towards.", +"items": { +"type": "string" +}, +"type": "array" +}, +"customVocabulary": { +"description": "Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms.", +"items": { +"type": "string" +}, +"type": "array" +}, +"diarizationMode": { +"description": "Optional. Configures speaker diarization. Supported values: \"speaker\".", +"type": "string" +}, +"languageHints": { +"description": "Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to [\"auto\"] to enable automatic language detection.", +"items": { +"type": "string" +}, +"type": "array" +}, +"timestampGranularities": { +"description": "Optional. The granularity of timestamps to include in the transcription output. Supported values: \"word\". If empty, no timestamps are generated.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GenaiVertexV1beta1Turn": { "deprecated": true, "id": "GenaiVertexV1beta1Turn", @@ -52036,6 +53759,7 @@ "type": "object" }, "GenaiVertexV1beta1UrlContextCallContent": { +"deprecated": true, "description": "URL context content.", "id": "GenaiVertexV1beta1UrlContextCallContent", "properties": { @@ -52095,6 +53819,7 @@ "type": "object" }, "GenaiVertexV1beta1UrlContextResultContent": { +"deprecated": true, "description": "URL context result content.", "id": "GenaiVertexV1beta1UrlContextResultContent", "properties": { @@ -52467,6 +54192,31 @@ }, "type": "object" }, +"GenaiVertexV1beta1WordInfo": { +"description": "Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.", +"id": "GenaiVertexV1beta1WordInfo", +"properties": { +"endOffset": { +"description": "End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains \"word\".", +"format": "google-duration", +"type": "string" +}, +"speaker": { +"description": "Optional. Speaker label for this word (e.g. \"spk_1\", \"spk_2\"). Present when diarization_mode is set in TranscriptionConfig.", +"type": "string" +}, +"startOffset": { +"description": "Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains \"word\".", +"format": "google-duration", +"type": "string" +}, +"text": { +"description": "The transcribed word.", +"type": "string" +} +}, +"type": "object" +}, "GoogleApiHttpBody": { "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", "id": "GoogleApiHttpBody", @@ -52494,10 +54244,66 @@ }, "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" @@ -52513,6 +54319,20 @@ "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.", @@ -52522,7 +54342,7 @@ "type": "object" }, "name": { -"description": "Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`", +"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": { @@ -52564,6 +54384,11 @@ "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." @@ -52578,6 +54403,296 @@ "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.", +"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" +}, +"GoogleCloudAiplatformV1beta1A2aTaskArtifactChange": { +"description": "An event payload describing a change to one of the task's artifacts.", +"id": "GoogleCloudAiplatformV1beta1A2aTaskArtifactChange", +"properties": { +"append": { +"description": "Optional. Whether the artifact parts should be appended to an existing artifact rather than replacing it.", +"type": "boolean" +}, +"artifact": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskArtifact", +"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" +}, +"GoogleCloudAiplatformV1beta1A2aTaskEvent": { +"description": "An event that records a single change applied to a task's state.", +"id": "GoogleCloudAiplatformV1beta1A2aTaskEvent", +"properties": { +"createTime": { +"description": "Output only. The time at which the event was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"eventData": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskEventData", +"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" +}, +"GoogleCloudAiplatformV1beta1A2aTaskEventData": { +"description": "The data describing the change carried by an A2aTaskEvent. Exactly one of the following changes is set per event.", +"id": "GoogleCloudAiplatformV1beta1A2aTaskEventData", +"properties": { +"artifactChange": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskArtifactChange", +"description": "Optional. A change to one of the task's artifacts." +}, +"historyAppend": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend", +"description": "Optional. A new message appended to the task history." +}, +"metadataChange": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskMetadataChange", +"description": "Optional. A change to the task-level metadata." +}, +"statusUpdate": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate", +"description": "Optional. An update to the task's state and status message." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend": { +"description": "An event payload that appends a new message to the task history.", +"id": "GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend", +"properties": { +"message": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskMessage", +"description": "Required. The message to append to the task history." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1A2aTaskMessage": { +"description": "Represents a single message in a conversation, compliant with the A2A specification.", +"id": "GoogleCloudAiplatformV1beta1A2aTaskMessage", +"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", +"ROLE_USER", +"ROLE_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" +}, +"GoogleCloudAiplatformV1beta1A2aTaskMetadataChange": { +"description": "An event payload describing a change to the task-level metadata.", +"id": "GoogleCloudAiplatformV1beta1A2aTaskMetadataChange", +"properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Required. The complete task metadata after the change.", +"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" +}, +"GoogleCloudAiplatformV1beta1A2aTaskStatus": { +"description": "Represents the status of an A2aTask.", +"id": "GoogleCloudAiplatformV1beta1A2aTaskStatus", +"properties": { +"message": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskMessage", +"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" +}, +"GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate": { +"description": "An event payload that updates the task's state and optional status message.", +"id": "GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate", +"properties": { +"message": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskMessage", +"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" @@ -52776,15 +54891,15 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope": { -"description": "Resource representing an Agent Anomaly Detection Scope.", +"description": "Represents an Agent Anomaly Detection Scope.", "id": "GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope", "properties": { "displayName": { -"description": "Optional. User provided display name of the AgentAnomalyDetectionScope.", +"description": "Optional. User-provided display name of the AgentAnomalyDetectionScope.", "type": "string" }, "logBuckets": { -"description": "Required. Customer owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`.", +"description": "Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`.", "items": { "type": "string" }, @@ -52795,14 +54910,14 @@ "type": "string" }, "observabilityBuckets": { -"description": "Required. Customer owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`.", +"description": "Required. Customer-owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`.", "items": { "type": "string" }, "type": "array" }, "state": { -"description": "Output only. The lifecycle state of the scope. See `State` for the semantics of each value.", +"description": "Output only. The lifecycle state of the scope.", "enum": [ "STATE_UNSPECIFIED", "CREATING", @@ -52813,11 +54928,11 @@ ], "enumDescriptions": [ "The default value. This value is unused.", -"The scope is being provisioned: tenant project turn-up, Cloud Logging / Observability link creation, and IAM grants are still in flight. The scope is not yet usable.", -"The scope is fully provisioned and usable.", -"The scope is being torn down.", -"Creation failed. The scope is not usable. The scope must be deleted before another scope can be created in this region.", -"The scope is being updated. It remains readable in this state." +"The scope is being created and is not yet usable.", +"The scope is active and usable.", +"The scope is being deleted.", +"Creation or deletion failed. The scope is not usable and must be deleted before a new scope can be created in the same region.", +"The scope is being updated." ], "readOnly": true, "type": "string" @@ -52923,23 +55038,43 @@ "id": "GoogleCloudAiplatformV1beta1AgentResource", "properties": { "agent": { -"description": "Required. The full resource name of the agent to monitor. For REASONING_ENGINE, format: `projects/{project}/locations/{location}/reasoningEngines/{agent}`", +"description": "Required. The resource name or identifier of the agent to monitor. The format depends on `agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent.", +"type": "string" +}, +"agentFramework": { +"description": "Optional. The framework used to build the agent, orthogonal to the runtime `agent_type`.", +"enum": [ +"AGENT_FRAMEWORK_UNSPECIFIED", +"ADK" +], +"enumDescriptions": [ +"The default value, used when the framework is unspecified.", +"The agent is built with the Agent Development Kit (ADK)." +], "type": "string" }, "agentType": { -"description": "Required. The type of the agent.", +"description": "Required. The runtime type of the agent.", "enum": [ "AGENT_TYPE_UNSPECIFIED", -"REASONING_ENGINE" +"REASONING_ENGINE", +"CLOUD_RUN_SERVICE", +"GKE_WORKLOAD", +"GCE_INSTANCE", +"AGENT_TYPE_OTHER" ], "enumDescriptions": [ -"The default value. This value is used if the type is omitted.", -"The agent is a Reasoning Engine (Agent Engine)." +"The default value, used when the runtime type is unspecified.", +"The agent runs on the Gemini Enterprise Agent Platform Agent Runtime (Reasoning Engine).", +"The agent runs as a Google Cloud Run service.", +"The agent runs as a workload on Google Kubernetes Engine.", +"The agent runs on a Compute Engine instance.", +"The agent runs on another runtime, such as a self-hosted, on-premises, or non-Google Cloud environment, or any runtime not represented by the values above." ], "type": "string" }, "location": { -"description": "Output only. The GCP location (region) of the agent resource (e.g. `us-central1`).", +"description": "Output only. The Google Cloud location (region) of the agent resource (for example, `us-central1`).", "readOnly": true, "type": "string" } @@ -52973,7 +55108,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse": { -"description": "Response containing aggregated AnalyzedSession statistics, grouped by MonitoredAgent.", +"description": "Contains aggregated AnalyzedSession statistics, grouped by MonitoredAgent.", "id": "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse", "properties": { "agentAggregates": { @@ -52995,11 +55130,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate": { -"description": "Aggregated statistics for one MonitoredAgent.", +"description": "Contains aggregated statistics for one MonitoredAgent.", "id": "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate", "properties": { "agentDisplayName": { -"description": "Output only. The human-readable display name of the MonitoredAgent, denormalized from `monitored_agents.display_name`.", +"description": "Output only. The human-readable display name of the MonitoredAgent.", "readOnly": true, "type": "string" }, @@ -53008,7 +55143,7 @@ "type": "string" }, "agentStatus": { -"description": "Output only. The enablement state of the MonitoredAgent (e.g. ACTIVE, DISABLED, ENABLING, INELIGIBLE, NEEDS_ACTION), denormalized from `monitored_agents.state`.", +"description": "Output only. The enablement state of the MonitoredAgent (for example, ACTIVE, DISABLED, or ENABLING).", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ACTIVE", @@ -53035,7 +55170,7 @@ "type": "string" }, "location": { -"description": "Output only. The GCP location (region) of the agent (e.g. `us-central1`). Denormalized from `monitored_agents.location`; empty when the agent is not enrolled or its location column is empty.", +"description": "Output only. The Google Cloud location (region) of the agent (for example, `us-central1`). Empty when the agent is not enrolled or its location is unknown.", "readOnly": true, "type": "string" }, @@ -53138,7 +55273,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1AnalyzedInvocation": { -"description": "An analyzed invocation for monitored agent's session.", +"description": "Represents an analyzed invocation for a monitored agent's session.", "id": "GoogleCloudAiplatformV1beta1AnalyzedInvocation", "properties": { "assessment": { @@ -53174,11 +55309,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1AnalyzedSession": { -"description": "An analyzed session for a monitored agent.", +"description": "Represents an analyzed session for a monitored agent.", "id": "GoogleCloudAiplatformV1beta1AnalyzedSession", "properties": { "agentDisplayName": { -"description": "Output only. The human-readable display name of the MonitoredAgent that owns this session, denormalized from `monitored_agents.display_name` so the UI can render an agent name in the per-session feed without an extra `getMonitoredAgent` round-trip. May be empty when the session's agent_id is not enrolled as a MonitoredAgent (i.e. the JOIN missed); the `agent_resource_name` URN is always present and can be used as a fallback identifier.", +"description": "Output only. The human-readable display name of the MonitoredAgent that owns this session. May be empty when the session's agent is not enrolled as a MonitoredAgent; the `agent_resource_name` is always present and can be used as a fallback identifier.", "readOnly": true, "type": "string" }, @@ -53188,7 +55323,7 @@ "type": "string" }, "agentState": { -"description": "Output only. The current enablement state of the MonitoredAgent that owns this session (e.g. ACTIVE, DISABLED, ENABLING, INELIGIBLE, NEEDS_ACTION), denormalized from `monitored_agents.state`. Defaults to ENABLEMENT_STATE_UNSPECIFIED when the agent is not enrolled (the JOIN missed) or its state column is empty / unknown.", +"description": "Output only. The current enablement state of the MonitoredAgent that owns this session (for example, ACTIVE, DISABLED, or ENABLING). Defaults to ENABLEMENT_STATE_UNSPECIFIED when the agent is not enrolled or its state is unknown.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ACTIVE", @@ -53222,7 +55357,7 @@ "type": "string" }, "location": { -"description": "Output only. The GCP location (region) of the agent that ran this session (e.g. `us-central1`). Denormalized from `monitored_agents.location`; empty when the agent is not enrolled or its location column is empty.", +"description": "Output only. The Google Cloud location (region) of the agent that ran this session (for example, `us-central1`). Empty when the agent is not enrolled or its location is unknown.", "readOnly": true, "type": "string" }, @@ -53245,11 +55380,11 @@ "SESSION_STATE_LLM_UNFLAGGED" ], "enumDescriptions": [ -"Unspecified state.", -"The session has not been analyzed.", -"The session has been analyzed by Stage 1 statistical detectors and nothing was flagged.", -"The session has been analyzed by the LLM judge and at least one detector flagged it.", -"The session has been analyzed by the LLM judge and the judge did not flag any detector." +"The session state is unspecified.", +"The session has not yet been analyzed.", +"The session has been analyzed and no anomalies were flagged.", +"The session has been analyzed and at least one anomaly was flagged.", +"The session was analyzed by the LLM judge, which did not flag any anomalies." ], "readOnly": true, "type": "string" @@ -53271,7 +55406,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary": { -"description": "Breakdown of anomalies by severity.", +"description": "Breaks down anomalies by severity.", "id": "GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary", "properties": { "detectorIds": { @@ -53282,7 +55417,7 @@ "type": "array" }, "sessionsCount": { -"description": "Output only. The number of distinct sessions whose MAX severity equals `severity_level`. Each session is counted in exactly one bucket -- the highest severity that any of its detectors reached -- so summing `sessions_count` across all populated entries in a `severities` map equals the total anomalous session count for that scope (per-agent or view summary). Distinct from `detector_ids.size`: a session whose detectors fire at LOW and CRITICAL contributes one entry to `sessions_count` (in CRITICAL only) but contributes detector IDs to BOTH the LOW and CRITICAL buckets' `detector_ids` lists. For AAD audit landing-page scorecards, prefer `sessions_count` -- \"Critical anomalies\" means sessions ranked critical, not distinct critical-firing detectors. On AggregateAnalyzedSessionsResponse.summary, this is a TRUE GLOBAL count across all anomalous active agents in scope (not page-scoped). On per-agent entries within `agent_aggregates`, it's per-agent. On ListAnalyzedSessionsResponse, it is currently page-scoped to match the existing summary semantics on that API.", +"description": "Output only. The number of distinct sessions whose maximum severity equals `severity_level`. Each session is counted in exactly one bucket (its highest severity). Scope depends on where this appears: a global count on `AggregateAnalyzedSessionsResponse.summary`, per-agent on `agent_aggregates` entries, and page-scoped on `ListAnalyzedSessionsResponse`.", "format": "int32", "readOnly": true, "type": "integer" @@ -53415,11 +55550,23 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest": { -"description": "Request message for AgentEngineTaskStoreService.AppendA2aTaskEvents.", +"description": "Request message for AppendA2aTaskEvents.", "id": "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest", "properties": { +"events": { +"description": "Optional. The events to append. Used only if the parent is a TaskStore.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskEvent" +}, +"type": "array" +}, +"generation": { +"description": "Optional. The current task generation.", +"format": "int64", +"type": "string" +}, "taskEvents": { -"description": "Required. The events to append. The number of events to append must be less than or equal to 100. Otherwise, an exception will be thrown.", +"description": "Required. The events to append. The number of events to append must be less than or equal to 100. Otherwise, an exception will be thrown. Used only if the parent is a ReasoningEngine.", "items": { "$ref": "GoogleCloudAiplatformV1beta1TaskEvent" }, @@ -53429,9 +55576,15 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsResponse": { -"description": "Response message for AgentEngineTaskStoreService.AppendA2aTaskEvents.", +"description": "Response message for AppendA2aTaskEvents.", "id": "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsResponse", -"properties": {}, +"properties": { +"generation": { +"description": "Task generation matching the last event", +"format": "int64", +"type": "string" +} +}, "type": "object" }, "GoogleCloudAiplatformV1beta1AppendEventResponse": { @@ -53671,7 +55824,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Assessment": { -"description": "Detailed assessment for an analyzed session.", +"description": "Contains the detailed assessment for an analyzed session.", "id": "GoogleCloudAiplatformV1beta1Assessment", "properties": { "detectorFindings": { @@ -53902,6 +56055,107 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1AudioTranscription": { +"description": "The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label.", +"id": "GoogleCloudAiplatformV1beta1AudioTranscription", +"properties": { +"speakerLabel": { +"description": "Optional. A label identifying the speaker of this audio segment (e.g. \"spk_1\", \"spk_2\"). Present when diarization is set.", +"type": "string" +}, +"text": { +"description": "Required. The transcription text of this audio segment.", +"type": "string" +}, +"words": { +"description": "Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AudioTranscriptionConfig": { +"description": "Configuration for speech recognition (transcription).", +"id": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfig", +"properties": { +"adaptationPhrases": { +"deprecated": true, +"description": "Optional. A list of phrases to bias the ASR model towards.", +"items": { +"type": "string" +}, +"type": "array" +}, +"customVocabulary": { +"description": "Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms.", +"items": { +"type": "string" +}, +"type": "array" +}, +"diarization": { +"description": "Optional. Configures speaker diarization.", +"type": "boolean" +}, +"languageAuto": { +"$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto", +"description": "Optional. The model will detect the language automatically." +}, +"languageHints": { +"$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints", +"description": "Optional. Specifies one or more languages in the audio." +}, +"wordTimestamp": { +"description": "Optional. Configures word-level timestamp generation.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto": { +"description": "Indicates the language of the audio should be automatically detected.", +"id": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto", +"properties": {}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints": { +"description": "Provides hints to the model about possible languages present in the audio.", +"id": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints", +"properties": { +"languageCodes": { +"description": "Required. BCP-47 language codes. At least one must be specified.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo": { +"description": "Information about a single recognized word.", +"id": "GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo", +"properties": { +"endOffset": { +"description": "Optional. End offset in time of the word relative to the start of the audio.", +"format": "google-duration", +"type": "string" +}, +"startOffset": { +"description": "Optional. Start offset in time of the word relative to the start of the audio.", +"format": "google-duration", +"type": "string" +}, +"word": { +"description": "Required. Transcript of the word.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1AugmentPromptRequest": { "description": "Request message for AugmentPrompt.", "id": "GoogleCloudAiplatformV1beta1AugmentPromptRequest", @@ -54573,6 +56827,10 @@ "readOnly": true, "type": "string" }, +"endpoint": { +"description": "For Bring-Your-Own-Endpoint (BYOE), the name of the Endpoint resource that produces the predictions via this job, must share the same ancestor Location. Exactly one of model, unmanaged_container_model, or endpoint must be set. Example: `projects/193595526740/locations/us-central1/endpoints/4203439000301600768`", +"type": "string" +}, "error": { "$ref": "GoogleRpcStatus", "description": "Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.", @@ -55751,6 +58009,10 @@ "description": "Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used.", "id": "GoogleCloudAiplatformV1beta1CodeExecutionResult", "properties": { +"id": { +"description": "Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.", +"type": "string" +}, "outcome": { "description": "Required. Outcome of the code execution.", "enum": [ @@ -58589,7 +60851,12 @@ "GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest": { "description": "Request message for SemanticGovernancePolicyEngineService.DeprovisionSemanticGovernancePolicyEngine.", "id": "GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest", -"properties": {}, +"properties": { +"force": { +"description": "Optional. If true, the operation bypass checks on current state and force the deprovisioning operation.", +"type": "boolean" +} +}, "type": "object" }, "GoogleCloudAiplatformV1beta1DestinationFeatureSetting": { @@ -60232,6 +62499,10 @@ "description": "Required. The user-friendly display name for the EvaluationMetric.", "type": "string" }, +"encryptionSpec": { +"$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", +"description": "Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key." +}, "gcsUri": { "description": "Optional. The Google Cloud Storage URI that stores the metric specification..", "type": "string" @@ -61005,6 +63276,10 @@ "description": "Required. The display name of the EvaluationSet.", "type": "string" }, +"encryptionSpec": { +"$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", +"description": "Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key." +}, "evaluationItems": { "description": "Required. The EvaluationItems that are part of this dataset.", "items": { @@ -61456,6 +63731,10 @@ "description": "Required. The code to be executed.", "type": "string" }, +"id": { +"description": "Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.", +"type": "string" +}, "language": { "description": "Required. Programming language of the `code`.", "enum": [ @@ -64272,6 +66551,94 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1FeedbackContext": { +"description": "Feedback context is a resource that represents additional information about the conversation where the feedback was given, such as the conversation history, system instructions, etc. If provided, feedback context allows to correlate the feedback with the conversation, even if the original session is deleted or not available.", +"id": "GoogleCloudAiplatformV1beta1FeedbackContext", +"properties": { +"contextEvents": { +"description": "Optional. The session events from the originating session.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SessionEvent" +}, +"type": "array" +}, +"name": { +"description": "Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}/feedbackContext`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1FeedbackEntry": { +"description": "FeedbackEntry is a resource that represents a user's feedback on a conversation with an agent.", +"id": "GoogleCloudAiplatformV1beta1FeedbackEntry", +"properties": { +"createTime": { +"description": "Output only. The time at which the entry was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"customMetadata": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Additional key-value metadata associated with the feedback.", +"type": "object" +}, +"eventId": { +"description": "Required. The ID of the event within the session that the feedback relates to.", +"type": "string" +}, +"feedbackLabels": { +"items": { +"type": "string" +}, +"type": "array" +}, +"feedbackText": { +"description": "Optional. Qualitative free-form comments provided by the user.", +"type": "string" +}, +"feedbackType": { +"description": "Required. The coarse-grained type of feedback provided by the user. Must be set to a value other than `FEEDBACK_TYPE_UNSPECIFIED`.", +"enum": [ +"FEEDBACK_TYPE_UNSPECIFIED", +"THUMBS_UP", +"THUMBS_DOWN" +], +"enumDescriptions": [ +"This is the default value meaning the type has not been set.", +"Indicates positive feedback.", +"Indicates negative feedback." +], +"type": "string" +}, +"name": { +"description": "Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`", +"type": "string" +}, +"sessionId": { +"description": "Required. The ID of the session that the feedback relates to.", +"type": "string" +}, +"source": { +"description": "Optional. The surface that the feedback originated from.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The time at which the entry was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"userId": { +"description": "Optional. A caller-supplied identifier for the user who provided the feedback. The semantics of this field (for example whether it is an opaque token, a hashed value, or a user-visible identifier) are determined by the calling application.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1FetchExamplesRequest": { "description": "Request message for ExampleStoreService.FetchExamples.", "id": "GoogleCloudAiplatformV1beta1FetchExamplesRequest", @@ -65038,6 +67405,13 @@ "description": "Configuration for a single gateway.", "id": "GoogleCloudAiplatformV1beta1GatewayConfig", "properties": { +"allowedProjects": { +"description": "Optional. Additional consumer projects permitted to attach their own PSC endpoint to this gateway's ServiceAttachment. This is the \"decoupled\" mode, where the customer creates the PSC endpoint in a project other than this gateway's `network` project. Each listed project is VPC-SC enforced: it must be within the caller's service perimeter. The owning SemanticGovernancePolicyEngine's own project is always permitted implicitly and need not be listed. Format: project ID or number.", +"items": { +"type": "string" +}, +"type": "array" +}, "dnsRecord": { "description": "Output only. The fully qualified record name of the created A-record in Cloud DNS.", "readOnly": true, @@ -65983,6 +68357,10 @@ "description": "Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.", "type": "boolean" }, +"audioTranscriptionConfig": { +"$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfig", +"description": "Optional. Config for audio transcription (speech recognition)." +}, "candidateCount": { "description": "Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.", "format": "int32", @@ -66318,10 +68696,41 @@ "deprecated": true, "description": "Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response.", "type": "boolean" +}, +"groundingTypes": { +"$ref": "GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes", +"description": "Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset." } }, "type": "object" }, +"GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes": { +"description": "Defines the types of Google Maps grounding that can be enabled and their configurations.", +"id": "GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes", +"properties": { +"places": { +"$ref": "GoogleCloudAiplatformV1beta1GoogleMapsPlaces", +"description": "Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified." +}, +"routing": { +"$ref": "GoogleCloudAiplatformV1beta1GoogleMapsRouting", +"description": "Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute)." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1GoogleMapsPlaces": { +"description": "Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified.", +"id": "GoogleCloudAiplatformV1beta1GoogleMapsPlaces", +"properties": {}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1GoogleMapsRouting": { +"description": "Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute).", +"id": "GoogleCloudAiplatformV1beta1GoogleMapsRouting", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { "description": "Tool to retrieve public web data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", @@ -68435,15 +70844,22 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse": { -"description": "Response message for AgentEngineTaskStoreService.ListA2aTaskEvents.", +"description": "Response message for ListA2aTaskEvents.", "id": "GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse", "properties": { +"events": { +"description": "List of A2aTaskEvents in the requested page. Populated only by the TaskStoreService.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskEvent" +}, +"type": "array" +}, "nextPageToken": { "description": "A token to retrieve the next page of results.", "type": "string" }, "taskEvents": { -"description": "List of TaskEvents in the requested page.", +"description": "List of TaskEvents in the requested page. Populated only by the AgentEngineTaskStoreService.", "items": { "$ref": "GoogleCloudAiplatformV1beta1TaskEvent" }, @@ -68453,7 +70869,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ListA2aTasksResponse": { -"description": "Response message for AgentEngineTaskStoreService.ListA2aTasks.", +"description": "Response message for ListA2aTasks.", "id": "GoogleCloudAiplatformV1beta1ListA2aTasksResponse", "properties": { "a2aTasks": { @@ -68541,7 +70957,7 @@ }, "summary": { "$ref": "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary", -"description": "Summary statistics for the sessions returned on the current page. This is computed across the current page only (not the full result set) and is populated on every page. Callers that need aggregate statistics across the entire result set should use AggregateAnalyzedSessions." +"description": "Summary statistics computed across the sessions on the current page only. For statistics across the entire result set, use AggregateAnalyzedSessions." } }, "type": "object" @@ -68551,7 +70967,7 @@ "id": "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary", "properties": { "anomalousAgentsCount": { -"description": "Output only. The number of distinct agents matching the request scope that have at least one anomalous session in the time window. On `AggregateAnalyzedSessionsResponse.summary` (wildcard parent), this is a true GLOBAL count across all anomalous active agents, NOT the page-row count. The denominator for an \"anomalous active agents\" scorecard pairs this with `ListMonitoredAgentsResponse.total_size` (filtered to `state = ACTIVE`). On `ListAnalyzedSessionsResponse.summary`, this field is not populated (the API is per-session, not per-agent).", +"description": "Output only. The number of distinct agents in the request scope with at least one anomalous session in the time window. On `AggregateAnalyzedSessionsResponse.summary` this is a global count; it is not populated on `ListAnalyzedSessionsResponse.summary`.", "format": "int32", "readOnly": true, "type": "integer" @@ -68562,7 +70978,7 @@ "type": "integer" }, "llmScannedSessionsCount": { -"description": "Output only. The number of distinct sessions in the time window that were scanned by Stage 2 LLM judges.", +"description": "Output only. The number of distinct sessions in the time window that were scanned by the LLM judge.", "format": "int32", "readOnly": true, "type": "integer" @@ -69104,6 +71520,24 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse": { +"description": "Response message for ListFeedbackEntries.", +"id": "GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse", +"properties": { +"feedbackEntries": { +"description": "The page of FeedbackEntries matching the request.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1FeedbackEntry" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse": { "description": "Response message for JobService.ListHyperparameterTuningJobs", "id": "GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse", @@ -69390,7 +71824,7 @@ "type": "string" }, "totalSize": { -"description": "The total number of MonitoredAgents in the request scope after the request `filter` (if any) is applied. With no filter this is the unconditional count of MonitoredAgents in the parent; with `filter = \"state = ACTIVE\"` it is the active-agent count, and so on.", +"description": "The total number of MonitoredAgents matching the request, after any `filter` is applied.", "format": "int32", "type": "integer" } @@ -69794,6 +72228,26 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ListServingProfilesResponse": { +"description": "Response message for ServingProfileService.ListServingProfiles.", +"id": "GoogleCloudAiplatformV1beta1ListServingProfilesResponse", +"properties": { +"nextPageToken": { +"description": "Output only. A token to retrieve the next page of results.", +"readOnly": true, +"type": "string" +}, +"servingProfiles": { +"description": "Output only. A list of ServingProfiles.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1ServingProfile" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ListSessionsResponse": { "description": "Response message for SessionService.ListSessions.", "id": "GoogleCloudAiplatformV1beta1ListSessionsResponse", @@ -71612,7 +74066,7 @@ false }, "containerSpec": { "$ref": "GoogleCloudAiplatformV1beta1ModelContainerSpec", -"description": "Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models." +"description": "The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models." }, "createTime": { "description": "Output only. Timestamp when this Model was uploaded into Vertex AI.", @@ -73560,7 +76014,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1MonitoredAgent": { -"description": "A monitored agent in a specific Location.", +"description": "Represents a monitored agent in a specific Location.", "id": "GoogleCloudAiplatformV1beta1MonitoredAgent", "properties": { "agentResource": { @@ -74559,6 +77013,29 @@ false "persistentDiskSpec": { "$ref": "GoogleCloudAiplatformV1beta1PersistentDiskSpec", "description": "The specification of a persistent disk to attach for the execution job." +}, +"shieldedInstanceConfig": { +"$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig", +"description": "Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig": { +"description": "A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm.", +"id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig", +"properties": { +"enableIntegrityMonitoring": { +"description": "Optional. Whether the VM instance has integrity monitoring enabled.", +"type": "boolean" +}, +"enableSecureBoot": { +"description": "Optional. Whether the VM instance has Secure Boot enabled. Disabled by default.", +"type": "boolean" +}, +"enableVtpm": { +"description": "Optional. Whether the VM instance has vTPM enabled.", +"type": "boolean" } }, "type": "object" @@ -74608,7 +77085,50 @@ false "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime": { "description": "Configuration for a Workbench Instances-based environment.", "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime", -"properties": {}, +"properties": { +"customContainerImage": { +"$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage", +"description": "A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM." +}, +"vmImage": { +"$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage", +"description": "A specific Compute Engine VM image to run the notebook on." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage": { +"description": "The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`.", +"id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage", +"properties": { +"repository": { +"description": "Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`.", +"type": "string" +}, +"tag": { +"description": "Optional. The tag of the container image. If unset, defaults to `latest`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage": { +"description": "The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`.", +"id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage", +"properties": { +"family": { +"description": "Use this VM image family to find the image; the newest image in this family is used.", +"type": "string" +}, +"name": { +"description": "Use this VM image name to find the image.", +"type": "string" +}, +"project": { +"description": "Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`.", +"type": "string" +} +}, "type": "object" }, "GoogleCloudAiplatformV1beta1NotebookIdleShutdownConfig": { @@ -75018,7 +77538,7 @@ false "type": "string" }, "displayName": { -"description": "Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned.", "type": "string" }, "metricSources": { @@ -75156,7 +77676,7 @@ false "properties": { "duration": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate", -"description": "Filter on the duration of a trace." +"description": "Filter on the duration of a trace (in seconds)." }, "totalTokenUsage": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate", @@ -75628,6 +78148,10 @@ false "description": "A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", "id": "GoogleCloudAiplatformV1beta1Part", "properties": { +"audioTranscription": { +"$ref": "GoogleCloudAiplatformV1beta1AudioTranscription", +"description": "Optional. Audio (input or output) transcription. This is only set when this Part contains audio data." +}, "codeExecutionResult": { "$ref": "GoogleCloudAiplatformV1beta1CodeExecutionResult", "description": "Optional. The result of executing the ExecutableCode." @@ -77667,7 +80191,7 @@ false }, "inferenceEventLoggingConfig": { "$ref": "GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig", -"description": "Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging." +"description": "Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). When enabled, logs are emitted for all publisher-model traffic on the model -- Provisioned Throughput and on-demand alike. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging." }, "loggingConfig": { "$ref": "GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig", @@ -79977,6 +82501,10 @@ false "description": "Specification for building container image.", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec", "properties": { +"serviceAccount": { +"description": "Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com`", +"type": "string" +}, "workerPool": { "description": "Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`", "type": "string" @@ -79991,6 +82519,11 @@ false "imageUri": { "description": "Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.", "type": "string" +}, +"port": { +"description": "Optional. The port the container listens on. Defaults to 8080 if unset.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -80612,6 +83145,11 @@ false "format": "int32", "type": "integer" }, +"stepCount": { +"description": "Optional. Number of steps for the tuning job (mutually exclusive with epoch_count).", +"format": "int64", +"type": "string" +}, "thinkingBudget": { "description": "Optional. The thinking budget for the tuning job to optimize for (Gemini 2.5 only). * -1 means dynamic thinking * 0 means no thinking * > 0 means thinking budget in tokens If not set, default to -1 (dynamic thinking).", "format": "int32", @@ -82572,11 +85110,13 @@ false "description": "Required. The category of the default container image.", "enum": [ "DEFAULT_CONTAINER_CATEGORY_UNSPECIFIED", -"DEFAULT_CONTAINER_CATEGORY_COMPUTER_USE" +"DEFAULT_CONTAINER_CATEGORY_COMPUTER_USE", +"DEFAULT_CONTAINER_CATEGORY_SHELL_SANDBOX" ], "enumDescriptions": [ "The default value. This value is unused.", -"The default container image for Computer Use." +"The default container image for Computer Use.", +"The default container image for Shell Sandbox." ], "type": "string" }, @@ -82591,9 +85131,43 @@ false "description": "Configuration for egress control of sandbox instances.", "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig", "properties": { +"customerVpcNetwork": { +"description": "Optional. The customer VPC network that sandbox egress is routed into.", +"type": "string" +}, +"dnsPeeringConfigs": { +"description": "Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig" +}, +"type": "array" +}, "internetAccess": { "description": "Optional. Whether to allow internet access.", "type": "boolean" +}, +"networkAttachment": { +"description": "Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig": { +"description": "Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC.", +"id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig", +"properties": { +"domain": { +"description": "Required. The DNS name suffix of the zone being peered to, e.g., \"my-internal-domain.corp.\". Must end with a dot.", +"type": "string" +}, +"targetNetwork": { +"description": "Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.", +"type": "string" +}, +"targetProject": { +"description": "Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.", +"type": "string" } }, "type": "object" @@ -87881,6 +90455,68 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ServingProfile": { +"description": "Configures the serving behavior for a resource-less GenAI serving.", +"id": "GoogleCloudAiplatformV1beta1ServingProfile", +"properties": { +"cmekConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ServingProfileCmekConfig", +"description": "CMEK configuration for the ServingProfile." +}, +"createTime": { +"description": "Output only. Timestamp when the ServingProfile was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. The description of the ServingProfile.", +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the ServingProfile. The name can be up to 128 characters long and can consist of any UTF-8 characters.", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the ServingProfile.", +"type": "string" +}, +"scope": { +"description": "Required. The specific API this ServingProfile applies to.", +"enum": [ +"SERVING_PROFILE_SCOPE_UNSPECIFIED", +"GEMINI_LIVE", +"INTERACTIONS_API", +"RESPONSE_API" +], +"enumDescriptions": [ +"Default value. This value is unused. When users create a ServingProfile, they must choose a scope.", +"The scope for Gemini Live.", +"The scope for Interactions API.", +"The scope for Response API." +], +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp when the ServingProfile was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ServingProfileCmekConfig": { +"description": "Configuration for Customer-Managed Encryption Keys (CMEK).", +"id": "GoogleCloudAiplatformV1beta1ServingProfileCmekConfig", +"properties": { +"encryptionSpec": { +"$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", +"description": "Required. The customer-managed encryption key spec for the Serving Profile." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1Session": { "description": "A session contains a set of actions between users and Vertex agents.", "id": "GoogleCloudAiplatformV1beta1Session", @@ -87996,6 +90632,11 @@ false "publisherModelConfig": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig", "description": "Required. The publisher model config." +}, +"updateMask": { +"description": "Optional. The fields of `publisher_model_config` to overwrite. If empty, the entire config is replaced. If set, only the listed fields are overwritten and the others are left unchanged; this lets you update one setting (for example `inference_event_logging_config`) without clearing its siblings.", +"format": "google-fieldmask", +"type": "string" } }, "type": "object" @@ -88800,6 +91441,10 @@ false "description": "Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens.", "type": "string" }, +"jsonSchema": { +"description": "Optional. Represents the JSON Schema of the structured memories.", +"type": "any" +}, "memoryType": { "description": "Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used.", "enum": [ From c8f3ae7d91181829a66ed3187875af581c884d35 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:58 +0000 Subject: [PATCH 06/84] feat(alloydb): update the api #### alloydb:v1 The following keys were added: - schemas.StringRestrictions.properties.caseAgnostic (Total Keys: 2) #### alloydb:v1alpha The following keys were added: - schemas.Instance.properties.pscInstanceInfo (Total Keys: 2) - schemas.PscInstanceConfig.properties.pscAutoConnectionPolicyState.type (Total Keys: 1) - schemas.PscInstanceConfig.properties.pscAutoDnsState.type (Total Keys: 1) - schemas.PscInstanceInfo (Total Keys: 11) - schemas.StringRestrictions.properties.caseAgnostic (Total Keys: 2) #### alloydb:v1beta The following keys were added: - schemas.Instance.properties.pscInstanceInfo (Total Keys: 2) - schemas.PscInstanceConfig.properties.pscAutoConnectionPolicyState.type (Total Keys: 1) - schemas.PscInstanceConfig.properties.pscAutoDnsState.type (Total Keys: 1) - schemas.PscInstanceInfo (Total Keys: 11) - schemas.StringRestrictions.properties.caseAgnostic (Total Keys: 2) --- ...lloydb_v1.projects.locations.clusters.html | 14 +- ...ects.locations.supportedDatabaseFlags.html | 1 + ...b_v1alpha.projects.locations.clusters.html | 14 +- ...projects.locations.clusters.instances.html | 50 ++ ...ects.locations.supportedDatabaseFlags.html | 1 + ...db_v1beta.projects.locations.clusters.html | 14 +- ...projects.locations.clusters.instances.html | 50 ++ ...ects.locations.supportedDatabaseFlags.html | 1 + .../discovery_cache/documents/alloydb.v1.json | 631 ++++++++-------- .../documents/alloydb.v1alpha.json | 694 ++++++++++-------- .../documents/alloydb.v1beta.json | 694 ++++++++++-------- 11 files changed, 1216 insertions(+), 948 deletions(-) diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.html b/docs/dyn/alloydb_v1.projects.locations.clusters.html index fa66ba2b66..007547eb15 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.html @@ -305,7 +305,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -544,7 +544,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -891,7 +891,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -1165,7 +1165,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -1393,7 +1393,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -1689,7 +1689,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -1939,7 +1939,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, diff --git a/docs/dyn/alloydb_v1.projects.locations.supportedDatabaseFlags.html b/docs/dyn/alloydb_v1.projects.locations.supportedDatabaseFlags.html index 06f32ab70c..9c6855d031 100644 --- a/docs/dyn/alloydb_v1.projects.locations.supportedDatabaseFlags.html +++ b/docs/dyn/alloydb_v1.projects.locations.supportedDatabaseFlags.html @@ -129,6 +129,7 @@

Method Details

"allowedValues": [ # The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values. "A String", ], + "caseAgnostic": True or False, # Output only. Whether the allowed values are case agnostic. }, "supportedDbVersions": [ # Major database engine versions for which this flag is supported. "A String", diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html index ef68057d50..51c9a5f9f8 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html @@ -308,7 +308,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -552,7 +552,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -904,7 +904,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -1183,7 +1183,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -1416,7 +1416,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -1718,7 +1718,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -1973,7 +1973,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html index e183503de1..d97322f804 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html @@ -214,6 +214,7 @@

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. @@ -223,6 +224,7 @@

Method Details

"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. @@ -231,6 +233,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. @@ -410,6 +420,7 @@

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. @@ -419,6 +430,7 @@

Method Details

"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. @@ -427,6 +439,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. @@ -697,6 +717,7 @@

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. @@ -706,6 +727,7 @@

Method Details

"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. @@ -714,6 +736,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. @@ -945,6 +975,7 @@

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. @@ -954,6 +985,7 @@

Method Details

"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. @@ -962,6 +994,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. @@ -1130,6 +1170,7 @@

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. @@ -1139,6 +1180,7 @@

Method Details

"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. @@ -1147,6 +1189,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.supportedDatabaseFlags.html b/docs/dyn/alloydb_v1alpha.projects.locations.supportedDatabaseFlags.html index 1c0d96b60c..68705ffcd1 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.supportedDatabaseFlags.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.supportedDatabaseFlags.html @@ -129,6 +129,7 @@

Method Details

"allowedValues": [ # The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values. "A String", ], + "caseAgnostic": True or False, # Output only. Whether the allowed values are case agnostic. }, "supportedDbVersions": [ # Major database engine versions for which this flag is supported. "A String", diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html index 2e023c8556..11eba2b55e 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html @@ -308,7 +308,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -551,7 +551,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -902,7 +902,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -1180,7 +1180,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -1412,7 +1412,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -1713,7 +1713,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, @@ -1967,7 +1967,7 @@

Method Details

}, "name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} "network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. - "networkConfig": { # Metadata related to network configuration. + "networkConfig": { # Metadata related to network configuration. # Optional. "allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL. "network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster. }, diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html index fa0b7e329c..7281830c60 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html @@ -214,6 +214,7 @@

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. @@ -223,6 +224,7 @@

Method Details

"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. @@ -231,6 +233,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. @@ -409,6 +419,7 @@

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. @@ -418,6 +429,7 @@

Method Details

"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. @@ -426,6 +438,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. @@ -695,6 +715,7 @@

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. @@ -704,6 +725,7 @@

Method Details

"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. @@ -712,6 +734,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. @@ -942,6 +972,7 @@

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. @@ -951,6 +982,7 @@

Method Details

"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. @@ -959,6 +991,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. @@ -1126,6 +1166,7 @@

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. @@ -1135,6 +1176,7 @@

Method Details

"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. @@ -1143,6 +1185,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_v1beta.projects.locations.supportedDatabaseFlags.html b/docs/dyn/alloydb_v1beta.projects.locations.supportedDatabaseFlags.html index 9097f594a6..c3ad2c7f44 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.supportedDatabaseFlags.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.supportedDatabaseFlags.html @@ -129,6 +129,7 @@

Method Details

"allowedValues": [ # The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values. "A String", ], + "caseAgnostic": True or False, # Output only. Whether the allowed values are case agnostic. }, "supportedDbVersions": [ # Major database engine versions for which this flag is supported. "A String", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index df79328557..578d3c6c76 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1879,7 +1879,7 @@ } } }, -"revision": "20260701", +"revision": "20260723", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2476,7 +2476,8 @@ false "type": "string" }, "networkConfig": { -"$ref": "NetworkConfig" +"$ref": "NetworkConfig", +"description": "Optional." }, "primaryConfig": { "$ref": "PrimaryConfig", @@ -4522,15 +4523,15 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration": { -"description": "Configuration for availability of database instance", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration", "properties": { "automaticFailoverRoutingConfigured": { -"description": "Checks for existence of (multi-cluster) routing configuration that allows automatic failover to a different zone/region in case of an outage. Applicable to Bigtable resources.", +"description": "Disable validation warnings", "type": "boolean" }, "availabilityType": { -"description": "Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).", +"description": "Disable validation warnings", "enum": [ "AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", @@ -4539,118 +4540,120 @@ false "AVAILABILITY_TYPE_OTHER" ], "enumDescriptions": [ -"Unspecified availability type.", -"Zonal available instance.", -"Regional available instance.", -"Multi regional instance", -"For rest of the other category" +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "crossRegionReplicaConfigured": { -"description": "Checks for resources that are configured to have redundancy, and ongoing replication across regions", +"description": "Disable validation warnings", "type": "boolean" }, "externalReplicaConfigured": { +"description": "Disable validation warnings", "type": "boolean" }, "promotableReplicaConfigured": { +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainBackupConfiguration": { -"description": "Configuration for automatic backups", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", "properties": { "automatedBackupEnabled": { -"description": "Whether customer visible automated backups are enabled on the instance.", +"description": "Disable validation warnings", "type": "boolean" }, "backupRetentionSettings": { "$ref": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", -"description": "Backup retention settings." +"description": "Disable validation warnings" }, "pointInTimeRecoveryEnabled": { -"description": "Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted.", +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration": { -"description": "BackupDRConfiguration to capture the backup and disaster recovery details of database resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration", "properties": { "backupdrManaged": { -"description": "Indicates if the resource is managed by BackupDR.", +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainBackupDRMetadata": { -"description": "BackupDRMetadata contains information about the backup and disaster recovery metadata of a database resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainBackupDRMetadata", "properties": { "backupConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", -"description": "Backup configuration for this instance." +"description": "Disable validation warnings" }, "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Latest backup run information for this instance." +"description": "Disable validation warnings" }, "backupdrConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration", -"description": "BackupDR configuration for this instance." +"description": "Disable validation warnings" }, "fullResourceName": { -"description": "Required. Full resource name of this instance.", +"description": "Required. Disable validation warnings", "type": "string" }, "lastRefreshTime": { -"description": "Required. Last time backup configuration was refreshed.", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Required. Database resource id." +"description": "Required. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainBackupRun": { -"description": "A backup run.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainBackupRun", "properties": { "endTime": { -"description": "The time the backup operation completed. REQUIRED", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" }, "error": { "$ref": "StorageDatabasecenterPartnerapiV1mainOperationError", -"description": "Information about why the backup operation failed. This is only present if the run has the FAILED status. OPTIONAL" +"description": "Disable validation warnings" }, "startTime": { -"description": "The time the backup operation started. REQUIRED", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" }, "status": { -"description": "The status of this run. REQUIRED", +"description": "Disable validation warnings", "enum": [ "STATUS_UNSPECIFIED", "SUCCESSFUL", "FAILED" ], "enumDescriptions": [ -"Unspecified status.", -"The backup was successful.", -"The backup was unsuccessful." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -4658,43 +4661,43 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainCompliance": { -"description": "Contains compliance information about a security standard indicating unmet recommendations.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainCompliance", "properties": { "standard": { -"description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", +"description": "Disable validation warnings", "type": "string" }, "version": { -"description": "Version of the standard or benchmark, for example, 1.1", +"description": "Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData": { -"description": "Config based signal data. This is used to send signals to Condor which are based on the DB level configurations. These will be used to send signals for self managed databases.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData", "properties": { "fullResourceName": { -"description": "Required. Full Resource name of the source resource.", +"description": "Required. Disable validation warnings", "type": "string" }, "lastRefreshTime": { -"description": "Required. Last time signal was refreshed", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Database resource id." +"description": "Disable validation warnings" }, "signalBoolValue": { -"description": "Signal data for boolean signals.", +"description": "Disable validation warnings", "type": "boolean" }, "signalType": { -"description": "Required. Signal type of the signal", +"description": "Required. Disable validation warnings", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", @@ -4709,17 +4712,17 @@ false "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ], "enumDescriptions": [ -"Unspecified signal type.", -"Outdated Minor Version", -"Represents database auditing is disabled.", -"Represents if a database has a password configured for the root account or not.", -"Represents if a resource is exposed to public access.", -"Represents if a resources requires all incoming connections to use SSL or not.", -"Represents if a resource version is in extended support.", -"Represents if a resource has no automated backup policy.", -"Represents if a resource version is nearing end of life.", -"Represents if the last backup of a resource is older than 24 hours.", -"Represents if a resource is not protected by automatic failover." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -4727,11 +4730,11 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainCustomMetadataData": { -"description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainCustomMetadataData", "properties": { "internalResourceMetadata": { -"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.", +"description": "Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata" }, @@ -4741,28 +4744,28 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { -"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", "properties": { "backupdrMetadata": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupDRMetadata", -"description": "BackupDR metadata is used to ingest metadata from BackupDR." +"description": "Disable validation warnings" }, "configBasedSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData", -"description": "Config based signal data is used to ingest signals that are generated based on the configuration of the database resource." +"description": "Disable validation warnings" }, "databaseResourceSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", -"description": "Database resource signal data is used to ingest signals from database resource signal feeds." +"description": "Disable validation warnings" }, "feedTimestamp": { -"description": "Required. Timestamp when feed is generated.", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "feedType": { -"description": "Required. Type feed to be ingested into condor", +"description": "Required. Disable validation warnings", "enum": [ "FEEDTYPE_UNSPECIFIED", "RESOURCE_METADATA", @@ -4774,47 +4777,47 @@ false "DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ -"Unspecified feed type. Not expected to be used.", -"Database resource metadata feed from control plane", -"Database resource monitoring data", -"Database resource security health signal data", -"Database resource recommendation signal data", -"Database config based signal data", -"Database resource metadata from BackupDR", -"Database resource signal data" +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "observabilityMetricData": { "$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", -"description": "Observability metric data." +"description": "Disable validation warnings" }, "recommendationSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData", -"description": "Database resource recommendation signal data." +"description": "Disable validation warnings" }, "resourceHealthSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", -"description": "Database resource health signal data." +"description": "Disable validation warnings" }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "deprecated": true, -"description": "Primary key associated with the Resource. resource_id is available in individual feed level as well." +"description": "Disable validation warnings" }, "resourceMetadata": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", -"description": "Database resource metadata." +"description": "Disable validation warnings" }, "skipIngestion": { -"description": "Optional. If true, the feed won't be ingested by DB Center. This indicates that the feed is intentionally skipped. For example, BackupDR feeds are only needed for resources integrated with DB Center (e.g., CloudSQL, AlloyDB). Feeds for non-integrated resources (e.g., Compute Engine, Persistent Disk) can be skipped.", +"description": "Optional. Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData": { -"description": "Common model for database resource health signal data.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", "properties": { "additionalMetadata": { @@ -4822,39 +4825,39 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Any other additional metadata", +"description": "Disable validation warnings", "type": "object" }, "compliance": { -"description": "Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards.", +"description": "Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainCompliance" }, "type": "array" }, "description": { -"description": "Description associated with signal", +"description": "Disable validation warnings", "type": "string" }, "eventTime": { -"description": "Required. The last time at which the event described by this signal took place", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "externalUri": { -"description": "The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals.", +"description": "Disable validation warnings", "type": "string" }, "location": { -"description": "This is used to identify the location of the resource. Example: \"us-central1\"", +"description": "Disable validation warnings", "type": "string" }, "name": { -"description": "Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.", +"description": "Required. Disable validation warnings", "type": "string" }, "provider": { -"description": "Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", +"description": "Disable validation warnings", "enum": [ "PROVIDER_UNSPECIFIED", "GCP", @@ -4865,26 +4868,26 @@ false "PROVIDER_OTHER" ], "enumDescriptions": [ -"Unspecified provider.", -"Google cloud platform provider", -"Amazon web service", -"Azure web service", -"On-prem database resources.", -"Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", -"For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "resourceContainer": { -"description": "Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of \"provider//\", such as \"projects/123\". For GCP provided resources, number should be project number.", +"description": "Disable validation warnings", "type": "string" }, "resourceName": { -"description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "signalClass": { -"description": "Required. The class of the signal, such as if it's a THREAT or VULNERABILITY.", +"description": "Required. Disable validation warnings", "enum": [ "CLASS_UNSPECIFIED", "THREAT", @@ -4894,21 +4897,21 @@ false "ERROR" ], "enumDescriptions": [ -"Unspecified signal class.", -"Describes unwanted or malicious activity.", -"Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", -"Describes a potential weakness in cloud resource/asset configuration that increases risk.", -"Describes a security observation that is for informational purposes.", -"Describes an error that prevents some SCC functionality." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "signalId": { -"description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", +"description": "Required. Disable validation warnings", "type": "string" }, "signalSeverity": { -"description": "The severity of the signal, such as if it's a HIGH or LOW severity.", +"description": "Disable validation warnings", "enum": [ "SIGNAL_SEVERITY_UNSPECIFIED", "CRITICAL", @@ -4917,16 +4920,16 @@ false "LOW" ], "enumDescriptions": [ -"This value is used for findings when a source doesn't write a severity value.", -"A critical vulnerability is easily discoverable by an external actor, exploitable.", -"A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.", -"A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.", -"A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "signalType": { -"description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", +"description": "Required. Disable validation warnings", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER", @@ -5266,7 +5269,7 @@ false "type": "string" }, "state": { -"description": "Required. The state of the signal, such as if it's ACTIVE or RESOLVED.", +"description": "Required. Disable validation warnings", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -5274,10 +5277,10 @@ false "MUTED" ], "enumDescriptions": [ -"Unspecified state.", -"The signal requires attention and has not been addressed yet.", -"The signal has been fixed, triaged as a non-issue or otherwise addressed and is no longer active.", -"The signal has been muted." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -5285,11 +5288,11 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId": { -"description": "DatabaseResourceId will serve as primary key for any resource ingestion event.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "properties": { "provider": { -"description": "Required. Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", +"description": "Required. Disable validation warnings", "enum": [ "PROVIDER_UNSPECIFIED", "GCP", @@ -5300,33 +5303,33 @@ false "PROVIDER_OTHER" ], "enumDescriptions": [ -"Unspecified provider.", -"Google cloud platform provider", -"Amazon web service", -"Azure web service", -"On-prem database resources.", -"Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", -"For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "providerDescription": { -"description": "Optional. Needs to be used only when the provider is PROVIDER_OTHER.", +"description": "Optional. Disable validation warnings", "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, memorystore.googleapis.com/Instance, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "uniqueId": { -"description": "Required. A service-local token that distinguishes this resource from other resources within the same service.", +"description": "Required. Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 35", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "additionalMetadata": { @@ -5334,32 +5337,32 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Field to ingest additional metadata whichd does not support proto format.", +"description": "Disable validation warnings", "type": "object" }, "availabilityConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration", -"description": "Availability configuration for this instance" +"description": "Disable validation warnings" }, "backupConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", -"description": "Backup configuration for this instance" +"description": "Disable validation warnings" }, "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Latest backup run information for this instance" +"description": "Disable validation warnings" }, "backupdrConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration", -"description": "Optional. BackupDR Configuration for the resource." +"description": "Optional. Disable validation warnings" }, "creationTime": { -"description": "The creation time of the resource, i.e. the time when resource is created and recorded in partner service.", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" }, "currentState": { -"description": "Current state of the instance.", +"description": "Disable validation warnings", "enum": [ "STATE_UNSPECIFIED", "HEALTHY", @@ -5370,22 +5373,22 @@ false "STOPPED" ], "enumDescriptions": [ -"", -"The instance is running.", -"Instance being created, updated, deleted or under maintenance", -"When instance is suspended", -"Instance is deleted.", -"For rest of the other category", -"Instance is in STOPPED state." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "customMetadata": { "$ref": "StorageDatabasecenterPartnerapiV1mainCustomMetadataData", -"description": "Any custom metadata associated with the resource" +"description": "Disable validation warnings" }, "edition": { -"description": "Optional. Edition represents whether the instance is ENTERPRISE or ENTERPRISE_PLUS. This information is core to Cloud SQL only and is used to identify the edition of the instance.", +"description": "Optional. Disable validation warnings", "enum": [ "EDITION_UNSPECIFIED", "EDITION_ENTERPRISE", @@ -5393,22 +5396,22 @@ false "EDITION_STANDARD" ], "enumDescriptions": [ -"Default, to make it consistent with instance edition enum.", -"Represents the enterprise edition.", -"Represents the enterprise plus edition.", -"Represents the standard edition." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "entitlements": { -"description": "Entitlements associated with the resource", +"description": "Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainEntitlement" }, "type": "array" }, "expectedState": { -"description": "The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY.", +"description": "Disable validation warnings", "enum": [ "STATE_UNSPECIFIED", "HEALTHY", @@ -5419,27 +5422,27 @@ false "STOPPED" ], "enumDescriptions": [ -"", -"The instance is running.", -"Instance being created, updated, deleted or under maintenance", -"When instance is suspended", -"Instance is deleted.", -"For rest of the other category", -"Instance is in STOPPED state." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "gcbdrConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration", "deprecated": true, -"description": "GCBDR configuration for the resource." +"description": "Disable validation warnings" }, "id": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Required. Unique identifier for a Database resource" +"description": "Required. Disable validation warnings" }, "instanceType": { -"description": "The type of the instance. Specified at creation time.", +"description": "Disable validation warnings", "enum": [ "INSTANCE_TYPE_UNSPECIFIED", "SUB_RESOURCE_TYPE_UNSPECIFIED", @@ -5495,31 +5498,31 @@ false "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, -"description": "Field to ingest additional metadata which support proto format.", +"description": "Disable validation warnings", "type": "object" }, "ipAddress": { "$ref": "StorageDatabasecenterPartnerapiV1mainIpAddress", -"description": "Optional. Private and public IP address of the resource." +"description": "Optional. Disable validation warnings" }, "isDeletionProtectionEnabled": { -"description": "Optional. Whether deletion protection is enabled for this resource.", +"description": "Optional. Disable validation warnings", "type": "boolean" }, "location": { -"description": "The resource location. REQUIRED", +"description": "Disable validation warnings", "type": "string" }, "machineConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", -"description": "Machine configuration for this resource." +"description": "Disable validation warnings" }, "maintenanceInfo": { "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", -"description": "Optional. Maintenance info for the resource." +"description": "Optional. Disable validation warnings" }, "modes": { -"description": "Optional. The modes of the database resource.", +"description": "Optional. Disable validation warnings", "items": { "enum": [ "MODE_UNSPECIFIED", @@ -5530,12 +5533,12 @@ false "MODE_CLUSTER_DISABLED" ], "enumDescriptions": [ -"Default mode.", -"Native mode.", -"MongoDB compatible mode.", -"Datastore mode.", -"Memorystore/ValKey: Cluster enabled mode.", -"Memorystore/ValKey: Cluster disabled mode." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, @@ -5543,33 +5546,33 @@ false }, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." +"description": "Disable validation warnings" }, "primaryResourceLocation": { -"description": "Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.", +"description": "Disable validation warnings", "type": "string" }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", -"description": "The product this resource represents." +"description": "Disable validation warnings" }, "resourceContainer": { -"description": "Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of \"/\", such as \"projects/123\". For GCP provided resources, number should be project number.", +"description": "Disable validation warnings", "type": "string" }, "resourceFlags": { -"description": "Optional. List of resource flags for the database resource.", +"description": "Optional. Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainResourceFlags" }, "type": "array" }, "resourceName": { -"description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "suspensionReason": { -"description": "Optional. Suspension reason for the resource.", +"description": "Optional. Disable validation warnings", "enum": [ "SUSPENSION_REASON_UNSPECIFIED", "WIPEOUT_HIDE_EVENT", @@ -5592,26 +5595,26 @@ false }, "tagsSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainTags", -"description": "Optional. Tags associated with this resources." +"description": "Optional. Disable validation warnings" }, "updationTime": { -"description": "The time at which the resource was updated and recorded at partner service.", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" }, "userLabelSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", -"description": "User-provided labels associated with the resource" +"description": "Disable validation warnings" }, "zone": { -"description": "The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources.", +"description": "Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData": { -"description": "Common model for database resource recommendation signal data.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData", "properties": { "additionalMetadata": { @@ -5619,16 +5622,16 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Optional. Any other additional metadata specific to recommendation", +"description": "Optional. Disable validation warnings", "type": "object" }, "lastRefreshTime": { -"description": "Required. last time recommendationw as refreshed", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "recommendationState": { -"description": "Required. Recommendation state", +"description": "Required. Disable validation warnings", "enum": [ "UNSPECIFIED", "ACTIVE", @@ -5638,33 +5641,33 @@ false "DISMISSED" ], "enumDescriptions": [ -"", -"Recommendation is active and can be applied. ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", -"Recommendation is in claimed state. Recommendations content is immutable and cannot be updated by Google. CLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", -"Recommendation is in succeeded state. Recommendations content is immutable and cannot be updated by Google. SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.", -"Recommendation is in failed state. Recommendations content is immutable and cannot be updated by Google. FAILED recommendations can be marked as SUCCEEDED, or FAILED.", -"Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "recommender": { -"description": "Required. Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876", +"description": "Required. Disable validation warnings", "type": "string" }, "recommenderId": { -"description": "Required. ID of recommender. Examples: \"google.cloudsql.instance.PerformanceRecommender\"", +"description": "Required. Disable validation warnings", "type": "string" }, "recommenderSubtype": { -"description": "Required. Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = \"google.cloudsql.instance.PerformanceRecommender\", recommender_subtype can be \"MYSQL_HIGH_NUMBER_OF_OPEN_TABLES_BEST_PRACTICE\"/\"POSTGRES_HIGH_TRANSACTION_ID_UTILIZATION_BEST_PRACTICE\"", +"description": "Required. Disable validation warnings", "type": "string" }, "resourceName": { -"description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "signalType": { -"description": "Required. Type of signal, for example, `SIGNAL_TYPE_IDLE`, `SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES`, etc.", +"description": "Required. Disable validation warnings", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER", @@ -6007,45 +6010,45 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData": { -"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 10", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", "properties": { "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", "deprecated": true, -"description": "Deprecated: Use signal_metadata_list instead." +"description": "Disable validation warnings" }, "fullResourceName": { -"description": "Required. Full Resource name of the source resource.", +"description": "Required. Disable validation warnings", "type": "string" }, "lastRefreshTime": { -"description": "Required. Last time signal was refreshed", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "location": { -"description": "Required. Resource location.", +"description": "Required. Disable validation warnings", "type": "string" }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Database resource id." +"description": "Disable validation warnings" }, "signalBoolValue": { "deprecated": true, -"description": "Deprecated: Use signal_metadata_list instead.", +"description": "Disable validation warnings", "type": "boolean" }, "signalMetadataList": { -"description": "This will support array of OneOf signal metadata information for a given signal type.", +"description": "Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainSignalMetadata" }, "type": "array" }, "signalState": { -"description": "Required. Output only. Signal state of the signal", +"description": "Required. Output only. Disable validation warnings", "enum": [ "SIGNAL_STATE_UNSPECIFIED", "ACTIVE", @@ -6053,16 +6056,16 @@ false "DISMISSED" ], "enumDescriptions": [ -"Unspecified signal state.", -"Signal is active and requires attention.", -"Signal is inactive and does not require attention.", -"Signal is dismissed by the user and should not be shown to the user again." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "readOnly": true, "type": "string" }, "signalType": { -"description": "Required. Signal type of the signal", +"description": "Required. Disable validation warnings", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", @@ -6077,17 +6080,17 @@ false "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ], "enumDescriptions": [ -"Unspecified signal type.", -"Outdated Minor Version", -"Represents database auditing is disabled.", -"Represents if a database has a password configured for the root account or not.", -"Represents if a resource is exposed to public access.", -"Represents if a resources requires all incoming connections to use SSL or not.", -"Represents if a resource version is in extended support.", -"Represents if a resource has no automated backup policy.", -"Represents if a resource version is nearing end of life.", -"Represents if the last backup of a resource is older than 24 hours.", -"Represents if a resource is not protected by automatic failover." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -6095,25 +6098,25 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainEntitlement": { -"description": "Proto representing the access that a user has to a specific feature/service. NextId: 3.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainEntitlement", "properties": { "entitlementState": { -"description": "The current state of user's accessibility to a feature/benefit.", +"description": "Disable validation warnings", "enum": [ "ENTITLEMENT_STATE_UNSPECIFIED", "ENTITLED", "REVOKED" ], "enumDescriptions": [ -"", -"User is entitled to a feature/benefit, but whether it has been successfully provisioned is decided by provisioning state.", -"User is entitled to a feature/benefit, but it was requested to be revoked. Whether the revoke has been successful is decided by provisioning state." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "type": { -"description": "An enum that represents the type of this entitlement.", +"description": "Disable validation warnings", "enum": [ "ENTITLEMENT_TYPE_UNSPECIFIED", "GEMINI", @@ -6127,10 +6130,10 @@ false, false ], "enumDescriptions": [ -"The entitlement type is unspecified.", -"The root entitlement representing Gemini package ownership.This will no longer be supported in the future.", -"The entitlement representing Native Tier, This will be the default Entitlement going forward with GCA Enablement.", -"The entitlement representing GCA-Standard Tier." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -6138,93 +6141,94 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration": { -"description": "GCBDR Configuration for the resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration", "properties": { "gcbdrManaged": { -"description": "Whether the resource is managed by GCBDR.", +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata": { -"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata", "properties": { "backupConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", -"description": "Backup configuration for this database" +"description": "Disable validation warnings" }, "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Information about the last backup attempt for this database" +"description": "Disable validation warnings" }, "isDeletionProtectionEnabled": { -"description": "Whether deletion protection is enabled for this internal resource.", +"description": "Disable validation warnings", "type": "boolean" }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", -"description": "The product this resource represents." +"description": "Disable validation warnings" }, "resourceId": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", +"description": "Disable validation warnings" }, "resourceName": { -"description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"", +"description": "Required. Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainIpAddress": { -"description": "Used to send IP address information for a database resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainIpAddress", "properties": { "privateIp": { -"description": "The private IP address assigned to the resource within a Virtual Private Cloud (VPC). This IP is only reachable from within the same VPC network. Stored in standard string format (e.g., \"10.0.0.2\").", +"description": "Disable validation warnings", "type": "string" }, "publicIp": { -"description": "The public IP address assigned to the resource. This IP is reachable from the internet. Stored in standard string format (e.g., \"34.72.1.1\").", +"description": "Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainMachineConfiguration": { -"description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", "properties": { "baselineSlots": { -"description": "Optional. Baseline slots for BigQuery Reservations. Baseline slots are in increments of 50.", +"description": "Optional. Disable validation warnings", "format": "int64", "type": "string" }, "cpuCount": { "deprecated": true, -"description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.", +"description": "Disable validation warnings", "format": "int32", "type": "integer" }, "maxReservationSlots": { -"description": "Optional. Max slots for BigQuery Reservations. Max slots are in increments of 50.", +"description": "Optional. Disable validation warnings", "format": "int64", "type": "string" }, "memorySizeInBytes": { -"description": "Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.", +"description": "Disable validation warnings", "format": "int64", "type": "string" }, "shardCount": { -"description": "Optional. Number of shards (if applicable).", +"description": "Optional. Disable validation warnings", "format": "int32", "type": "integer" }, "vcpuCount": { -"description": "Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix.", +"description": "Optional. Disable validation warnings", "format": "double", "type": "number" } @@ -6232,10 +6236,11 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData": { +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", "properties": { "aggregationType": { -"description": "Required. Type of aggregation performed on the metric.", +"description": "Required. Disable validation warnings", "enum": [ "AGGREGATION_TYPE_UNSPECIFIED", "PEAK", @@ -6253,7 +6258,7 @@ false "type": "string" }, "metricType": { -"description": "Required. Type of metric like CPU, Memory, etc.", +"description": "Required. Disable validation warnings", "enum": [ "METRIC_TYPE_UNSPECIFIED", "CPU_UTILIZATION", @@ -6279,30 +6284,31 @@ false "type": "string" }, "observationTime": { -"description": "Required. The time the metric value was observed.", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "resourceName": { -"description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "value": { "$ref": "StorageDatabasecenterProtoCommonTypedValue", -"description": "Required. Value of the metric type." +"description": "Required. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainOperationError": { -"description": "An error that occurred during a backup creation operation.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainOperationError", "properties": { "code": { -"description": "Identifies the specific error that occurred. REQUIRED", +"description": "Disable validation warnings", "type": "string" }, "errorType": { +"description": "Disable validation warnings", "enum": [ "OPERATION_ERROR_TYPE_UNSPECIFIED", "KMS_KEY_ERROR", @@ -6324,71 +6330,71 @@ false "type": "string" }, "message": { -"description": "Additional information about the error encountered. REQUIRED", +"description": "Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainResourceFlags": { -"description": "Message type for storing resource flags.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainResourceFlags", "properties": { "key": { -"description": "Optional. Key of the resource flag.", +"description": "Optional. Disable validation warnings", "type": "string" }, "value": { -"description": "Optional. Value of the resource flag.", +"description": "Optional. Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule": { -"description": "Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule", "properties": { "endDate": { "$ref": "GoogleTypeDate", -"description": "Optional. Deny period end date." +"description": "Optional. Disable validation warnings" }, "startDate": { "$ref": "GoogleTypeDate", -"description": "Optional. The start date of the deny maintenance period." +"description": "Optional. Disable validation warnings" }, "time": { "$ref": "GoogleTypeTimeOfDay", -"description": "Optional. Time in UTC when the deny period starts on start_date and ends on end_date." +"description": "Optional. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo": { -"description": "MaintenanceInfo to capture the maintenance details of database resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", "properties": { "currentVersionReleaseDate": { "$ref": "GoogleTypeDate", -"description": "Optional. The date when the current maintenance version was released." +"description": "Optional. Disable validation warnings" }, "denyMaintenanceSchedules": { -"description": "Optional. List of Deny maintenance period for the database resource.", +"description": "Optional. Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule" }, "type": "array" }, "isInstanceStopped": { -"description": "Optional. Whether the instance is in stopped state. This information is temporarily being captured in maintenanceInfo, till STOPPED state is supported by DB Center.", +"description": "Optional. Disable validation warnings", "type": "boolean" }, "maintenanceSchedule": { "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", -"description": "Optional. Maintenance window for the database resource." +"description": "Optional. Disable validation warnings" }, "maintenanceState": { -"description": "Output only. Current state of maintenance on the database resource.", +"description": "Output only. Disable validation warnings", "enum": [ "MAINTENANCE_STATE_UNSPECIFIED", "CREATING", @@ -6399,23 +6405,23 @@ false "ERROR" ], "enumDescriptions": [ -"Unspecified state.", -"Database resource is being created.", -"Database resource has been created and is ready to use.", -"Database resource is being updated.", -"Database resource is unheathy and under repair.", -"Database resource is being deleted.", -"Database resource encountered an error and is in indeterministic state." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "readOnly": true, "type": "string" }, "maintenanceVersion": { -"description": "Optional. Current Maintenance version of the database resource. Example: \"MYSQL_8_0_41.R20250531.01_15\"", +"description": "Optional. Disable validation warnings", "type": "string" }, "nextAvailableMaintenanceVersions": { -"description": "Optional. List of next available maintenance versions.", +"description": "Optional. Disable validation warnings", "items": { "type": "string" }, @@ -6423,17 +6429,17 @@ false }, "upcomingMaintenance": { "$ref": "StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance", -"description": "Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window." +"description": "Optional. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule": { -"description": "Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. This is configured by the customer.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", "properties": { "day": { -"description": "Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", +"description": "Optional. Disable validation warnings", "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", @@ -6457,7 +6463,7 @@ false "type": "string" }, "phase": { -"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", +"description": "Optional. Disable validation warnings", "enum": [ "PHASE_UNSPECIFIED", "ANY", @@ -6466,37 +6472,38 @@ false "WEEK5" ], "enumDescriptions": [ -"Phase is unspecified.", -"Any phase.", -"Week 1.", -"Week 2.", -"Week 5." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "time": { "$ref": "GoogleTypeTimeOfDay", -"description": "Optional. Preferred time to start the maintenance operation on the specified day." +"description": "Optional. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainRetentionSettings": { +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", "properties": { "durationBasedRetention": { -"description": "Duration based retention period i.e. 172800 seconds (2 days)", +"description": "Disable validation warnings", "format": "google-duration", "type": "string" }, "quantityBasedRetention": { -"description": "Quantity based retention period i.e. 7 backups", +"description": "Disable validation warnings", "format": "int32", "type": "integer" }, "retentionUnit": { "deprecated": true, -"description": "The unit that 'retained_backups' represents.", +"description": "Disable validation warnings", "enum": [ "RETENTION_UNIT_UNSPECIFIED", "COUNT", @@ -6505,22 +6512,22 @@ false "RETENTION_UNIT_OTHER" ], "enumDescriptions": [ -"Backup retention unit is unspecified, will be treated as COUNT.", -"Retention will be by count, eg. \"retain the most recent 7 backups\".", -"Retention will be by Time, eg. \"retain backups till a specific time\" i.e. till 2024-05-01T00:00:00Z.", -"Retention will be by duration, eg. \"retain the backups for 172800 seconds (2 days)\".", -"For rest of the other category" +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "timeBasedRetention": { "deprecated": true, -"description": "Duration based retention period i.e. 172800 seconds (2 days)", +"description": "Disable validation warnings", "format": "google-duration", "type": "string" }, "timestampBasedRetentionTime": { -"description": "Timestamp based retention period i.e. 2024-05-01T00:00:00Z", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" } @@ -6528,45 +6535,45 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainSignalMetadata": { -"description": "SignalMetadata contains one of the signal metadata proto messages associated with a SignalType. This proto will be mapped to SignalMetadata message in storage.proto. Next ID: 3", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainSignalMetadata", "properties": { "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Signal data for backup runs." +"description": "Disable validation warnings" }, "signalBoolValue": { -"description": "Signal data for boolean signals.", +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainTags": { -"description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainTags", "properties": { "tags": { "additionalProperties": { "type": "string" }, -"description": "The Tag key/value mappings.", +"description": "Disable validation warnings", "type": "object" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance": { -"description": "Upcoming maintenance for the database resource. This is generated by SLM once the upcoming maintenance schedule is published.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance", "properties": { "endTime": { -"description": "Optional. The end time of the upcoming maintenance.", +"description": "Optional. Disable validation warnings", "format": "google-datetime", "type": "string" }, "startTime": { -"description": "Optional. The start time of the upcoming maintenance.", +"description": "Optional. Disable validation warnings", "format": "google-datetime", "type": "string" } @@ -6574,13 +6581,14 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainUserLabels": { -"description": "Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainUserLabels", "properties": { "labels": { "additionalProperties": { "type": "string" }, +"description": "Disable validation warnings", "type": "object" } }, @@ -6761,6 +6769,11 @@ false "type": "string" }, "type": "array" +}, +"caseAgnostic": { +"description": "Output only. Whether the allowed values are case agnostic.", +"readOnly": true, +"type": "boolean" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index d106a18c4c..603e8eca33 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -2086,7 +2086,7 @@ } } }, -"revision": "20260701", +"revision": "20260723", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2716,7 +2716,8 @@ false "type": "string" }, "networkConfig": { -"$ref": "NetworkConfig" +"$ref": "NetworkConfig", +"description": "Optional." }, "primaryConfig": { "$ref": "PrimaryConfig", @@ -3805,6 +3806,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, @@ -4577,6 +4583,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": { @@ -4584,6 +4604,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, @@ -4604,6 +4638,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", @@ -5077,15 +5141,15 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration": { -"description": "Configuration for availability of database instance", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration", "properties": { "automaticFailoverRoutingConfigured": { -"description": "Checks for existence of (multi-cluster) routing configuration that allows automatic failover to a different zone/region in case of an outage. Applicable to Bigtable resources.", +"description": "Disable validation warnings", "type": "boolean" }, "availabilityType": { -"description": "Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).", +"description": "Disable validation warnings", "enum": [ "AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", @@ -5094,118 +5158,120 @@ false "AVAILABILITY_TYPE_OTHER" ], "enumDescriptions": [ -"Unspecified availability type.", -"Zonal available instance.", -"Regional available instance.", -"Multi regional instance", -"For rest of the other category" +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "crossRegionReplicaConfigured": { -"description": "Checks for resources that are configured to have redundancy, and ongoing replication across regions", +"description": "Disable validation warnings", "type": "boolean" }, "externalReplicaConfigured": { +"description": "Disable validation warnings", "type": "boolean" }, "promotableReplicaConfigured": { +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainBackupConfiguration": { -"description": "Configuration for automatic backups", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", "properties": { "automatedBackupEnabled": { -"description": "Whether customer visible automated backups are enabled on the instance.", +"description": "Disable validation warnings", "type": "boolean" }, "backupRetentionSettings": { "$ref": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", -"description": "Backup retention settings." +"description": "Disable validation warnings" }, "pointInTimeRecoveryEnabled": { -"description": "Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted.", +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration": { -"description": "BackupDRConfiguration to capture the backup and disaster recovery details of database resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration", "properties": { "backupdrManaged": { -"description": "Indicates if the resource is managed by BackupDR.", +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainBackupDRMetadata": { -"description": "BackupDRMetadata contains information about the backup and disaster recovery metadata of a database resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainBackupDRMetadata", "properties": { "backupConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", -"description": "Backup configuration for this instance." +"description": "Disable validation warnings" }, "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Latest backup run information for this instance." +"description": "Disable validation warnings" }, "backupdrConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration", -"description": "BackupDR configuration for this instance." +"description": "Disable validation warnings" }, "fullResourceName": { -"description": "Required. Full resource name of this instance.", +"description": "Required. Disable validation warnings", "type": "string" }, "lastRefreshTime": { -"description": "Required. Last time backup configuration was refreshed.", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Required. Database resource id." +"description": "Required. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainBackupRun": { -"description": "A backup run.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainBackupRun", "properties": { "endTime": { -"description": "The time the backup operation completed. REQUIRED", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" }, "error": { "$ref": "StorageDatabasecenterPartnerapiV1mainOperationError", -"description": "Information about why the backup operation failed. This is only present if the run has the FAILED status. OPTIONAL" +"description": "Disable validation warnings" }, "startTime": { -"description": "The time the backup operation started. REQUIRED", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" }, "status": { -"description": "The status of this run. REQUIRED", +"description": "Disable validation warnings", "enum": [ "STATUS_UNSPECIFIED", "SUCCESSFUL", "FAILED" ], "enumDescriptions": [ -"Unspecified status.", -"The backup was successful.", -"The backup was unsuccessful." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -5213,43 +5279,43 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainCompliance": { -"description": "Contains compliance information about a security standard indicating unmet recommendations.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainCompliance", "properties": { "standard": { -"description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", +"description": "Disable validation warnings", "type": "string" }, "version": { -"description": "Version of the standard or benchmark, for example, 1.1", +"description": "Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData": { -"description": "Config based signal data. This is used to send signals to Condor which are based on the DB level configurations. These will be used to send signals for self managed databases.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData", "properties": { "fullResourceName": { -"description": "Required. Full Resource name of the source resource.", +"description": "Required. Disable validation warnings", "type": "string" }, "lastRefreshTime": { -"description": "Required. Last time signal was refreshed", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Database resource id." +"description": "Disable validation warnings" }, "signalBoolValue": { -"description": "Signal data for boolean signals.", +"description": "Disable validation warnings", "type": "boolean" }, "signalType": { -"description": "Required. Signal type of the signal", +"description": "Required. Disable validation warnings", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", @@ -5264,17 +5330,17 @@ false "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ], "enumDescriptions": [ -"Unspecified signal type.", -"Outdated Minor Version", -"Represents database auditing is disabled.", -"Represents if a database has a password configured for the root account or not.", -"Represents if a resource is exposed to public access.", -"Represents if a resources requires all incoming connections to use SSL or not.", -"Represents if a resource version is in extended support.", -"Represents if a resource has no automated backup policy.", -"Represents if a resource version is nearing end of life.", -"Represents if the last backup of a resource is older than 24 hours.", -"Represents if a resource is not protected by automatic failover." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -5282,11 +5348,11 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainCustomMetadataData": { -"description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainCustomMetadataData", "properties": { "internalResourceMetadata": { -"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.", +"description": "Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata" }, @@ -5296,28 +5362,28 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { -"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", "properties": { "backupdrMetadata": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupDRMetadata", -"description": "BackupDR metadata is used to ingest metadata from BackupDR." +"description": "Disable validation warnings" }, "configBasedSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData", -"description": "Config based signal data is used to ingest signals that are generated based on the configuration of the database resource." +"description": "Disable validation warnings" }, "databaseResourceSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", -"description": "Database resource signal data is used to ingest signals from database resource signal feeds." +"description": "Disable validation warnings" }, "feedTimestamp": { -"description": "Required. Timestamp when feed is generated.", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "feedType": { -"description": "Required. Type feed to be ingested into condor", +"description": "Required. Disable validation warnings", "enum": [ "FEEDTYPE_UNSPECIFIED", "RESOURCE_METADATA", @@ -5329,47 +5395,47 @@ false "DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ -"Unspecified feed type. Not expected to be used.", -"Database resource metadata feed from control plane", -"Database resource monitoring data", -"Database resource security health signal data", -"Database resource recommendation signal data", -"Database config based signal data", -"Database resource metadata from BackupDR", -"Database resource signal data" +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "observabilityMetricData": { "$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", -"description": "Observability metric data." +"description": "Disable validation warnings" }, "recommendationSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData", -"description": "Database resource recommendation signal data." +"description": "Disable validation warnings" }, "resourceHealthSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", -"description": "Database resource health signal data." +"description": "Disable validation warnings" }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "deprecated": true, -"description": "Primary key associated with the Resource. resource_id is available in individual feed level as well." +"description": "Disable validation warnings" }, "resourceMetadata": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", -"description": "Database resource metadata." +"description": "Disable validation warnings" }, "skipIngestion": { -"description": "Optional. If true, the feed won't be ingested by DB Center. This indicates that the feed is intentionally skipped. For example, BackupDR feeds are only needed for resources integrated with DB Center (e.g., CloudSQL, AlloyDB). Feeds for non-integrated resources (e.g., Compute Engine, Persistent Disk) can be skipped.", +"description": "Optional. Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData": { -"description": "Common model for database resource health signal data.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", "properties": { "additionalMetadata": { @@ -5377,39 +5443,39 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Any other additional metadata", +"description": "Disable validation warnings", "type": "object" }, "compliance": { -"description": "Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards.", +"description": "Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainCompliance" }, "type": "array" }, "description": { -"description": "Description associated with signal", +"description": "Disable validation warnings", "type": "string" }, "eventTime": { -"description": "Required. The last time at which the event described by this signal took place", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "externalUri": { -"description": "The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals.", +"description": "Disable validation warnings", "type": "string" }, "location": { -"description": "This is used to identify the location of the resource. Example: \"us-central1\"", +"description": "Disable validation warnings", "type": "string" }, "name": { -"description": "Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.", +"description": "Required. Disable validation warnings", "type": "string" }, "provider": { -"description": "Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", +"description": "Disable validation warnings", "enum": [ "PROVIDER_UNSPECIFIED", "GCP", @@ -5420,26 +5486,26 @@ false "PROVIDER_OTHER" ], "enumDescriptions": [ -"Unspecified provider.", -"Google cloud platform provider", -"Amazon web service", -"Azure web service", -"On-prem database resources.", -"Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", -"For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "resourceContainer": { -"description": "Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of \"provider//\", such as \"projects/123\". For GCP provided resources, number should be project number.", +"description": "Disable validation warnings", "type": "string" }, "resourceName": { -"description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "signalClass": { -"description": "Required. The class of the signal, such as if it's a THREAT or VULNERABILITY.", +"description": "Required. Disable validation warnings", "enum": [ "CLASS_UNSPECIFIED", "THREAT", @@ -5449,21 +5515,21 @@ false "ERROR" ], "enumDescriptions": [ -"Unspecified signal class.", -"Describes unwanted or malicious activity.", -"Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", -"Describes a potential weakness in cloud resource/asset configuration that increases risk.", -"Describes a security observation that is for informational purposes.", -"Describes an error that prevents some SCC functionality." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "signalId": { -"description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", +"description": "Required. Disable validation warnings", "type": "string" }, "signalSeverity": { -"description": "The severity of the signal, such as if it's a HIGH or LOW severity.", +"description": "Disable validation warnings", "enum": [ "SIGNAL_SEVERITY_UNSPECIFIED", "CRITICAL", @@ -5472,16 +5538,16 @@ false "LOW" ], "enumDescriptions": [ -"This value is used for findings when a source doesn't write a severity value.", -"A critical vulnerability is easily discoverable by an external actor, exploitable.", -"A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.", -"A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.", -"A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "signalType": { -"description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", +"description": "Required. Disable validation warnings", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER", @@ -5821,7 +5887,7 @@ false "type": "string" }, "state": { -"description": "Required. The state of the signal, such as if it's ACTIVE or RESOLVED.", +"description": "Required. Disable validation warnings", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -5829,10 +5895,10 @@ false "MUTED" ], "enumDescriptions": [ -"Unspecified state.", -"The signal requires attention and has not been addressed yet.", -"The signal has been fixed, triaged as a non-issue or otherwise addressed and is no longer active.", -"The signal has been muted." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -5840,11 +5906,11 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId": { -"description": "DatabaseResourceId will serve as primary key for any resource ingestion event.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "properties": { "provider": { -"description": "Required. Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", +"description": "Required. Disable validation warnings", "enum": [ "PROVIDER_UNSPECIFIED", "GCP", @@ -5855,33 +5921,33 @@ false "PROVIDER_OTHER" ], "enumDescriptions": [ -"Unspecified provider.", -"Google cloud platform provider", -"Amazon web service", -"Azure web service", -"On-prem database resources.", -"Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", -"For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "providerDescription": { -"description": "Optional. Needs to be used only when the provider is PROVIDER_OTHER.", +"description": "Optional. Disable validation warnings", "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, memorystore.googleapis.com/Instance, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "uniqueId": { -"description": "Required. A service-local token that distinguishes this resource from other resources within the same service.", +"description": "Required. Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 35", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "additionalMetadata": { @@ -5889,32 +5955,32 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Field to ingest additional metadata whichd does not support proto format.", +"description": "Disable validation warnings", "type": "object" }, "availabilityConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration", -"description": "Availability configuration for this instance" +"description": "Disable validation warnings" }, "backupConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", -"description": "Backup configuration for this instance" +"description": "Disable validation warnings" }, "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Latest backup run information for this instance" +"description": "Disable validation warnings" }, "backupdrConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration", -"description": "Optional. BackupDR Configuration for the resource." +"description": "Optional. Disable validation warnings" }, "creationTime": { -"description": "The creation time of the resource, i.e. the time when resource is created and recorded in partner service.", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" }, "currentState": { -"description": "Current state of the instance.", +"description": "Disable validation warnings", "enum": [ "STATE_UNSPECIFIED", "HEALTHY", @@ -5925,22 +5991,22 @@ false "STOPPED" ], "enumDescriptions": [ -"", -"The instance is running.", -"Instance being created, updated, deleted or under maintenance", -"When instance is suspended", -"Instance is deleted.", -"For rest of the other category", -"Instance is in STOPPED state." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "customMetadata": { "$ref": "StorageDatabasecenterPartnerapiV1mainCustomMetadataData", -"description": "Any custom metadata associated with the resource" +"description": "Disable validation warnings" }, "edition": { -"description": "Optional. Edition represents whether the instance is ENTERPRISE or ENTERPRISE_PLUS. This information is core to Cloud SQL only and is used to identify the edition of the instance.", +"description": "Optional. Disable validation warnings", "enum": [ "EDITION_UNSPECIFIED", "EDITION_ENTERPRISE", @@ -5948,22 +6014,22 @@ false "EDITION_STANDARD" ], "enumDescriptions": [ -"Default, to make it consistent with instance edition enum.", -"Represents the enterprise edition.", -"Represents the enterprise plus edition.", -"Represents the standard edition." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "entitlements": { -"description": "Entitlements associated with the resource", +"description": "Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainEntitlement" }, "type": "array" }, "expectedState": { -"description": "The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY.", +"description": "Disable validation warnings", "enum": [ "STATE_UNSPECIFIED", "HEALTHY", @@ -5974,27 +6040,27 @@ false "STOPPED" ], "enumDescriptions": [ -"", -"The instance is running.", -"Instance being created, updated, deleted or under maintenance", -"When instance is suspended", -"Instance is deleted.", -"For rest of the other category", -"Instance is in STOPPED state." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "gcbdrConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration", "deprecated": true, -"description": "GCBDR configuration for the resource." +"description": "Disable validation warnings" }, "id": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Required. Unique identifier for a Database resource" +"description": "Required. Disable validation warnings" }, "instanceType": { -"description": "The type of the instance. Specified at creation time.", +"description": "Disable validation warnings", "enum": [ "INSTANCE_TYPE_UNSPECIFIED", "SUB_RESOURCE_TYPE_UNSPECIFIED", @@ -6050,31 +6116,31 @@ false "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, -"description": "Field to ingest additional metadata which support proto format.", +"description": "Disable validation warnings", "type": "object" }, "ipAddress": { "$ref": "StorageDatabasecenterPartnerapiV1mainIpAddress", -"description": "Optional. Private and public IP address of the resource." +"description": "Optional. Disable validation warnings" }, "isDeletionProtectionEnabled": { -"description": "Optional. Whether deletion protection is enabled for this resource.", +"description": "Optional. Disable validation warnings", "type": "boolean" }, "location": { -"description": "The resource location. REQUIRED", +"description": "Disable validation warnings", "type": "string" }, "machineConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", -"description": "Machine configuration for this resource." +"description": "Disable validation warnings" }, "maintenanceInfo": { "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", -"description": "Optional. Maintenance info for the resource." +"description": "Optional. Disable validation warnings" }, "modes": { -"description": "Optional. The modes of the database resource.", +"description": "Optional. Disable validation warnings", "items": { "enum": [ "MODE_UNSPECIFIED", @@ -6085,12 +6151,12 @@ false "MODE_CLUSTER_DISABLED" ], "enumDescriptions": [ -"Default mode.", -"Native mode.", -"MongoDB compatible mode.", -"Datastore mode.", -"Memorystore/ValKey: Cluster enabled mode.", -"Memorystore/ValKey: Cluster disabled mode." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, @@ -6098,33 +6164,33 @@ false }, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." +"description": "Disable validation warnings" }, "primaryResourceLocation": { -"description": "Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.", +"description": "Disable validation warnings", "type": "string" }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", -"description": "The product this resource represents." +"description": "Disable validation warnings" }, "resourceContainer": { -"description": "Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of \"/\", such as \"projects/123\". For GCP provided resources, number should be project number.", +"description": "Disable validation warnings", "type": "string" }, "resourceFlags": { -"description": "Optional. List of resource flags for the database resource.", +"description": "Optional. Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainResourceFlags" }, "type": "array" }, "resourceName": { -"description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "suspensionReason": { -"description": "Optional. Suspension reason for the resource.", +"description": "Optional. Disable validation warnings", "enum": [ "SUSPENSION_REASON_UNSPECIFIED", "WIPEOUT_HIDE_EVENT", @@ -6147,26 +6213,26 @@ false }, "tagsSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainTags", -"description": "Optional. Tags associated with this resources." +"description": "Optional. Disable validation warnings" }, "updationTime": { -"description": "The time at which the resource was updated and recorded at partner service.", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" }, "userLabelSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", -"description": "User-provided labels associated with the resource" +"description": "Disable validation warnings" }, "zone": { -"description": "The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources.", +"description": "Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData": { -"description": "Common model for database resource recommendation signal data.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData", "properties": { "additionalMetadata": { @@ -6174,16 +6240,16 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Optional. Any other additional metadata specific to recommendation", +"description": "Optional. Disable validation warnings", "type": "object" }, "lastRefreshTime": { -"description": "Required. last time recommendationw as refreshed", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "recommendationState": { -"description": "Required. Recommendation state", +"description": "Required. Disable validation warnings", "enum": [ "UNSPECIFIED", "ACTIVE", @@ -6193,33 +6259,33 @@ false "DISMISSED" ], "enumDescriptions": [ -"", -"Recommendation is active and can be applied. ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", -"Recommendation is in claimed state. Recommendations content is immutable and cannot be updated by Google. CLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", -"Recommendation is in succeeded state. Recommendations content is immutable and cannot be updated by Google. SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.", -"Recommendation is in failed state. Recommendations content is immutable and cannot be updated by Google. FAILED recommendations can be marked as SUCCEEDED, or FAILED.", -"Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "recommender": { -"description": "Required. Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876", +"description": "Required. Disable validation warnings", "type": "string" }, "recommenderId": { -"description": "Required. ID of recommender. Examples: \"google.cloudsql.instance.PerformanceRecommender\"", +"description": "Required. Disable validation warnings", "type": "string" }, "recommenderSubtype": { -"description": "Required. Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = \"google.cloudsql.instance.PerformanceRecommender\", recommender_subtype can be \"MYSQL_HIGH_NUMBER_OF_OPEN_TABLES_BEST_PRACTICE\"/\"POSTGRES_HIGH_TRANSACTION_ID_UTILIZATION_BEST_PRACTICE\"", +"description": "Required. Disable validation warnings", "type": "string" }, "resourceName": { -"description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "signalType": { -"description": "Required. Type of signal, for example, `SIGNAL_TYPE_IDLE`, `SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES`, etc.", +"description": "Required. Disable validation warnings", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER", @@ -6562,45 +6628,45 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData": { -"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 10", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", "properties": { "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", "deprecated": true, -"description": "Deprecated: Use signal_metadata_list instead." +"description": "Disable validation warnings" }, "fullResourceName": { -"description": "Required. Full Resource name of the source resource.", +"description": "Required. Disable validation warnings", "type": "string" }, "lastRefreshTime": { -"description": "Required. Last time signal was refreshed", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "location": { -"description": "Required. Resource location.", +"description": "Required. Disable validation warnings", "type": "string" }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Database resource id." +"description": "Disable validation warnings" }, "signalBoolValue": { "deprecated": true, -"description": "Deprecated: Use signal_metadata_list instead.", +"description": "Disable validation warnings", "type": "boolean" }, "signalMetadataList": { -"description": "This will support array of OneOf signal metadata information for a given signal type.", +"description": "Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainSignalMetadata" }, "type": "array" }, "signalState": { -"description": "Required. Output only. Signal state of the signal", +"description": "Required. Output only. Disable validation warnings", "enum": [ "SIGNAL_STATE_UNSPECIFIED", "ACTIVE", @@ -6608,16 +6674,16 @@ false "DISMISSED" ], "enumDescriptions": [ -"Unspecified signal state.", -"Signal is active and requires attention.", -"Signal is inactive and does not require attention.", -"Signal is dismissed by the user and should not be shown to the user again." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "readOnly": true, "type": "string" }, "signalType": { -"description": "Required. Signal type of the signal", +"description": "Required. Disable validation warnings", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", @@ -6632,17 +6698,17 @@ false "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ], "enumDescriptions": [ -"Unspecified signal type.", -"Outdated Minor Version", -"Represents database auditing is disabled.", -"Represents if a database has a password configured for the root account or not.", -"Represents if a resource is exposed to public access.", -"Represents if a resources requires all incoming connections to use SSL or not.", -"Represents if a resource version is in extended support.", -"Represents if a resource has no automated backup policy.", -"Represents if a resource version is nearing end of life.", -"Represents if the last backup of a resource is older than 24 hours.", -"Represents if a resource is not protected by automatic failover." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -6650,25 +6716,25 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainEntitlement": { -"description": "Proto representing the access that a user has to a specific feature/service. NextId: 3.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainEntitlement", "properties": { "entitlementState": { -"description": "The current state of user's accessibility to a feature/benefit.", +"description": "Disable validation warnings", "enum": [ "ENTITLEMENT_STATE_UNSPECIFIED", "ENTITLED", "REVOKED" ], "enumDescriptions": [ -"", -"User is entitled to a feature/benefit, but whether it has been successfully provisioned is decided by provisioning state.", -"User is entitled to a feature/benefit, but it was requested to be revoked. Whether the revoke has been successful is decided by provisioning state." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "type": { -"description": "An enum that represents the type of this entitlement.", +"description": "Disable validation warnings", "enum": [ "ENTITLEMENT_TYPE_UNSPECIFIED", "GEMINI", @@ -6682,10 +6748,10 @@ false, false ], "enumDescriptions": [ -"The entitlement type is unspecified.", -"The root entitlement representing Gemini package ownership.This will no longer be supported in the future.", -"The entitlement representing Native Tier, This will be the default Entitlement going forward with GCA Enablement.", -"The entitlement representing GCA-Standard Tier." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -6693,93 +6759,94 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration": { -"description": "GCBDR Configuration for the resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration", "properties": { "gcbdrManaged": { -"description": "Whether the resource is managed by GCBDR.", +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata": { -"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata", "properties": { "backupConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", -"description": "Backup configuration for this database" +"description": "Disable validation warnings" }, "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Information about the last backup attempt for this database" +"description": "Disable validation warnings" }, "isDeletionProtectionEnabled": { -"description": "Whether deletion protection is enabled for this internal resource.", +"description": "Disable validation warnings", "type": "boolean" }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", -"description": "The product this resource represents." +"description": "Disable validation warnings" }, "resourceId": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", +"description": "Disable validation warnings" }, "resourceName": { -"description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"", +"description": "Required. Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainIpAddress": { -"description": "Used to send IP address information for a database resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainIpAddress", "properties": { "privateIp": { -"description": "The private IP address assigned to the resource within a Virtual Private Cloud (VPC). This IP is only reachable from within the same VPC network. Stored in standard string format (e.g., \"10.0.0.2\").", +"description": "Disable validation warnings", "type": "string" }, "publicIp": { -"description": "The public IP address assigned to the resource. This IP is reachable from the internet. Stored in standard string format (e.g., \"34.72.1.1\").", +"description": "Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainMachineConfiguration": { -"description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", "properties": { "baselineSlots": { -"description": "Optional. Baseline slots for BigQuery Reservations. Baseline slots are in increments of 50.", +"description": "Optional. Disable validation warnings", "format": "int64", "type": "string" }, "cpuCount": { "deprecated": true, -"description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.", +"description": "Disable validation warnings", "format": "int32", "type": "integer" }, "maxReservationSlots": { -"description": "Optional. Max slots for BigQuery Reservations. Max slots are in increments of 50.", +"description": "Optional. Disable validation warnings", "format": "int64", "type": "string" }, "memorySizeInBytes": { -"description": "Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.", +"description": "Disable validation warnings", "format": "int64", "type": "string" }, "shardCount": { -"description": "Optional. Number of shards (if applicable).", +"description": "Optional. Disable validation warnings", "format": "int32", "type": "integer" }, "vcpuCount": { -"description": "Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix.", +"description": "Optional. Disable validation warnings", "format": "double", "type": "number" } @@ -6787,10 +6854,11 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData": { +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", "properties": { "aggregationType": { -"description": "Required. Type of aggregation performed on the metric.", +"description": "Required. Disable validation warnings", "enum": [ "AGGREGATION_TYPE_UNSPECIFIED", "PEAK", @@ -6808,7 +6876,7 @@ false "type": "string" }, "metricType": { -"description": "Required. Type of metric like CPU, Memory, etc.", +"description": "Required. Disable validation warnings", "enum": [ "METRIC_TYPE_UNSPECIFIED", "CPU_UTILIZATION", @@ -6834,30 +6902,31 @@ false "type": "string" }, "observationTime": { -"description": "Required. The time the metric value was observed.", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "resourceName": { -"description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "value": { "$ref": "StorageDatabasecenterProtoCommonTypedValue", -"description": "Required. Value of the metric type." +"description": "Required. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainOperationError": { -"description": "An error that occurred during a backup creation operation.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainOperationError", "properties": { "code": { -"description": "Identifies the specific error that occurred. REQUIRED", +"description": "Disable validation warnings", "type": "string" }, "errorType": { +"description": "Disable validation warnings", "enum": [ "OPERATION_ERROR_TYPE_UNSPECIFIED", "KMS_KEY_ERROR", @@ -6879,71 +6948,71 @@ false "type": "string" }, "message": { -"description": "Additional information about the error encountered. REQUIRED", +"description": "Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainResourceFlags": { -"description": "Message type for storing resource flags.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainResourceFlags", "properties": { "key": { -"description": "Optional. Key of the resource flag.", +"description": "Optional. Disable validation warnings", "type": "string" }, "value": { -"description": "Optional. Value of the resource flag.", +"description": "Optional. Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule": { -"description": "Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule", "properties": { "endDate": { "$ref": "GoogleTypeDate", -"description": "Optional. Deny period end date." +"description": "Optional. Disable validation warnings" }, "startDate": { "$ref": "GoogleTypeDate", -"description": "Optional. The start date of the deny maintenance period." +"description": "Optional. Disable validation warnings" }, "time": { "$ref": "GoogleTypeTimeOfDay", -"description": "Optional. Time in UTC when the deny period starts on start_date and ends on end_date." +"description": "Optional. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo": { -"description": "MaintenanceInfo to capture the maintenance details of database resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", "properties": { "currentVersionReleaseDate": { "$ref": "GoogleTypeDate", -"description": "Optional. The date when the current maintenance version was released." +"description": "Optional. Disable validation warnings" }, "denyMaintenanceSchedules": { -"description": "Optional. List of Deny maintenance period for the database resource.", +"description": "Optional. Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule" }, "type": "array" }, "isInstanceStopped": { -"description": "Optional. Whether the instance is in stopped state. This information is temporarily being captured in maintenanceInfo, till STOPPED state is supported by DB Center.", +"description": "Optional. Disable validation warnings", "type": "boolean" }, "maintenanceSchedule": { "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", -"description": "Optional. Maintenance window for the database resource." +"description": "Optional. Disable validation warnings" }, "maintenanceState": { -"description": "Output only. Current state of maintenance on the database resource.", +"description": "Output only. Disable validation warnings", "enum": [ "MAINTENANCE_STATE_UNSPECIFIED", "CREATING", @@ -6954,23 +7023,23 @@ false "ERROR" ], "enumDescriptions": [ -"Unspecified state.", -"Database resource is being created.", -"Database resource has been created and is ready to use.", -"Database resource is being updated.", -"Database resource is unheathy and under repair.", -"Database resource is being deleted.", -"Database resource encountered an error and is in indeterministic state." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "readOnly": true, "type": "string" }, "maintenanceVersion": { -"description": "Optional. Current Maintenance version of the database resource. Example: \"MYSQL_8_0_41.R20250531.01_15\"", +"description": "Optional. Disable validation warnings", "type": "string" }, "nextAvailableMaintenanceVersions": { -"description": "Optional. List of next available maintenance versions.", +"description": "Optional. Disable validation warnings", "items": { "type": "string" }, @@ -6978,17 +7047,17 @@ false }, "upcomingMaintenance": { "$ref": "StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance", -"description": "Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window." +"description": "Optional. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule": { -"description": "Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. This is configured by the customer.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", "properties": { "day": { -"description": "Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", +"description": "Optional. Disable validation warnings", "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", @@ -7012,7 +7081,7 @@ false "type": "string" }, "phase": { -"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", +"description": "Optional. Disable validation warnings", "enum": [ "PHASE_UNSPECIFIED", "ANY", @@ -7021,37 +7090,38 @@ false "WEEK5" ], "enumDescriptions": [ -"Phase is unspecified.", -"Any phase.", -"Week 1.", -"Week 2.", -"Week 5." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "time": { "$ref": "GoogleTypeTimeOfDay", -"description": "Optional. Preferred time to start the maintenance operation on the specified day." +"description": "Optional. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainRetentionSettings": { +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", "properties": { "durationBasedRetention": { -"description": "Duration based retention period i.e. 172800 seconds (2 days)", +"description": "Disable validation warnings", "format": "google-duration", "type": "string" }, "quantityBasedRetention": { -"description": "Quantity based retention period i.e. 7 backups", +"description": "Disable validation warnings", "format": "int32", "type": "integer" }, "retentionUnit": { "deprecated": true, -"description": "The unit that 'retained_backups' represents.", +"description": "Disable validation warnings", "enum": [ "RETENTION_UNIT_UNSPECIFIED", "COUNT", @@ -7060,22 +7130,22 @@ false "RETENTION_UNIT_OTHER" ], "enumDescriptions": [ -"Backup retention unit is unspecified, will be treated as COUNT.", -"Retention will be by count, eg. \"retain the most recent 7 backups\".", -"Retention will be by Time, eg. \"retain backups till a specific time\" i.e. till 2024-05-01T00:00:00Z.", -"Retention will be by duration, eg. \"retain the backups for 172800 seconds (2 days)\".", -"For rest of the other category" +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "timeBasedRetention": { "deprecated": true, -"description": "Duration based retention period i.e. 172800 seconds (2 days)", +"description": "Disable validation warnings", "format": "google-duration", "type": "string" }, "timestampBasedRetentionTime": { -"description": "Timestamp based retention period i.e. 2024-05-01T00:00:00Z", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" } @@ -7083,45 +7153,45 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainSignalMetadata": { -"description": "SignalMetadata contains one of the signal metadata proto messages associated with a SignalType. This proto will be mapped to SignalMetadata message in storage.proto. Next ID: 3", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainSignalMetadata", "properties": { "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Signal data for backup runs." +"description": "Disable validation warnings" }, "signalBoolValue": { -"description": "Signal data for boolean signals.", +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainTags": { -"description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainTags", "properties": { "tags": { "additionalProperties": { "type": "string" }, -"description": "The Tag key/value mappings.", +"description": "Disable validation warnings", "type": "object" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance": { -"description": "Upcoming maintenance for the database resource. This is generated by SLM once the upcoming maintenance schedule is published.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance", "properties": { "endTime": { -"description": "Optional. The end time of the upcoming maintenance.", +"description": "Optional. Disable validation warnings", "format": "google-datetime", "type": "string" }, "startTime": { -"description": "Optional. The start time of the upcoming maintenance.", +"description": "Optional. Disable validation warnings", "format": "google-datetime", "type": "string" } @@ -7129,13 +7199,14 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainUserLabels": { -"description": "Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainUserLabels", "properties": { "labels": { "additionalProperties": { "type": "string" }, +"description": "Disable validation warnings", "type": "object" } }, @@ -7316,6 +7387,11 @@ false "type": "string" }, "type": "array" +}, +"caseAgnostic": { +"description": "Output only. Whether the allowed values are case agnostic.", +"readOnly": true, +"type": "boolean" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index 5bdff89e94..2441655386 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -2083,7 +2083,7 @@ } } }, -"revision": "20260701", +"revision": "20260723", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2702,7 +2702,8 @@ false "type": "string" }, "networkConfig": { -"$ref": "NetworkConfig" +"$ref": "NetworkConfig", +"description": "Optional." }, "primaryConfig": { "$ref": "PrimaryConfig", @@ -3786,6 +3787,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, @@ -4553,6 +4559,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": { @@ -4560,6 +4580,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, @@ -4580,6 +4614,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", @@ -5053,15 +5117,15 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration": { -"description": "Configuration for availability of database instance", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration", "properties": { "automaticFailoverRoutingConfigured": { -"description": "Checks for existence of (multi-cluster) routing configuration that allows automatic failover to a different zone/region in case of an outage. Applicable to Bigtable resources.", +"description": "Disable validation warnings", "type": "boolean" }, "availabilityType": { -"description": "Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).", +"description": "Disable validation warnings", "enum": [ "AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", @@ -5070,118 +5134,120 @@ false "AVAILABILITY_TYPE_OTHER" ], "enumDescriptions": [ -"Unspecified availability type.", -"Zonal available instance.", -"Regional available instance.", -"Multi regional instance", -"For rest of the other category" +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "crossRegionReplicaConfigured": { -"description": "Checks for resources that are configured to have redundancy, and ongoing replication across regions", +"description": "Disable validation warnings", "type": "boolean" }, "externalReplicaConfigured": { +"description": "Disable validation warnings", "type": "boolean" }, "promotableReplicaConfigured": { +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainBackupConfiguration": { -"description": "Configuration for automatic backups", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", "properties": { "automatedBackupEnabled": { -"description": "Whether customer visible automated backups are enabled on the instance.", +"description": "Disable validation warnings", "type": "boolean" }, "backupRetentionSettings": { "$ref": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", -"description": "Backup retention settings." +"description": "Disable validation warnings" }, "pointInTimeRecoveryEnabled": { -"description": "Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted.", +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration": { -"description": "BackupDRConfiguration to capture the backup and disaster recovery details of database resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration", "properties": { "backupdrManaged": { -"description": "Indicates if the resource is managed by BackupDR.", +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainBackupDRMetadata": { -"description": "BackupDRMetadata contains information about the backup and disaster recovery metadata of a database resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainBackupDRMetadata", "properties": { "backupConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", -"description": "Backup configuration for this instance." +"description": "Disable validation warnings" }, "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Latest backup run information for this instance." +"description": "Disable validation warnings" }, "backupdrConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration", -"description": "BackupDR configuration for this instance." +"description": "Disable validation warnings" }, "fullResourceName": { -"description": "Required. Full resource name of this instance.", +"description": "Required. Disable validation warnings", "type": "string" }, "lastRefreshTime": { -"description": "Required. Last time backup configuration was refreshed.", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Required. Database resource id." +"description": "Required. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainBackupRun": { -"description": "A backup run.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainBackupRun", "properties": { "endTime": { -"description": "The time the backup operation completed. REQUIRED", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" }, "error": { "$ref": "StorageDatabasecenterPartnerapiV1mainOperationError", -"description": "Information about why the backup operation failed. This is only present if the run has the FAILED status. OPTIONAL" +"description": "Disable validation warnings" }, "startTime": { -"description": "The time the backup operation started. REQUIRED", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" }, "status": { -"description": "The status of this run. REQUIRED", +"description": "Disable validation warnings", "enum": [ "STATUS_UNSPECIFIED", "SUCCESSFUL", "FAILED" ], "enumDescriptions": [ -"Unspecified status.", -"The backup was successful.", -"The backup was unsuccessful." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -5189,43 +5255,43 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainCompliance": { -"description": "Contains compliance information about a security standard indicating unmet recommendations.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainCompliance", "properties": { "standard": { -"description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", +"description": "Disable validation warnings", "type": "string" }, "version": { -"description": "Version of the standard or benchmark, for example, 1.1", +"description": "Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData": { -"description": "Config based signal data. This is used to send signals to Condor which are based on the DB level configurations. These will be used to send signals for self managed databases.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData", "properties": { "fullResourceName": { -"description": "Required. Full Resource name of the source resource.", +"description": "Required. Disable validation warnings", "type": "string" }, "lastRefreshTime": { -"description": "Required. Last time signal was refreshed", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Database resource id." +"description": "Disable validation warnings" }, "signalBoolValue": { -"description": "Signal data for boolean signals.", +"description": "Disable validation warnings", "type": "boolean" }, "signalType": { -"description": "Required. Signal type of the signal", +"description": "Required. Disable validation warnings", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", @@ -5240,17 +5306,17 @@ false "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ], "enumDescriptions": [ -"Unspecified signal type.", -"Outdated Minor Version", -"Represents database auditing is disabled.", -"Represents if a database has a password configured for the root account or not.", -"Represents if a resource is exposed to public access.", -"Represents if a resources requires all incoming connections to use SSL or not.", -"Represents if a resource version is in extended support.", -"Represents if a resource has no automated backup policy.", -"Represents if a resource version is nearing end of life.", -"Represents if the last backup of a resource is older than 24 hours.", -"Represents if a resource is not protected by automatic failover." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -5258,11 +5324,11 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainCustomMetadataData": { -"description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainCustomMetadataData", "properties": { "internalResourceMetadata": { -"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.", +"description": "Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata" }, @@ -5272,28 +5338,28 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { -"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", "properties": { "backupdrMetadata": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupDRMetadata", -"description": "BackupDR metadata is used to ingest metadata from BackupDR." +"description": "Disable validation warnings" }, "configBasedSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData", -"description": "Config based signal data is used to ingest signals that are generated based on the configuration of the database resource." +"description": "Disable validation warnings" }, "databaseResourceSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", -"description": "Database resource signal data is used to ingest signals from database resource signal feeds." +"description": "Disable validation warnings" }, "feedTimestamp": { -"description": "Required. Timestamp when feed is generated.", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "feedType": { -"description": "Required. Type feed to be ingested into condor", +"description": "Required. Disable validation warnings", "enum": [ "FEEDTYPE_UNSPECIFIED", "RESOURCE_METADATA", @@ -5305,47 +5371,47 @@ false "DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ -"Unspecified feed type. Not expected to be used.", -"Database resource metadata feed from control plane", -"Database resource monitoring data", -"Database resource security health signal data", -"Database resource recommendation signal data", -"Database config based signal data", -"Database resource metadata from BackupDR", -"Database resource signal data" +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "observabilityMetricData": { "$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", -"description": "Observability metric data." +"description": "Disable validation warnings" }, "recommendationSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData", -"description": "Database resource recommendation signal data." +"description": "Disable validation warnings" }, "resourceHealthSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", -"description": "Database resource health signal data." +"description": "Disable validation warnings" }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "deprecated": true, -"description": "Primary key associated with the Resource. resource_id is available in individual feed level as well." +"description": "Disable validation warnings" }, "resourceMetadata": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", -"description": "Database resource metadata." +"description": "Disable validation warnings" }, "skipIngestion": { -"description": "Optional. If true, the feed won't be ingested by DB Center. This indicates that the feed is intentionally skipped. For example, BackupDR feeds are only needed for resources integrated with DB Center (e.g., CloudSQL, AlloyDB). Feeds for non-integrated resources (e.g., Compute Engine, Persistent Disk) can be skipped.", +"description": "Optional. Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData": { -"description": "Common model for database resource health signal data.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", "properties": { "additionalMetadata": { @@ -5353,39 +5419,39 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Any other additional metadata", +"description": "Disable validation warnings", "type": "object" }, "compliance": { -"description": "Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards.", +"description": "Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainCompliance" }, "type": "array" }, "description": { -"description": "Description associated with signal", +"description": "Disable validation warnings", "type": "string" }, "eventTime": { -"description": "Required. The last time at which the event described by this signal took place", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "externalUri": { -"description": "The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals.", +"description": "Disable validation warnings", "type": "string" }, "location": { -"description": "This is used to identify the location of the resource. Example: \"us-central1\"", +"description": "Disable validation warnings", "type": "string" }, "name": { -"description": "Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.", +"description": "Required. Disable validation warnings", "type": "string" }, "provider": { -"description": "Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", +"description": "Disable validation warnings", "enum": [ "PROVIDER_UNSPECIFIED", "GCP", @@ -5396,26 +5462,26 @@ false "PROVIDER_OTHER" ], "enumDescriptions": [ -"Unspecified provider.", -"Google cloud platform provider", -"Amazon web service", -"Azure web service", -"On-prem database resources.", -"Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", -"For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "resourceContainer": { -"description": "Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of \"provider//\", such as \"projects/123\". For GCP provided resources, number should be project number.", +"description": "Disable validation warnings", "type": "string" }, "resourceName": { -"description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "signalClass": { -"description": "Required. The class of the signal, such as if it's a THREAT or VULNERABILITY.", +"description": "Required. Disable validation warnings", "enum": [ "CLASS_UNSPECIFIED", "THREAT", @@ -5425,21 +5491,21 @@ false "ERROR" ], "enumDescriptions": [ -"Unspecified signal class.", -"Describes unwanted or malicious activity.", -"Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", -"Describes a potential weakness in cloud resource/asset configuration that increases risk.", -"Describes a security observation that is for informational purposes.", -"Describes an error that prevents some SCC functionality." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "signalId": { -"description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", +"description": "Required. Disable validation warnings", "type": "string" }, "signalSeverity": { -"description": "The severity of the signal, such as if it's a HIGH or LOW severity.", +"description": "Disable validation warnings", "enum": [ "SIGNAL_SEVERITY_UNSPECIFIED", "CRITICAL", @@ -5448,16 +5514,16 @@ false "LOW" ], "enumDescriptions": [ -"This value is used for findings when a source doesn't write a severity value.", -"A critical vulnerability is easily discoverable by an external actor, exploitable.", -"A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.", -"A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.", -"A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "signalType": { -"description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", +"description": "Required. Disable validation warnings", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER", @@ -5797,7 +5863,7 @@ false "type": "string" }, "state": { -"description": "Required. The state of the signal, such as if it's ACTIVE or RESOLVED.", +"description": "Required. Disable validation warnings", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -5805,10 +5871,10 @@ false "MUTED" ], "enumDescriptions": [ -"Unspecified state.", -"The signal requires attention and has not been addressed yet.", -"The signal has been fixed, triaged as a non-issue or otherwise addressed and is no longer active.", -"The signal has been muted." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -5816,11 +5882,11 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId": { -"description": "DatabaseResourceId will serve as primary key for any resource ingestion event.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "properties": { "provider": { -"description": "Required. Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", +"description": "Required. Disable validation warnings", "enum": [ "PROVIDER_UNSPECIFIED", "GCP", @@ -5831,33 +5897,33 @@ false "PROVIDER_OTHER" ], "enumDescriptions": [ -"Unspecified provider.", -"Google cloud platform provider", -"Amazon web service", -"Azure web service", -"On-prem database resources.", -"Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", -"For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "providerDescription": { -"description": "Optional. Needs to be used only when the provider is PROVIDER_OTHER.", +"description": "Optional. Disable validation warnings", "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, memorystore.googleapis.com/Instance, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "uniqueId": { -"description": "Required. A service-local token that distinguishes this resource from other resources within the same service.", +"description": "Required. Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 35", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "additionalMetadata": { @@ -5865,32 +5931,32 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Field to ingest additional metadata whichd does not support proto format.", +"description": "Disable validation warnings", "type": "object" }, "availabilityConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration", -"description": "Availability configuration for this instance" +"description": "Disable validation warnings" }, "backupConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", -"description": "Backup configuration for this instance" +"description": "Disable validation warnings" }, "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Latest backup run information for this instance" +"description": "Disable validation warnings" }, "backupdrConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration", -"description": "Optional. BackupDR Configuration for the resource." +"description": "Optional. Disable validation warnings" }, "creationTime": { -"description": "The creation time of the resource, i.e. the time when resource is created and recorded in partner service.", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" }, "currentState": { -"description": "Current state of the instance.", +"description": "Disable validation warnings", "enum": [ "STATE_UNSPECIFIED", "HEALTHY", @@ -5901,22 +5967,22 @@ false "STOPPED" ], "enumDescriptions": [ -"", -"The instance is running.", -"Instance being created, updated, deleted or under maintenance", -"When instance is suspended", -"Instance is deleted.", -"For rest of the other category", -"Instance is in STOPPED state." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "customMetadata": { "$ref": "StorageDatabasecenterPartnerapiV1mainCustomMetadataData", -"description": "Any custom metadata associated with the resource" +"description": "Disable validation warnings" }, "edition": { -"description": "Optional. Edition represents whether the instance is ENTERPRISE or ENTERPRISE_PLUS. This information is core to Cloud SQL only and is used to identify the edition of the instance.", +"description": "Optional. Disable validation warnings", "enum": [ "EDITION_UNSPECIFIED", "EDITION_ENTERPRISE", @@ -5924,22 +5990,22 @@ false "EDITION_STANDARD" ], "enumDescriptions": [ -"Default, to make it consistent with instance edition enum.", -"Represents the enterprise edition.", -"Represents the enterprise plus edition.", -"Represents the standard edition." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "entitlements": { -"description": "Entitlements associated with the resource", +"description": "Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainEntitlement" }, "type": "array" }, "expectedState": { -"description": "The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY.", +"description": "Disable validation warnings", "enum": [ "STATE_UNSPECIFIED", "HEALTHY", @@ -5950,27 +6016,27 @@ false "STOPPED" ], "enumDescriptions": [ -"", -"The instance is running.", -"Instance being created, updated, deleted or under maintenance", -"When instance is suspended", -"Instance is deleted.", -"For rest of the other category", -"Instance is in STOPPED state." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "gcbdrConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration", "deprecated": true, -"description": "GCBDR configuration for the resource." +"description": "Disable validation warnings" }, "id": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Required. Unique identifier for a Database resource" +"description": "Required. Disable validation warnings" }, "instanceType": { -"description": "The type of the instance. Specified at creation time.", +"description": "Disable validation warnings", "enum": [ "INSTANCE_TYPE_UNSPECIFIED", "SUB_RESOURCE_TYPE_UNSPECIFIED", @@ -6026,31 +6092,31 @@ false "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, -"description": "Field to ingest additional metadata which support proto format.", +"description": "Disable validation warnings", "type": "object" }, "ipAddress": { "$ref": "StorageDatabasecenterPartnerapiV1mainIpAddress", -"description": "Optional. Private and public IP address of the resource." +"description": "Optional. Disable validation warnings" }, "isDeletionProtectionEnabled": { -"description": "Optional. Whether deletion protection is enabled for this resource.", +"description": "Optional. Disable validation warnings", "type": "boolean" }, "location": { -"description": "The resource location. REQUIRED", +"description": "Disable validation warnings", "type": "string" }, "machineConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", -"description": "Machine configuration for this resource." +"description": "Disable validation warnings" }, "maintenanceInfo": { "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", -"description": "Optional. Maintenance info for the resource." +"description": "Optional. Disable validation warnings" }, "modes": { -"description": "Optional. The modes of the database resource.", +"description": "Optional. Disable validation warnings", "items": { "enum": [ "MODE_UNSPECIFIED", @@ -6061,12 +6127,12 @@ false "MODE_CLUSTER_DISABLED" ], "enumDescriptions": [ -"Default mode.", -"Native mode.", -"MongoDB compatible mode.", -"Datastore mode.", -"Memorystore/ValKey: Cluster enabled mode.", -"Memorystore/ValKey: Cluster disabled mode." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, @@ -6074,33 +6140,33 @@ false }, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." +"description": "Disable validation warnings" }, "primaryResourceLocation": { -"description": "Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.", +"description": "Disable validation warnings", "type": "string" }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", -"description": "The product this resource represents." +"description": "Disable validation warnings" }, "resourceContainer": { -"description": "Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of \"/\", such as \"projects/123\". For GCP provided resources, number should be project number.", +"description": "Disable validation warnings", "type": "string" }, "resourceFlags": { -"description": "Optional. List of resource flags for the database resource.", +"description": "Optional. Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainResourceFlags" }, "type": "array" }, "resourceName": { -"description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "suspensionReason": { -"description": "Optional. Suspension reason for the resource.", +"description": "Optional. Disable validation warnings", "enum": [ "SUSPENSION_REASON_UNSPECIFIED", "WIPEOUT_HIDE_EVENT", @@ -6123,26 +6189,26 @@ false }, "tagsSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainTags", -"description": "Optional. Tags associated with this resources." +"description": "Optional. Disable validation warnings" }, "updationTime": { -"description": "The time at which the resource was updated and recorded at partner service.", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" }, "userLabelSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", -"description": "User-provided labels associated with the resource" +"description": "Disable validation warnings" }, "zone": { -"description": "The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources.", +"description": "Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData": { -"description": "Common model for database resource recommendation signal data.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData", "properties": { "additionalMetadata": { @@ -6150,16 +6216,16 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Optional. Any other additional metadata specific to recommendation", +"description": "Optional. Disable validation warnings", "type": "object" }, "lastRefreshTime": { -"description": "Required. last time recommendationw as refreshed", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "recommendationState": { -"description": "Required. Recommendation state", +"description": "Required. Disable validation warnings", "enum": [ "UNSPECIFIED", "ACTIVE", @@ -6169,33 +6235,33 @@ false "DISMISSED" ], "enumDescriptions": [ -"", -"Recommendation is active and can be applied. ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", -"Recommendation is in claimed state. Recommendations content is immutable and cannot be updated by Google. CLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", -"Recommendation is in succeeded state. Recommendations content is immutable and cannot be updated by Google. SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.", -"Recommendation is in failed state. Recommendations content is immutable and cannot be updated by Google. FAILED recommendations can be marked as SUCCEEDED, or FAILED.", -"Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "recommender": { -"description": "Required. Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876", +"description": "Required. Disable validation warnings", "type": "string" }, "recommenderId": { -"description": "Required. ID of recommender. Examples: \"google.cloudsql.instance.PerformanceRecommender\"", +"description": "Required. Disable validation warnings", "type": "string" }, "recommenderSubtype": { -"description": "Required. Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = \"google.cloudsql.instance.PerformanceRecommender\", recommender_subtype can be \"MYSQL_HIGH_NUMBER_OF_OPEN_TABLES_BEST_PRACTICE\"/\"POSTGRES_HIGH_TRANSACTION_ID_UTILIZATION_BEST_PRACTICE\"", +"description": "Required. Disable validation warnings", "type": "string" }, "resourceName": { -"description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "signalType": { -"description": "Required. Type of signal, for example, `SIGNAL_TYPE_IDLE`, `SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES`, etc.", +"description": "Required. Disable validation warnings", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER", @@ -6538,45 +6604,45 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData": { -"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 10", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", "properties": { "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", "deprecated": true, -"description": "Deprecated: Use signal_metadata_list instead." +"description": "Disable validation warnings" }, "fullResourceName": { -"description": "Required. Full Resource name of the source resource.", +"description": "Required. Disable validation warnings", "type": "string" }, "lastRefreshTime": { -"description": "Required. Last time signal was refreshed", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "location": { -"description": "Required. Resource location.", +"description": "Required. Disable validation warnings", "type": "string" }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Database resource id." +"description": "Disable validation warnings" }, "signalBoolValue": { "deprecated": true, -"description": "Deprecated: Use signal_metadata_list instead.", +"description": "Disable validation warnings", "type": "boolean" }, "signalMetadataList": { -"description": "This will support array of OneOf signal metadata information for a given signal type.", +"description": "Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainSignalMetadata" }, "type": "array" }, "signalState": { -"description": "Required. Output only. Signal state of the signal", +"description": "Required. Output only. Disable validation warnings", "enum": [ "SIGNAL_STATE_UNSPECIFIED", "ACTIVE", @@ -6584,16 +6650,16 @@ false "DISMISSED" ], "enumDescriptions": [ -"Unspecified signal state.", -"Signal is active and requires attention.", -"Signal is inactive and does not require attention.", -"Signal is dismissed by the user and should not be shown to the user again." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "readOnly": true, "type": "string" }, "signalType": { -"description": "Required. Signal type of the signal", +"description": "Required. Disable validation warnings", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", @@ -6608,17 +6674,17 @@ false "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ], "enumDescriptions": [ -"Unspecified signal type.", -"Outdated Minor Version", -"Represents database auditing is disabled.", -"Represents if a database has a password configured for the root account or not.", -"Represents if a resource is exposed to public access.", -"Represents if a resources requires all incoming connections to use SSL or not.", -"Represents if a resource version is in extended support.", -"Represents if a resource has no automated backup policy.", -"Represents if a resource version is nearing end of life.", -"Represents if the last backup of a resource is older than 24 hours.", -"Represents if a resource is not protected by automatic failover." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -6626,25 +6692,25 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainEntitlement": { -"description": "Proto representing the access that a user has to a specific feature/service. NextId: 3.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainEntitlement", "properties": { "entitlementState": { -"description": "The current state of user's accessibility to a feature/benefit.", +"description": "Disable validation warnings", "enum": [ "ENTITLEMENT_STATE_UNSPECIFIED", "ENTITLED", "REVOKED" ], "enumDescriptions": [ -"", -"User is entitled to a feature/benefit, but whether it has been successfully provisioned is decided by provisioning state.", -"User is entitled to a feature/benefit, but it was requested to be revoked. Whether the revoke has been successful is decided by provisioning state." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "type": { -"description": "An enum that represents the type of this entitlement.", +"description": "Disable validation warnings", "enum": [ "ENTITLEMENT_TYPE_UNSPECIFIED", "GEMINI", @@ -6658,10 +6724,10 @@ false, false ], "enumDescriptions": [ -"The entitlement type is unspecified.", -"The root entitlement representing Gemini package ownership.This will no longer be supported in the future.", -"The entitlement representing Native Tier, This will be the default Entitlement going forward with GCA Enablement.", -"The entitlement representing GCA-Standard Tier." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" } @@ -6669,93 +6735,94 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration": { -"description": "GCBDR Configuration for the resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration", "properties": { "gcbdrManaged": { -"description": "Whether the resource is managed by GCBDR.", +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata": { -"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata", "properties": { "backupConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", -"description": "Backup configuration for this database" +"description": "Disable validation warnings" }, "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Information about the last backup attempt for this database" +"description": "Disable validation warnings" }, "isDeletionProtectionEnabled": { -"description": "Whether deletion protection is enabled for this internal resource.", +"description": "Disable validation warnings", "type": "boolean" }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", -"description": "The product this resource represents." +"description": "Disable validation warnings" }, "resourceId": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", +"description": "Disable validation warnings" }, "resourceName": { -"description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"", +"description": "Required. Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainIpAddress": { -"description": "Used to send IP address information for a database resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainIpAddress", "properties": { "privateIp": { -"description": "The private IP address assigned to the resource within a Virtual Private Cloud (VPC). This IP is only reachable from within the same VPC network. Stored in standard string format (e.g., \"10.0.0.2\").", +"description": "Disable validation warnings", "type": "string" }, "publicIp": { -"description": "The public IP address assigned to the resource. This IP is reachable from the internet. Stored in standard string format (e.g., \"34.72.1.1\").", +"description": "Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainMachineConfiguration": { -"description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", "properties": { "baselineSlots": { -"description": "Optional. Baseline slots for BigQuery Reservations. Baseline slots are in increments of 50.", +"description": "Optional. Disable validation warnings", "format": "int64", "type": "string" }, "cpuCount": { "deprecated": true, -"description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.", +"description": "Disable validation warnings", "format": "int32", "type": "integer" }, "maxReservationSlots": { -"description": "Optional. Max slots for BigQuery Reservations. Max slots are in increments of 50.", +"description": "Optional. Disable validation warnings", "format": "int64", "type": "string" }, "memorySizeInBytes": { -"description": "Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.", +"description": "Disable validation warnings", "format": "int64", "type": "string" }, "shardCount": { -"description": "Optional. Number of shards (if applicable).", +"description": "Optional. Disable validation warnings", "format": "int32", "type": "integer" }, "vcpuCount": { -"description": "Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix.", +"description": "Optional. Disable validation warnings", "format": "double", "type": "number" } @@ -6763,10 +6830,11 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData": { +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", "properties": { "aggregationType": { -"description": "Required. Type of aggregation performed on the metric.", +"description": "Required. Disable validation warnings", "enum": [ "AGGREGATION_TYPE_UNSPECIFIED", "PEAK", @@ -6784,7 +6852,7 @@ false "type": "string" }, "metricType": { -"description": "Required. Type of metric like CPU, Memory, etc.", +"description": "Required. Disable validation warnings", "enum": [ "METRIC_TYPE_UNSPECIFIED", "CPU_UTILIZATION", @@ -6810,30 +6878,31 @@ false "type": "string" }, "observationTime": { -"description": "Required. The time the metric value was observed.", +"description": "Required. Disable validation warnings", "format": "google-datetime", "type": "string" }, "resourceName": { -"description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", +"description": "Required. Disable validation warnings", "type": "string" }, "value": { "$ref": "StorageDatabasecenterProtoCommonTypedValue", -"description": "Required. Value of the metric type." +"description": "Required. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainOperationError": { -"description": "An error that occurred during a backup creation operation.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainOperationError", "properties": { "code": { -"description": "Identifies the specific error that occurred. REQUIRED", +"description": "Disable validation warnings", "type": "string" }, "errorType": { +"description": "Disable validation warnings", "enum": [ "OPERATION_ERROR_TYPE_UNSPECIFIED", "KMS_KEY_ERROR", @@ -6855,71 +6924,71 @@ false "type": "string" }, "message": { -"description": "Additional information about the error encountered. REQUIRED", +"description": "Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainResourceFlags": { -"description": "Message type for storing resource flags.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainResourceFlags", "properties": { "key": { -"description": "Optional. Key of the resource flag.", +"description": "Optional. Disable validation warnings", "type": "string" }, "value": { -"description": "Optional. Value of the resource flag.", +"description": "Optional. Disable validation warnings", "type": "string" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule": { -"description": "Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule", "properties": { "endDate": { "$ref": "GoogleTypeDate", -"description": "Optional. Deny period end date." +"description": "Optional. Disable validation warnings" }, "startDate": { "$ref": "GoogleTypeDate", -"description": "Optional. The start date of the deny maintenance period." +"description": "Optional. Disable validation warnings" }, "time": { "$ref": "GoogleTypeTimeOfDay", -"description": "Optional. Time in UTC when the deny period starts on start_date and ends on end_date." +"description": "Optional. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo": { -"description": "MaintenanceInfo to capture the maintenance details of database resource.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", "properties": { "currentVersionReleaseDate": { "$ref": "GoogleTypeDate", -"description": "Optional. The date when the current maintenance version was released." +"description": "Optional. Disable validation warnings" }, "denyMaintenanceSchedules": { -"description": "Optional. List of Deny maintenance period for the database resource.", +"description": "Optional. Disable validation warnings", "items": { "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule" }, "type": "array" }, "isInstanceStopped": { -"description": "Optional. Whether the instance is in stopped state. This information is temporarily being captured in maintenanceInfo, till STOPPED state is supported by DB Center.", +"description": "Optional. Disable validation warnings", "type": "boolean" }, "maintenanceSchedule": { "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", -"description": "Optional. Maintenance window for the database resource." +"description": "Optional. Disable validation warnings" }, "maintenanceState": { -"description": "Output only. Current state of maintenance on the database resource.", +"description": "Output only. Disable validation warnings", "enum": [ "MAINTENANCE_STATE_UNSPECIFIED", "CREATING", @@ -6930,23 +6999,23 @@ false "ERROR" ], "enumDescriptions": [ -"Unspecified state.", -"Database resource is being created.", -"Database resource has been created and is ready to use.", -"Database resource is being updated.", -"Database resource is unheathy and under repair.", -"Database resource is being deleted.", -"Database resource encountered an error and is in indeterministic state." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "readOnly": true, "type": "string" }, "maintenanceVersion": { -"description": "Optional. Current Maintenance version of the database resource. Example: \"MYSQL_8_0_41.R20250531.01_15\"", +"description": "Optional. Disable validation warnings", "type": "string" }, "nextAvailableMaintenanceVersions": { -"description": "Optional. List of next available maintenance versions.", +"description": "Optional. Disable validation warnings", "items": { "type": "string" }, @@ -6954,17 +7023,17 @@ false }, "upcomingMaintenance": { "$ref": "StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance", -"description": "Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window." +"description": "Optional. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule": { -"description": "Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. This is configured by the customer.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", "properties": { "day": { -"description": "Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", +"description": "Optional. Disable validation warnings", "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", @@ -6988,7 +7057,7 @@ false "type": "string" }, "phase": { -"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", +"description": "Optional. Disable validation warnings", "enum": [ "PHASE_UNSPECIFIED", "ANY", @@ -6997,37 +7066,38 @@ false "WEEK5" ], "enumDescriptions": [ -"Phase is unspecified.", -"Any phase.", -"Week 1.", -"Week 2.", -"Week 5." +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "time": { "$ref": "GoogleTypeTimeOfDay", -"description": "Optional. Preferred time to start the maintenance operation on the specified day." +"description": "Optional. Disable validation warnings" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainRetentionSettings": { +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", "properties": { "durationBasedRetention": { -"description": "Duration based retention period i.e. 172800 seconds (2 days)", +"description": "Disable validation warnings", "format": "google-duration", "type": "string" }, "quantityBasedRetention": { -"description": "Quantity based retention period i.e. 7 backups", +"description": "Disable validation warnings", "format": "int32", "type": "integer" }, "retentionUnit": { "deprecated": true, -"description": "The unit that 'retained_backups' represents.", +"description": "Disable validation warnings", "enum": [ "RETENTION_UNIT_UNSPECIFIED", "COUNT", @@ -7036,22 +7106,22 @@ false "RETENTION_UNIT_OTHER" ], "enumDescriptions": [ -"Backup retention unit is unspecified, will be treated as COUNT.", -"Retention will be by count, eg. \"retain the most recent 7 backups\".", -"Retention will be by Time, eg. \"retain backups till a specific time\" i.e. till 2024-05-01T00:00:00Z.", -"Retention will be by duration, eg. \"retain the backups for 172800 seconds (2 days)\".", -"For rest of the other category" +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings", +"Disable validation warnings" ], "type": "string" }, "timeBasedRetention": { "deprecated": true, -"description": "Duration based retention period i.e. 172800 seconds (2 days)", +"description": "Disable validation warnings", "format": "google-duration", "type": "string" }, "timestampBasedRetentionTime": { -"description": "Timestamp based retention period i.e. 2024-05-01T00:00:00Z", +"description": "Disable validation warnings", "format": "google-datetime", "type": "string" } @@ -7059,45 +7129,45 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainSignalMetadata": { -"description": "SignalMetadata contains one of the signal metadata proto messages associated with a SignalType. This proto will be mapped to SignalMetadata message in storage.proto. Next ID: 3", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainSignalMetadata", "properties": { "backupRun": { "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Signal data for backup runs." +"description": "Disable validation warnings" }, "signalBoolValue": { -"description": "Signal data for boolean signals.", +"description": "Disable validation warnings", "type": "boolean" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainTags": { -"description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainTags", "properties": { "tags": { "additionalProperties": { "type": "string" }, -"description": "The Tag key/value mappings.", +"description": "Disable validation warnings", "type": "object" } }, "type": "object" }, "StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance": { -"description": "Upcoming maintenance for the database resource. This is generated by SLM once the upcoming maintenance schedule is published.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance", "properties": { "endTime": { -"description": "Optional. The end time of the upcoming maintenance.", +"description": "Optional. Disable validation warnings", "format": "google-datetime", "type": "string" }, "startTime": { -"description": "Optional. The start time of the upcoming maintenance.", +"description": "Optional. Disable validation warnings", "format": "google-datetime", "type": "string" } @@ -7105,13 +7175,14 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainUserLabels": { -"description": "Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.", +"description": "Disable validation warnings", "id": "StorageDatabasecenterPartnerapiV1mainUserLabels", "properties": { "labels": { "additionalProperties": { "type": "string" }, +"description": "Disable validation warnings", "type": "object" } }, @@ -7292,6 +7363,11 @@ false "type": "string" }, "type": "array" +}, +"caseAgnostic": { +"description": "Output only. Whether the allowed values are case agnostic.", +"readOnly": true, +"type": "boolean" } }, "type": "object" From 713bceea6f2449cf7aca6df86aa90b6bcb8d33c2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:58 +0000 Subject: [PATCH 07/84] feat(analyticshub): update the api #### analyticshub:v1 The following keys were added: - endpoints (Total Keys: 1) - schemas.QueryTemplate.properties.proposer.deprecated (Total Keys: 1) #### analyticshub:v1beta1 The following keys were added: - endpoints (Total Keys: 1) --- ...s.locations.dataExchanges.queryTemplates.html | 16 ++++++++-------- .../documents/analyticshub.v1.json | 12 ++++++++++-- .../documents/analyticshub.v1beta1.json | 9 ++++++++- 3 files changed, 26 insertions(+), 11 deletions(-) diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.queryTemplates.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.queryTemplates.html index 3da77bc490..f145a71372 100644 --- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.queryTemplates.html +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.queryTemplates.html @@ -129,7 +129,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the QueryTemplate. "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. - "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. + "proposer": "A String", # Optional. Deprecated: Use `primary_contact` instead. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate. "definitionBody": "A String", # Optional. The definition body of the routine. "routineType": "A String", # Required. The type of routine. @@ -160,7 +160,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the QueryTemplate. "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. - "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. + "proposer": "A String", # Optional. Deprecated: Use `primary_contact` instead. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate. "definitionBody": "A String", # Optional. The definition body of the routine. "routineType": "A String", # Required. The type of routine. @@ -185,7 +185,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the QueryTemplate. "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. - "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. + "proposer": "A String", # Optional. Deprecated: Use `primary_contact` instead. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate. "definitionBody": "A String", # Optional. The definition body of the routine. "routineType": "A String", # Required. The type of routine. @@ -234,7 +234,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the QueryTemplate. "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. - "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. + "proposer": "A String", # Optional. Deprecated: Use `primary_contact` instead. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate. "definitionBody": "A String", # Optional. The definition body of the routine. "routineType": "A String", # Required. The type of routine. @@ -270,7 +270,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the QueryTemplate. "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. - "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. + "proposer": "A String", # Optional. Deprecated: Use `primary_contact` instead. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate. "definitionBody": "A String", # Optional. The definition body of the routine. "routineType": "A String", # Required. The type of routine. @@ -312,7 +312,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the QueryTemplate. "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. - "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. + "proposer": "A String", # Optional. Deprecated: Use `primary_contact` instead. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate. "definitionBody": "A String", # Optional. The definition body of the routine. "routineType": "A String", # Required. The type of routine. @@ -337,7 +337,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the QueryTemplate. "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. - "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. + "proposer": "A String", # Optional. Deprecated: Use `primary_contact` instead. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate. "definitionBody": "A String", # Optional. The definition body of the routine. "routineType": "A String", # Required. The type of routine. @@ -374,7 +374,7 @@

Method Details

"documentation": "A String", # Optional. Documentation describing the QueryTemplate. "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456` "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. - "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. + "proposer": "A String", # Optional. Deprecated: Use `primary_contact` instead. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes. "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate. "definitionBody": "A String", # Optional. The definition body of the routine. "routineType": "A String", # Required. The type of routine. diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json index 7df2aa746b..97472d56c8 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -18,6 +18,13 @@ "description": "Exchange data and analytics assets securely and efficiently.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/bigquery/docs/analytics-hub-introduction", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://analyticshub.us-east7.rep.googleapis.com/", +"location": "us-east7" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1247,7 +1254,7 @@ } } }, -"revision": "20260607", +"revision": "20260727", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AIInference": { @@ -2506,7 +2513,8 @@ "type": "string" }, "proposer": { -"description": "Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.", +"deprecated": true, +"description": "Optional. Deprecated: Use `primary_contact` instead. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.", "type": "string" }, "routine": { diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json index 2677d9ca62..4303be98e0 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json @@ -18,6 +18,13 @@ "description": "Exchange data and analytics assets securely and efficiently.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/bigquery/docs/analytics-hub-introduction", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://analyticshub.us-east7.rep.googleapis.com/", +"location": "us-east7" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -695,7 +702,7 @@ } } }, -"revision": "20250901", +"revision": "20260727", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { From 9734a98be2db6a6e0977a70b7af61bcb800fc0af Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:58 +0000 Subject: [PATCH 08/84] feat(androidenterprise): update the api #### androidenterprise:v1 The following keys were deleted: - schemas.GoogleAuthenticationSettings.properties.dedicatedDevicesAllowed.type (Total Keys: 1) --- docs/dyn/androidenterprise_v1.enterprises.html | 5 ----- .../documents/androidenterprise.v1.json | 16 +--------------- 2 files changed, 1 insertion(+), 20 deletions(-) diff --git a/docs/dyn/androidenterprise_v1.enterprises.html b/docs/dyn/androidenterprise_v1.enterprises.html index 5e1414ff30..1f62d2538b 100644 --- a/docs/dyn/androidenterprise_v1.enterprises.html +++ b/docs/dyn/androidenterprise_v1.enterprises.html @@ -164,7 +164,6 @@

Method Details

], "enterpriseType": "A String", # The type of the enterprise. "googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Output only. Settings for Google-provided user authentication. - "dedicatedDevicesAllowed": "A String", # Whether dedicated devices are allowed. "googleAuthenticationRequired": "A String", # Whether Google authentication is required. }, "id": "A String", # The unique ID for the enterprise. @@ -239,7 +238,6 @@

Method Details

], "enterpriseType": "A String", # The type of the enterprise. "googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Output only. Settings for Google-provided user authentication. - "dedicatedDevicesAllowed": "A String", # Whether dedicated devices are allowed. "googleAuthenticationRequired": "A String", # Whether Google authentication is required. }, "id": "A String", # The unique ID for the enterprise. @@ -264,7 +262,6 @@

Method Details

], "enterpriseType": "A String", # The type of the enterprise. "googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Output only. Settings for Google-provided user authentication. - "dedicatedDevicesAllowed": "A String", # Whether dedicated devices are allowed. "googleAuthenticationRequired": "A String", # Whether Google authentication is required. }, "id": "A String", # The unique ID for the enterprise. @@ -340,7 +337,6 @@

Method Details

], "enterpriseType": "A String", # The type of the enterprise. "googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Output only. Settings for Google-provided user authentication. - "dedicatedDevicesAllowed": "A String", # Whether dedicated devices are allowed. "googleAuthenticationRequired": "A String", # Whether Google authentication is required. }, "id": "A String", # The unique ID for the enterprise. @@ -423,7 +419,6 @@

Method Details

], "enterpriseType": "A String", # The type of the enterprise. "googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Output only. Settings for Google-provided user authentication. - "dedicatedDevicesAllowed": "A String", # Whether dedicated devices are allowed. "googleAuthenticationRequired": "A String", # Whether Google authentication is required. }, "id": "A String", # The unique ID for the enterprise. diff --git a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json index 4098d73c72..9b7f6fad95 100644 --- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json @@ -2691,7 +2691,7 @@ } } }, -"revision": "20260707", +"revision": "20260729", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { @@ -3558,20 +3558,6 @@ "description": "Contains settings for Google-provided user authentication.", "id": "GoogleAuthenticationSettings", "properties": { -"dedicatedDevicesAllowed": { -"description": "Whether dedicated devices are allowed.", -"enum": [ -"dedicatedDevicesAllowedUnspecified", -"disallowed", -"allowed" -], -"enumDescriptions": [ -"This value is unused.", -"Dedicated devices are not allowed.", -"Dedicated devices are allowed." -], -"type": "string" -}, "googleAuthenticationRequired": { "description": "Whether Google authentication is required.", "enum": [ From 013604f7c17b125b313b65f1ae53cb23d19e408f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:58 +0000 Subject: [PATCH 09/84] feat(androidmanagement): update the api #### androidmanagement:v1 The following keys were added: - schemas.CrossDevicePolicies (Total Keys: 4) - schemas.Policy.properties.crossDevicePolicies.$ref (Total Keys: 1) --- ...oidmanagement_v1.enterprises.policies.html | 38 ++++++++++++--- .../documents/androidmanagement.v1.json | 47 ++++++++++++++++++- 2 files changed, 76 insertions(+), 9 deletions(-) diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html index b8f37ed104..97f90d711b 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.policies.html +++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html @@ -202,7 +202,7 @@

Method Details

"configurationVariables": { # Optional, a map containing configuration variables defined for the configuration. "a_key": "A String", }, - "templateId": "A String", # The ID of the managed configurations template. + "templateId": "A String", # The ID of the managed configurations template. This value must be a numeric string containing exactly one or more digits (for example, "123456"). }, "minimumVersionCode": 42, # The minimum version of the app that runs on the device. If set, the device attempts to update the app to at least this version code. If the app is not up-to-date, the device will contain a NonComplianceDetail with non_compliance_reason set to APP_NOT_UPDATED. The app must already be published to Google Play with a version code greater than or equal to this value. At most 20 apps may specify a minimum version code per policy. "packageName": "A String", # The package name of the app. For example, com.google.android.youtube for the YouTube app. @@ -266,6 +266,10 @@

Method Details

"createWindowsDisabled": True or False, # Whether creating windows besides app windows is disabled. "credentialProviderPolicyDefault": "A String", # Optional. Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. "credentialsConfigDisabled": True or False, # Whether configuring user credentials is disabled. + "crossDevicePolicies": { # Policies controlling cross-device communication. # Optional. Policies controlling cross-device communication. + "nearbyAppStreaming": "A String", # Optional. Manages video streaming of apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + "nearbyNotificationStreaming": "A String", # Optional. Manages streaming of notifications from apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + }, "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. "crossProfileCopyPaste": "A String", # Whether text copied from one profile (personal or work) can be pasted in the other profile. @@ -730,7 +734,7 @@

Method Details

"configurationVariables": { # Optional, a map containing configuration variables defined for the configuration. "a_key": "A String", }, - "templateId": "A String", # The ID of the managed configurations template. + "templateId": "A String", # The ID of the managed configurations template. This value must be a numeric string containing exactly one or more digits (for example, "123456"). }, "minimumVersionCode": 42, # The minimum version of the app that runs on the device. If set, the device attempts to update the app to at least this version code. If the app is not up-to-date, the device will contain a NonComplianceDetail with non_compliance_reason set to APP_NOT_UPDATED. The app must already be published to Google Play with a version code greater than or equal to this value. At most 20 apps may specify a minimum version code per policy. "packageName": "A String", # The package name of the app. For example, com.google.android.youtube for the YouTube app. @@ -794,6 +798,10 @@

Method Details

"createWindowsDisabled": True or False, # Whether creating windows besides app windows is disabled. "credentialProviderPolicyDefault": "A String", # Optional. Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. "credentialsConfigDisabled": True or False, # Whether configuring user credentials is disabled. + "crossDevicePolicies": { # Policies controlling cross-device communication. # Optional. Policies controlling cross-device communication. + "nearbyAppStreaming": "A String", # Optional. Manages video streaming of apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + "nearbyNotificationStreaming": "A String", # Optional. Manages streaming of notifications from apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + }, "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. "crossProfileCopyPaste": "A String", # Whether text copied from one profile (personal or work) can be pasted in the other profile. @@ -1240,7 +1248,7 @@

Method Details

"configurationVariables": { # Optional, a map containing configuration variables defined for the configuration. "a_key": "A String", }, - "templateId": "A String", # The ID of the managed configurations template. + "templateId": "A String", # The ID of the managed configurations template. This value must be a numeric string containing exactly one or more digits (for example, "123456"). }, "minimumVersionCode": 42, # The minimum version of the app that runs on the device. If set, the device attempts to update the app to at least this version code. If the app is not up-to-date, the device will contain a NonComplianceDetail with non_compliance_reason set to APP_NOT_UPDATED. The app must already be published to Google Play with a version code greater than or equal to this value. At most 20 apps may specify a minimum version code per policy. "packageName": "A String", # The package name of the app. For example, com.google.android.youtube for the YouTube app. @@ -1344,7 +1352,7 @@

Method Details

"configurationVariables": { # Optional, a map containing configuration variables defined for the configuration. "a_key": "A String", }, - "templateId": "A String", # The ID of the managed configurations template. + "templateId": "A String", # The ID of the managed configurations template. This value must be a numeric string containing exactly one or more digits (for example, "123456"). }, "minimumVersionCode": 42, # The minimum version of the app that runs on the device. If set, the device attempts to update the app to at least this version code. If the app is not up-to-date, the device will contain a NonComplianceDetail with non_compliance_reason set to APP_NOT_UPDATED. The app must already be published to Google Play with a version code greater than or equal to this value. At most 20 apps may specify a minimum version code per policy. "packageName": "A String", # The package name of the app. For example, com.google.android.youtube for the YouTube app. @@ -1408,6 +1416,10 @@

Method Details

"createWindowsDisabled": True or False, # Whether creating windows besides app windows is disabled. "credentialProviderPolicyDefault": "A String", # Optional. Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. "credentialsConfigDisabled": True or False, # Whether configuring user credentials is disabled. + "crossDevicePolicies": { # Policies controlling cross-device communication. # Optional. Policies controlling cross-device communication. + "nearbyAppStreaming": "A String", # Optional. Manages video streaming of apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + "nearbyNotificationStreaming": "A String", # Optional. Manages streaming of notifications from apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + }, "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. "crossProfileCopyPaste": "A String", # Whether text copied from one profile (personal or work) can be pasted in the other profile. @@ -1863,7 +1875,7 @@

Method Details

"configurationVariables": { # Optional, a map containing configuration variables defined for the configuration. "a_key": "A String", }, - "templateId": "A String", # The ID of the managed configurations template. + "templateId": "A String", # The ID of the managed configurations template. This value must be a numeric string containing exactly one or more digits (for example, "123456"). }, "minimumVersionCode": 42, # The minimum version of the app that runs on the device. If set, the device attempts to update the app to at least this version code. If the app is not up-to-date, the device will contain a NonComplianceDetail with non_compliance_reason set to APP_NOT_UPDATED. The app must already be published to Google Play with a version code greater than or equal to this value. At most 20 apps may specify a minimum version code per policy. "packageName": "A String", # The package name of the app. For example, com.google.android.youtube for the YouTube app. @@ -1927,6 +1939,10 @@

Method Details

"createWindowsDisabled": True or False, # Whether creating windows besides app windows is disabled. "credentialProviderPolicyDefault": "A String", # Optional. Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. "credentialsConfigDisabled": True or False, # Whether configuring user credentials is disabled. + "crossDevicePolicies": { # Policies controlling cross-device communication. # Optional. Policies controlling cross-device communication. + "nearbyAppStreaming": "A String", # Optional. Manages video streaming of apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + "nearbyNotificationStreaming": "A String", # Optional. Manages streaming of notifications from apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + }, "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. "crossProfileCopyPaste": "A String", # Whether text copied from one profile (personal or work) can be pasted in the other profile. @@ -2380,7 +2396,7 @@

Method Details

"configurationVariables": { # Optional, a map containing configuration variables defined for the configuration. "a_key": "A String", }, - "templateId": "A String", # The ID of the managed configurations template. + "templateId": "A String", # The ID of the managed configurations template. This value must be a numeric string containing exactly one or more digits (for example, "123456"). }, "minimumVersionCode": 42, # The minimum version of the app that runs on the device. If set, the device attempts to update the app to at least this version code. If the app is not up-to-date, the device will contain a NonComplianceDetail with non_compliance_reason set to APP_NOT_UPDATED. The app must already be published to Google Play with a version code greater than or equal to this value. At most 20 apps may specify a minimum version code per policy. "packageName": "A String", # The package name of the app. For example, com.google.android.youtube for the YouTube app. @@ -2444,6 +2460,10 @@

Method Details

"createWindowsDisabled": True or False, # Whether creating windows besides app windows is disabled. "credentialProviderPolicyDefault": "A String", # Optional. Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. "credentialsConfigDisabled": True or False, # Whether configuring user credentials is disabled. + "crossDevicePolicies": { # Policies controlling cross-device communication. # Optional. Policies controlling cross-device communication. + "nearbyAppStreaming": "A String", # Optional. Manages video streaming of apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + "nearbyNotificationStreaming": "A String", # Optional. Manages streaming of notifications from apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + }, "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. "crossProfileCopyPaste": "A String", # Whether text copied from one profile (personal or work) can be pasted in the other profile. @@ -2913,7 +2933,7 @@

Method Details

"configurationVariables": { # Optional, a map containing configuration variables defined for the configuration. "a_key": "A String", }, - "templateId": "A String", # The ID of the managed configurations template. + "templateId": "A String", # The ID of the managed configurations template. This value must be a numeric string containing exactly one or more digits (for example, "123456"). }, "minimumVersionCode": 42, # The minimum version of the app that runs on the device. If set, the device attempts to update the app to at least this version code. If the app is not up-to-date, the device will contain a NonComplianceDetail with non_compliance_reason set to APP_NOT_UPDATED. The app must already be published to Google Play with a version code greater than or equal to this value. At most 20 apps may specify a minimum version code per policy. "packageName": "A String", # The package name of the app. For example, com.google.android.youtube for the YouTube app. @@ -2977,6 +2997,10 @@

Method Details

"createWindowsDisabled": True or False, # Whether creating windows besides app windows is disabled. "credentialProviderPolicyDefault": "A String", # Optional. Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this (https://developer.android.com/training/sign-in/passkeys) and this (https://developer.android.com/reference/androidx/credentials/CredentialManager) for details. See also credentialProviderPolicy. "credentialsConfigDisabled": True or False, # Whether configuring user credentials is disabled. + "crossDevicePolicies": { # Policies controlling cross-device communication. # Optional. Policies controlling cross-device communication. + "nearbyAppStreaming": "A String", # Optional. Manages video streaming of apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + "nearbyNotificationStreaming": "A String", # Optional. Manages streaming of notifications from apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + }, "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. "crossProfileCopyPaste": "A String", # Whether text copied from one profile (personal or work) can be pasted in the other profile. diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index d018719bbc..883f332205 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1265,7 +1265,7 @@ } } }, -"revision": "20260708", +"revision": "20260729", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -2925,6 +2925,45 @@ false }, "type": "object" }, +"CrossDevicePolicies": { +"description": "Policies controlling cross-device communication.", +"id": "CrossDevicePolicies", +"properties": { +"nearbyAppStreaming": { +"description": "Optional. Manages video streaming of apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above.", +"enum": [ +"NEARBY_APP_STREAMING_UNSPECIFIED", +"NEARBY_APP_STREAMING_USER_CHOICE", +"NEARBY_APP_STREAMING_DISABLED", +"NEARBY_APP_STREAMING_USER_CHOICE_SAME_MANAGED_ACCOUNT" +], +"enumDescriptions": [ +"Unspecified. Defaults to NEARBY_APP_STREAMING_USER_CHOICE_SAME_MANAGED_ACCOUNT.", +"The user is allowed to choose whether to stream apps to nearby devices.", +"Disables app streaming to nearby devices.", +"The user is allowed to choose whether to stream apps to other nearby devices which are signed in with the same authenticated managed account." +], +"type": "string" +}, +"nearbyNotificationStreaming": { +"description": "Optional. Manages streaming of notifications from apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above.", +"enum": [ +"NEARBY_NOTIFICATION_STREAMING_UNSPECIFIED", +"NEARBY_NOTIFICATION_STREAMING_USER_CHOICE", +"NEARBY_NOTIFICATION_STREAMING_DISABLED", +"NEARBY_NOTIFICATION_STREAMING_USER_CHOICE_SAME_MANAGED_ACCOUNT" +], +"enumDescriptions": [ +"Unspecified. Defaults to NEARBY_NOTIFICATION_STREAMING_USER_CHOICE_SAME_MANAGED_ACCOUNT.", +"The user is allowed to choose whether to stream notifications to nearby devices.", +"Disables notification streaming to nearby devices.", +"The user is allowed to choose whether to stream notifications to other nearby devices which are signed in with the same authenticated managed account." +], +"type": "string" +} +}, +"type": "object" +}, "CrossProfilePolicies": { "description": "Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile.", "id": "CrossProfilePolicies", @@ -5097,7 +5136,7 @@ false "type": "object" }, "templateId": { -"description": "The ID of the managed configurations template.", +"description": "The ID of the managed configurations template. This value must be a numeric string containing exactly one or more digits (for example, \"123456\").", "type": "string" } }, @@ -6247,6 +6286,10 @@ false "description": "Whether configuring user credentials is disabled.", "type": "boolean" }, +"crossDevicePolicies": { +"$ref": "CrossDevicePolicies", +"description": "Optional. Policies controlling cross-device communication." +}, "crossProfilePolicies": { "$ref": "CrossProfilePolicies", "description": "Cross-profile policies applied on the device." From fbed80da4429e881dbd0f8e09317fad9a5ad613f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:58 +0000 Subject: [PATCH 10/84] feat(androidpublisher): update the api #### androidpublisher:v3 The following keys were deleted: - resources.purchases.resources.subscriptions.methods.get (Total Keys: 17) - resources.purchases.resources.subscriptions.methods.refund (Total Keys: 16) - resources.purchases.resources.subscriptions.methods.revoke (Total Keys: 16) - schemas.IntroductoryPriceInfo (Total Keys: 8) - schemas.SubscriptionCancelSurveyResult (Total Keys: 5) - schemas.SubscriptionPriceChange (Total Keys: 5) - schemas.SubscriptionPurchase (Total Keys: 44) The following keys were added: - resources.appstoreappsreview.methods.createappstorehostedapp (Total Keys: 11) - resources.appstoreappsreview.methods.updateappstorehostedapp (Total Keys: 25) - resources.appstoreappsreview.methods.uploadapk (Total Keys: 21) - resources.appstoreappsreview.methods.uploadappstoreapppolicydeclarationfile (Total Keys: 21) - resources.appstoreappsreview.methods.uploadimage (Total Keys: 21) - resources.appstorecatalog.resources.recentappviews.methods.get (Total Keys: 13) - resources.appstorecatalog.resources.recentupdateevents.methods.list (Total Keys: 21) - schemas.AppContactInformation (Total Keys: 3) - schemas.AppStoreAppActiveApkSet (Total Keys: 5) - schemas.AppStoreAppActiveApks (Total Keys: 4) - schemas.AppStoreAppDetails (Total Keys: 5) - schemas.AppStoreAppPolicyDeclaration (Total Keys: 5) - schemas.AppStoreAppStoreListing (Total Keys: 8) - schemas.CatalogAppView (Total Keys: 30) - schemas.CatalogDeviceSelector (Total Keys: 6) - schemas.CatalogPermission (Total Keys: 5) - schemas.CatalogSdkVersion (Total Keys: 8) - schemas.CompatibleScreen (Total Keys: 4) - schemas.CreateAppStoreHostedAppRequest (Total Keys: 3) - schemas.CreateAppStoreHostedAppResponse (Total Keys: 2) - schemas.Date (Total Keys: 8) - schemas.DeveloperDetails (Total Keys: 6) - schemas.DeviceCompatibilityRequirements (Total Keys: 23) - schemas.DeviceIdentifier (Total Keys: 4) - schemas.Group (Total Keys: 4) - schemas.ImageAsset (Total Keys: 2) - schemas.KeyedGroup (Total Keys: 5) - schemas.ListRecentUpdateEventsResponse (Total Keys: 5) - schemas.LocalizedStoreListing (Total Keys: 15) - schemas.NestedPolicyResponse (Total Keys: 8) - schemas.PolicyBooleanResponse (Total Keys: 3) - schemas.PolicyDocumentResponse (Total Keys: 5) - schemas.PolicyGroupResponse (Total Keys: 4) - schemas.PolicyKeyedGroupResponse (Total Keys: 4) - schemas.PolicyMultipleChoiceResponse (Total Keys: 4) - schemas.PolicyResponse (Total Keys: 10) - schemas.PolicySingleChoiceResponse (Total Keys: 3) - schemas.PolicyStringResponse (Total Keys: 3) - schemas.RamSelector (Total Keys: 4) - schemas.RecentAppView (Total Keys: 3) - schemas.RecentUpdateEvent (Total Keys: 6) - schemas.ScreenshotSet (Total Keys: 4) - schemas.SocSelector (Total Keys: 4) - schemas.UpdateAppStoreHostedAppPublishStatusRequest (Total Keys: 3) - schemas.UpdateAppStoreHostedAppPublishStatusResponse (Total Keys: 2) - schemas.UpdateAppStoreHostedAppRequest (Total Keys: 9) - schemas.UpdateAppStoreHostedAppResponse (Total Keys: 2) - schemas.UploadApkRequest (Total Keys: 2) - schemas.UploadApkResponse (Total Keys: 3) - schemas.UploadAppStoreAppPolicyDeclarationFileRequest (Total Keys: 3) - schemas.UploadAppStoreAppPolicyDeclarationFileResponse (Total Keys: 3) - schemas.UploadImageRequest (Total Keys: 2) - schemas.UploadImageResponse (Total Keys: 3) - schemas.UsesConfiguration (Total Keys: 7) - schemas.VideoAsset (Total Keys: 2) --- ...ndroidpublisher_v3.appstoreappsreview.html | 395 ++++ .../androidpublisher_v3.appstorecatalog.html | 96 + ...her_v3.appstorecatalog.recentappviews.html | 266 +++ ...v3.appstorecatalog.recentupdateevents.html | 136 ++ docs/dyn/androidpublisher_v3.html | 10 + ...dpublisher_v3.purchases.subscriptions.html | 102 - ...ublisher_v3.purchases.subscriptionsv2.html | 1 - .../documents/androidpublisher.v3.json | 1934 +++++++++++++---- 8 files changed, 2458 insertions(+), 482 deletions(-) create mode 100644 docs/dyn/androidpublisher_v3.appstoreappsreview.html create mode 100644 docs/dyn/androidpublisher_v3.appstorecatalog.html create mode 100644 docs/dyn/androidpublisher_v3.appstorecatalog.recentappviews.html create mode 100644 docs/dyn/androidpublisher_v3.appstorecatalog.recentupdateevents.html diff --git a/docs/dyn/androidpublisher_v3.appstoreappsreview.html b/docs/dyn/androidpublisher_v3.appstoreappsreview.html new file mode 100644 index 0000000000..32cb8c3a43 --- /dev/null +++ b/docs/dyn/androidpublisher_v3.appstoreappsreview.html @@ -0,0 +1,395 @@ + + + +

Google Play Android Developer API . appstoreappsreview

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ createappstorehostedapp(appStorePackageName, body=None, x__xgafv=None)

+

Creates an app store hosted app. This must be called before any other RPCs for this hosted app.

+

+ updateappstorehostedapp(appStorePackageName, body=None, x__xgafv=None)

+

Updates details for an app hosted on an app store. Use this to provide details for a new app, or to update details for an existing app. The update will be sent for review immediately after creation.

+

+ updateappstorehostedapppublishstatus(appStorePackageName, packageName, body=None, x__xgafv=None)

+

Updates the publish status of an app store hosted app. The default state after calling UpdateAppStoreHostedApp is PUBLISHED. It is not necessary to call this RPC explicitly to set an app to PUBLISHED.

+

+ uploadapk(appStorePackageName, packageName, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

+

Upload an APK file for the hosted app. Returns an ID to track this APK.

+

+ uploadappstoreapppolicydeclarationfile(appStorePackageName, packageName, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

+

Upload a policy declaration file for the hosted app. Returns an ID to track the file.

+

+ uploadimage(appStorePackageName, packageName, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

+

Upload a screenshot or app icon for the hosted app. Returns an ID to track the image.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ createappstorehostedapp(appStorePackageName, body=None, x__xgafv=None) +
Creates an app store hosted app. This must be called before any other RPCs for this hosted app.
+
+Args:
+  appStorePackageName: string, Required. Package name of the third-party app store. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to create a new app record for an app store hosted app.
+  "packageName": "A String", # Required. Package name of the app.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for creating a new app record for an app store hosted app.
+}
+
+ +
+ updateappstorehostedapp(appStorePackageName, body=None, x__xgafv=None) +
Updates details for an app hosted on an app store. Use this to provide details for a new app, or to update details for an existing app. The update will be sent for review immediately after creation.
+
+Args:
+  appStorePackageName: string, Required. Package name of the third-party app store. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to update an app record for an app store hosted app.
+  "activeApks": { # Information about active APKs of an app store hosted app. # Required. Actively distributed APKs of the app.
+    "activeApkSets": [ # Required. List specifying which APK sets are distributed together. This list should contain all APKs that you're distributing for this app. Add an entry for each individual installable set of APKs.
+      { # An installable set of active APKs. A set of APKs might only contain 1 APK if the app in question publishes using APKs. If the app uses app bundles (or a similar technology), this set should contain all APKs (even optional ones) that might be installed for this app. A set of APKs should be installable together. If certain APKs are exclusive to one another and cannot be installed together, then a separate AppStoreAppActiveApkSet should be created.
+        "baseApkId": "A String", # Required. The ID for the main base application module. Example: base.apk or app.apk.
+        "splitApkId": [ # Optional. IDs for split modules that might be installed in combination with the base APK. Can be empty if app bundles (or a similar technology) are not used. Example: config.en.apk.
+          "A String",
+        ],
+      },
+    ],
+  },
+  "activeLocalizedStoreListings": [ # Required. Localized store listings details of the update.
+    { # A localized store listing. These are the details about the app as shown in your app store.
+      "appIconId": "A String", # Required. Image ID generated from UploadImage for the main app icon.
+      "appName": "A String", # Required. The title of the app.
+      "fullDescription": "A String", # Required. Comprehensive description text about the app.
+      "languageCode": "A String", # Required. Language code (e.g., "en-US") of the listing.
+      "screenshotId": [ # Required. Multiple image IDs for screenshot galleries.
+        "A String",
+      ],
+      "shortDescription": "A String", # Optional. Quick summary about the app.
+      "videoLink": "A String", # Optional. Link to a video about the app.
+    },
+  ],
+  "appDetails": { # Details about the app. # Required. General developer details for the app.
+    "contactEmail": "A String", # Required. The app developer's contact email address.
+    "developerName": "A String", # Required. The app developer's name.
+    "developerWebsite": "A String", # Optional. Website link for the developer or app.
+  },
+  "packageName": "A String", # Required. Package name of the app.
+  "policyDeclarations": [ # Required. Policy declarations provided for the app.
+    { # A policy declaration with its responses.
+      "declarationId": "A String", # Required. ID of the policy declaration.
+      "responses": [ # Required. Responses provided for this declaration.
+        { # An individual response to a policy question about an app.
+          "booleanResponse": { # Responses that will only ever be a boolean. # Optional. A boolean response.
+            "value": True or False, # Required. Provided boolean value.
+          },
+          "documentResponse": { # An uploaded document. Must be a single logical document (e.g. a financial license). # Optional. A document response.
+            "documentId": "A String", # Required. ID of the uploaded document.
+            "expiryDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. Expiry date for the document.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "nonExpiring": True or False, # Optional. True if confirmed that the document does not have an expiry date.
+          },
+          "groupResponse": { # A repeated group of responses. # Optional. A group response.
+            "groups": [ # Optional. Groups of responses to questions.
+              { # A group of responses.
+                "responses": [ # Required. Responses within a group.
+                  { # An individual nested response to a policy question about an app. Nested responses are like regular responses but without groups.
+                    "booleanResponse": { # Responses that will only ever be a boolean. # Optional. A boolean response.
+                      "value": True or False, # Required. Provided boolean value.
+                    },
+                    "documentResponse": { # An uploaded document. Must be a single logical document (e.g. a financial license). # Optional. A document response.
+                      "documentId": "A String", # Required. ID of the uploaded document.
+                      "expiryDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. Expiry date for the document.
+                        "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+                        "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+                        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+                      },
+                      "nonExpiring": True or False, # Optional. True if confirmed that the document does not have an expiry date.
+                    },
+                    "multipleChoiceResponse": { # Any response where multiple options can be chosen from several possibilities. # Optional. A multiple choice response.
+                      "values": [ # Optional. Provided values.
+                        "A String",
+                      ],
+                    },
+                    "questionId": "A String", # Required. ID of the question being answered.
+                    "singleChoiceResponse": { # Any response where a single option is chosen from several possibilities. # Optional. A single choice response.
+                      "value": "A String", # Required. Provided value.
+                    },
+                    "stringResponse": { # Any response best encoded as a string. Includes URLs and multiline text fields. # Optional. A string response.
+                      "value": "A String", # Required. Provided string value.
+                    },
+                  },
+                ],
+              },
+            ],
+          },
+          "keyedGroupResponse": { # A group of responses each identified by a distinct key within an allowed set. # Optional. A keyed group response.
+            "groups": [ # Optional. Groups of responses to questions. Each KeyedGroup.key must be unique within this list.
+              { # A group of responses, with a key.
+                "key": "A String", # Required. Key for this group.
+                "responses": [ # Required. Responses in this group.
+                  { # An individual nested response to a policy question about an app. Nested responses are like regular responses but without groups.
+                    "booleanResponse": { # Responses that will only ever be a boolean. # Optional. A boolean response.
+                      "value": True or False, # Required. Provided boolean value.
+                    },
+                    "documentResponse": { # An uploaded document. Must be a single logical document (e.g. a financial license). # Optional. A document response.
+                      "documentId": "A String", # Required. ID of the uploaded document.
+                      "expiryDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. Expiry date for the document.
+                        "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+                        "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+                        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+                      },
+                      "nonExpiring": True or False, # Optional. True if confirmed that the document does not have an expiry date.
+                    },
+                    "multipleChoiceResponse": { # Any response where multiple options can be chosen from several possibilities. # Optional. A multiple choice response.
+                      "values": [ # Optional. Provided values.
+                        "A String",
+                      ],
+                    },
+                    "questionId": "A String", # Required. ID of the question being answered.
+                    "singleChoiceResponse": { # Any response where a single option is chosen from several possibilities. # Optional. A single choice response.
+                      "value": "A String", # Required. Provided value.
+                    },
+                    "stringResponse": { # Any response best encoded as a string. Includes URLs and multiline text fields. # Optional. A string response.
+                      "value": "A String", # Required. Provided string value.
+                    },
+                  },
+                ],
+              },
+            ],
+          },
+          "multipleChoiceResponse": { # Any response where multiple options can be chosen from several possibilities. # Optional. A multiple choice response.
+            "values": [ # Optional. Provided values.
+              "A String",
+            ],
+          },
+          "questionId": "A String", # Required. ID of the question being answered.
+          "singleChoiceResponse": { # Any response where a single option is chosen from several possibilities. # Optional. A single choice response.
+            "value": "A String", # Required. Provided value.
+          },
+          "stringResponse": { # Any response best encoded as a string. Includes URLs and multiline text fields. # Optional. A string response.
+            "value": "A String", # Required. Provided string value.
+          },
+        },
+      ],
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for updating an app record for an app store hosted app.
+}
+
+ +
+ updateappstorehostedapppublishstatus(appStorePackageName, packageName, body=None, x__xgafv=None) +
Updates the publish status of an app store hosted app. The default state after calling UpdateAppStoreHostedApp is PUBLISHED. It is not necessary to call this RPC explicitly to set an app to PUBLISHED.
+
+Args:
+  appStorePackageName: string, Required. Package name of the third-party app store. (required)
+  packageName: string, Required. Package name of the app. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to update the publish status of an app store hosted app. The default state for any app with an update is PUBLISHED. It is not necessary to call this RPC explicitly to set an app to PUBLISHED.
+  "publishState": "A String", # Required. The new publish state for the hosted app.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for updating the publish status of an app store hosted app.
+}
+
+ +
+ uploadapk(appStorePackageName, packageName, body=None, media_body=None, media_mime_type=None, x__xgafv=None) +
Upload an APK file for the hosted app. Returns an ID to track this APK.
+
+Args:
+  appStorePackageName: string, Required. Package name of the third-party app store. (required)
+  packageName: string, Required. Package name of the app. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to upload an APK.
+}
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for uploading an APK.
+  "apkId": "A String", # The unique ID of the uploaded APK.
+}
+
+ +
+ uploadappstoreapppolicydeclarationfile(appStorePackageName, packageName, body=None, media_body=None, media_mime_type=None, x__xgafv=None) +
Upload a policy declaration file for the hosted app. Returns an ID to track the file.
+
+Args:
+  appStorePackageName: string, Required. Package name of the third-party app store. (required)
+  packageName: string, Required. Package name of the app. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to upload a policy declaration file.
+  "fileType": "A String", # Required. Type of the policy declaration file.
+}
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for uploading a policy declaration file.
+  "fileId": "A String", # The unique ID of the uploaded file.
+}
+
+ +
+ uploadimage(appStorePackageName, packageName, body=None, media_body=None, media_mime_type=None, x__xgafv=None) +
Upload a screenshot or app icon for the hosted app. Returns an ID to track the image.
+
+Args:
+  appStorePackageName: string, Required. Package name of the third-party app store. (required)
+  packageName: string, Required. Package name of the app. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to upload an image.
+}
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for uploading an image.
+  "imageId": "A String", # The unique ID of the uploaded image.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/androidpublisher_v3.appstorecatalog.html b/docs/dyn/androidpublisher_v3.appstorecatalog.html new file mode 100644 index 0000000000..e5367d6b56 --- /dev/null +++ b/docs/dyn/androidpublisher_v3.appstorecatalog.html @@ -0,0 +1,96 @@ + + + +

Google Play Android Developer API . appstorecatalog

+

Instance Methods

+

+ recentappviews() +

+

Returns the recentappviews Resource.

+ +

+ recentupdateevents() +

+

Returns the recentupdateevents Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/androidpublisher_v3.appstorecatalog.recentappviews.html b/docs/dyn/androidpublisher_v3.appstorecatalog.recentappviews.html new file mode 100644 index 0000000000..8af91eb174 --- /dev/null +++ b/docs/dyn/androidpublisher_v3.appstorecatalog.recentappviews.html @@ -0,0 +1,266 @@ + + + +

Google Play Android Developer API . appstorecatalog . recentappviews

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(appStorePackageName, playAppPackageName, x__xgafv=None)

+

Returns metadata about a recently updated app.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(appStorePackageName, playAppPackageName, x__xgafv=None) +
Returns metadata about a recently updated app.
+
+Args:
+  appStorePackageName: string, Required. The package name of the app store on behalf of which the request is made. (required)
+  playAppPackageName: string, Required. The package name of the requested Play app. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Metadata about a recently updated app.
+  "appView": { # LINT.IfChange A view of a Google Play app within the Catalog Export for app stores. # Recently updated app view.
+    "activeVersionNames": [ # Active versions of the app mapped from `android:versionName` manifest attributes.
+      "A String",
+    ],
+    "appCategory": "A String", # The category of the app.
+    "appContactInformation": { # Contact information for the app. # Developer-provided contact information for the app.
+      "contactEmail": "A String", # The contact email for this app. Always set.
+      "phoneNumber": "A String", # The contact phone for this app. Optionally provided by the developer.
+      "websiteUrl": "A String", # The contact website url for this app. Optionally provided by the developer.
+    },
+    "appSubcategory": "A String", # The subcategory of the app e.g. "GAME_ACTION".
+    "deliveryToken": "A String", # The token used for delivery of the app with the Google Play Inline Install API.
+    "developerDetails": { # The developer details of a Google Play app. # The developer details of the app.
+      "address": "A String", # The physical address of the developer.
+      "contactEmail": "A String", # The contact email of the developer.
+      "developerName": "A String", # The developer name of the app.
+      "phoneNumber": "A String", # The phone number of the developer.
+      "website": "A String", # The website of the developer.
+    },
+    "deviceCompatibilityRequirements": [ # The app may specify multiple sets of device compatibility requirements, and a device is considered compatible with the app if it satisfies at least one of `DeviceCompatibilityRequirements`.
+      { # Defines a set of device compatibility requirements for the app. A device must satisfy all of the requirements in a set to be considered compatible with the app.
+        "compatibleScreens": [ # Compatible screens as listed in the `compatible-screens` Manifest tag.
+          { # Compatible screens as listed in the `compatible-screens` Manifest tag.
+            "density": "A String", # Screen density.
+            "screenSize": "A String", # The screen size.
+          },
+        ],
+        "glEsVersion": 42, # Required version of OpenGL ES.
+        "isScreenRequired": True or False, # Specifies if the app requires a screen.
+        "nativePlatforms": [ # List of required ABIs (Application Binary Interface), e.g. `armeabi` or `x86`.
+          "A String",
+        ],
+        "requiredSoftwareLibraries": [ # List of required libraries as declared in the `uses-library` manifest tag.
+          "A String",
+        ],
+        "requiredSystemFeatures": [ # The system features that the app requires. A device must have all of the system features to be considered compatible with the app.
+          "A String",
+        ],
+        "requiresSmallestWidthDp": "A String", # Specifies the minimum smallest width required of the screen.
+        "sdkVersion": { # Defines a range of SDK versions. A device is considered compatible uf its\ SDK version falls within the min_sdk_version and max_sdk_version range. # Defines a range of SDK versions that the app is compatible with.
+          "maxSdkVersion": "A String", # The maximum SDK version required for the app (inclusive).
+          "minSdkVersion": "A String", # The minimum SDK version required for the app (inclusive).
+          "targetSdkVersion": "A String", # The target SDK version for the app.
+        },
+        "supportedGlTextures": [ # Supported gl textures as specified by the `supported-gl-texture` Manifest tag.
+          "A String",
+        ],
+        "supportedScreens": [ # Compatible screens as listed in the `supports-screens` Manifest tag.
+          "A String",
+        ],
+        "use32BitAbi": "A String", # Value of `android:use32BitAbi` flag retrieved from the Manifest.
+        "usesConfigurations": [ # Lists all configurations marked as required by use of the `uses-configuration` manifest tag. Each instance of this proto represents a single `uses-configuration` entry. See http://developer.android.com/guide/topics/manifest/uses-configuration-element.html
+          { # Represents all configurations marked as required by use of the uses-configuration manifest tag.
+            "requiredKeyboardType": "A String", # The type of keyboard required.
+            "requiredNavigationType": "A String", # The navigation device required.
+            "requiredTouchscreenType": "A String", # The type of touchscreen required.
+            "requiresFiveWayNavigation": True or False, # Whether or not the application requires a five-way navigation control.
+            "requiresHardwareKeyboard": True or False, # Whether or not the application requires a hardware keyboard.
+          },
+        ],
+      },
+    ],
+    "excludedDevicesByIdentifier": [ # List of devices excluded from the app's distribution even if they are otherwise compatible with the requirements from device_compatibility_requirements. These are OR-ed, i.e. a device is excluded if it matches any of the identifiers.
+      { # Defines a device identifier for a device.
+        "deviceBrand": "A String", # The brand of the device.
+        "deviceModel": "A String", # The model of the device.
+      },
+    ],
+    "excludedDevicesBySelector": [ # List of devices excluded from the app's distribution even if they are otherwise compatible with the requirements from device_compatibility_requirements. A device is excluded if it matches any of given the selectors.
+      { # Defines a device selector for a device. A device is considered matched if it matches any of given the selectors.
+        "deviceTypeSelector": "A String", # The device type selector.
+        "ramSelector": { # Defines a RAM selector for a device. # Defines a RAM selector for a device.
+          "ramMbLessThanOrEqual": "A String", # This will match any device that has less than or equal ram_mb_less_than_or_equal mb of RAM.
+        },
+        "socSelectors": [ # The SOC selectors. A device matches the device selector if it matches any of the SOC selectors.
+          { # Defines a SOC selector for a device. This will match any device whose SoC (System on Chip) matches all fields in the selector.
+            "socMake": "A String", # The manufacturer of the SoC.
+            "socModel": "A String", # The model of the SoC.
+          },
+        ],
+      },
+    ],
+    "firstReleaseDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date when the app was first released.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "hasInAppAds": True or False, # Whether the app has ads.
+    "hasInAppPurchases": True or False, # Whether the app has in-app purchases through Google Play.
+    "iarcCertificateId": "A String", # The IARC certificate ID for the app.
+    "isAdultOnlyAudience": True or False, # Whether the app is targeted to an adult-only (18+) audience.
+    "lastPublishTime": "A String", # The timestamp when the app was last published.
+    "localizedStoreListings": { # The localized store listings of an app. # The localized store listings of the app which are shown on Google Play.
+      "defaultLanguageCode": "A String", # The default language code of the app. If a localized store listing is not available for a given language, assets from the default language are used instead.
+      "localizedStoreListings": [
+        { # A localized store listings of the app.
+          "appName": "A String", # The name of the app in this localization.
+          "featureGraphic": { # An image asset. # The feature graphic of the app.
+            "imageUrl": "A String", # The URL of the image asset.
+          },
+          "fullDescription": "A String", # A longer description of the app in this localization.
+          "icon": { # An image asset. # The icon of the app.
+            "imageUrl": "A String", # The URL of the image asset.
+          },
+          "languageCode": "A String", # The BCP-47 language code for this localization.
+          "phoneScreenshots": { # A set of screenshots. # The phone screenshots of the app.
+            "screenshots": [ # The image assets of the screenshots.
+              { # An image asset.
+                "imageUrl": "A String", # The URL of the image asset.
+              },
+            ],
+          },
+          "shortDescription": "A String", # A short description of the app in this localization.
+          "tabletRegularScreenshots": { # A set of screenshots. # The regular tablet screenshots of the app.
+            "screenshots": [ # The image assets of the screenshots.
+              { # An image asset.
+                "imageUrl": "A String", # The URL of the image asset.
+              },
+            ],
+          },
+          "tabletSmallScreenshots": { # A set of screenshots. # The small tablet screenshots of the app.
+            "screenshots": [ # The image assets of the screenshots.
+              { # An image asset.
+                "imageUrl": "A String", # The URL of the image asset.
+              },
+            ],
+          },
+          "video": { # A video asset. # The video of the app.
+            "videoUrl": "A String", # The URL of the video asset.
+          },
+        },
+      ],
+    },
+    "packageName": "A String", # The package name of the app.
+    "permissions": [ # Required permissions declared by the app which apply for all Android SDK versions.
+      { # A permission declared by an app.
+        "maxSdkVersion": 42, # The `maxSdkVersion` attribute indicating up to which Android SDK version the permission is requested.
+        "name": "A String", # The `name` attribute indicating the permission name.
+      },
+    ],
+    "permissionsSdk23": [ # Required permissions declared by the app which apply for Android SDK versions SDK 23 and above.
+      { # A permission declared by an app.
+        "maxSdkVersion": 42, # The `maxSdkVersion` attribute indicating up to which Android SDK version the permission is requested.
+        "name": "A String", # The `name` attribute indicating the permission name.
+      },
+    ],
+    "priceInTheUnitedStates": { # Represents an amount of money with its currency type. # The price of the app in the United States. Empty if the app is free.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "privacyPolicyUrl": "A String", # The URL of the app's privacy policy.
+    "salePriceInTheUnitedStates": { # Represents an amount of money with its currency type. # The sale price of the app in the United States. Only populated for paid apps with an active US sale.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/androidpublisher_v3.appstorecatalog.recentupdateevents.html b/docs/dyn/androidpublisher_v3.appstorecatalog.recentupdateevents.html new file mode 100644 index 0000000000..838559b6b3 --- /dev/null +++ b/docs/dyn/androidpublisher_v3.appstorecatalog.recentupdateevents.html @@ -0,0 +1,136 @@ + + + +

Google Play Android Developer API . appstorecatalog . recentupdateevents

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(appStorePackageName, endTime=None, pageSize=None, pageToken=None, startTime=None, x__xgafv=None)

+

Lists update events for eligible apps in the given time range.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(appStorePackageName, endTime=None, pageSize=None, pageToken=None, startTime=None, x__xgafv=None) +
Lists update events for eligible apps in the given time range.
+
+Args:
+  appStorePackageName: string, Required. The package name of the app store on behalf of which the request is made. (required)
+  endTime: string, Required. The end time of the range (exclusive).
+  pageSize: integer, Optional. The maximum number of update events to return. The service may return fewer than this value. If unspecified, at most 100 update events will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. A page token, received from a previous `ListRecentUpdateEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRecentUpdateEvents` must match the call that provided the page token.
+  startTime: string, Required. The start time of the range (inclusive).
+  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 ListRecentUpdateEvents.
+  "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.
+  "recentUpdateEvents": [ # The list of recent update events.
+    { # A recent update event.
+      "eventTime": "A String", # The timestamp of the update.
+      "playAppPackageName": "A String", # The package name of the app.
+      "updateType": "A String", # The type of the update event.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/androidpublisher_v3.html b/docs/dyn/androidpublisher_v3.html index 04fb4b6e97..149e48d869 100644 --- a/docs/dyn/androidpublisher_v3.html +++ b/docs/dyn/androidpublisher_v3.html @@ -84,6 +84,16 @@

Instance Methods

Returns the apprecovery Resource.

+

+ appstoreappsreview() +

+

Returns the appstoreappsreview Resource.

+ +

+ appstorecatalog() +

+

Returns the appstorecatalog Resource.

+

edits()

diff --git a/docs/dyn/androidpublisher_v3.purchases.subscriptions.html b/docs/dyn/androidpublisher_v3.purchases.subscriptions.html index d55a5df645..c3d47ac488 100644 --- a/docs/dyn/androidpublisher_v3.purchases.subscriptions.html +++ b/docs/dyn/androidpublisher_v3.purchases.subscriptions.html @@ -86,15 +86,6 @@

Instance Methods

defer(packageName, subscriptionId, token, body=None, x__xgafv=None)

Deprecated: Use purchases.subscriptionsv2.defer instead. Defers a user's subscription purchase until a specified future expiration time.

-

- get(packageName, subscriptionId, token, x__xgafv=None)

-

Deprecated: Use purchases.subscriptionsv2.get instead. Checks whether a user's subscription purchase is valid and returns its expiry time.

-

- refund(packageName, subscriptionId, token, x__xgafv=None)

-

Deprecated: Use orders.refund instead. Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.

-

- revoke(packageName, subscriptionId, token, x__xgafv=None)

-

Deprecated: Use purchases.subscriptionsv2.revoke instead. Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.

Method Details

acknowledge(packageName, subscriptionId, token, body=None, x__xgafv=None) @@ -173,97 +164,4 @@

Method Details

}
-
- get(packageName, subscriptionId, token, x__xgafv=None) -
Deprecated: Use purchases.subscriptionsv2.get instead. Checks whether a user's subscription purchase is valid and returns its expiry time.
-
-Args:
-  packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
-  subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
-  token: string, The token provided to the user's device when the subscription was purchased. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Deprecated: Use SubscriptionPurchaseV2 instead. A SubscriptionPurchase resource indicates the status of a user's subscription purchase.
-  "acknowledgementState": 42, # The acknowledgement state of the subscription product. Possible values are: 0. Yet to be acknowledged 1. Acknowledged
-  "autoRenewing": True or False, # Whether the subscription will automatically be renewed when it reaches its current expiry time.
-  "autoResumeTimeMillis": "A String", # Time at which the subscription will be automatically resumed, in milliseconds since the Epoch. Only present if the user has requested to pause the subscription.
-  "cancelReason": 42, # The reason why a subscription was canceled or is not auto-renewing. Possible values are: 0. User canceled the subscription 1. Subscription was canceled by the system, for example because of a billing problem 2. Subscription was replaced with a new subscription 3. Subscription was canceled by the developer
-  "cancelSurveyResult": { # Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey). # Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).
-    "cancelSurveyReason": 42, # The cancellation reason the user chose in the survey. Possible values are: 0. Other 1. I don't use this service enough 2. Technical issues 3. Cost-related reasons 4. I found a better app
-    "userInputCancelReason": "A String", # The customized input cancel reason from the user. Only present when cancelReason is 0.
-  },
-  "countryCode": "A String", # ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.
-  "developerPayload": "A String", # A developer-specified string that contains supplemental information about an order.
-  "emailAddress": "A String", # The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
-  "expiryTimeMillis": "A String", # Time at which the subscription will expire, in milliseconds since the Epoch.
-  "externalAccountId": "A String", # User account identifier in the third-party service. Only present if account linking happened as part of the subscription purchase flow.
-  "familyName": "A String", # The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
-  "givenName": "A String", # The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
-  "introductoryPriceInfo": { # Contains the introductory price information for a subscription. # Introductory price information of the subscription. This is only present when the subscription was purchased with an introductory price. This field does not indicate the subscription is currently in introductory price period.
-    "introductoryPriceAmountMicros": "A String", # Introductory price of the subscription, not including tax. The currency is the same as price_currency_code. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000.
-    "introductoryPriceCurrencyCode": "A String", # ISO 4217 currency code for the introductory subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP".
-    "introductoryPriceCycles": 42, # The number of billing period to offer introductory pricing.
-    "introductoryPricePeriod": "A String", # Introductory price period, specified in ISO 8601 format. Common values are (but not limited to) "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
-  },
-  "kind": "A String", # This kind represents a subscriptionPurchase object in the androidpublisher service.
-  "linkedPurchaseToken": "A String", # The purchase token of the originating purchase if this subscription is one of the following: 0. Re-signup of a canceled but non-lapsed subscription 1. Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set.
-  "obfuscatedExternalAccountId": "A String", # An obfuscated version of the id that is uniquely associated with the user's account in your app. Present for the following purchases: * If account linking happened as part of the subscription purchase flow. * It was specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made.
-  "obfuscatedExternalProfileId": "A String", # An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made.
-  "orderId": "A String", # The order id of the latest recurring order associated with the purchase of the subscription. If the subscription was canceled because payment was declined, this will be the order id from the payment declined order.
-  "paymentState": 42, # The payment state of the subscription. Possible values are: 0. Payment pending 1. Payment received 2. Free trial 3. Pending deferred upgrade/downgrade Not present for canceled, expired subscriptions.
-  "priceAmountMicros": "A String", # Price of the subscription, For tax exclusive countries, the price doesn't include tax. For tax inclusive countries, the price includes tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000.
-  "priceChange": { # Contains the price change information for a subscription that can be used to control the user journey for the price change in the app. This can be in the form of seeking confirmation from the user or tailoring the experience for a successful conversion. # The latest price change information available. This is present only when there is an upcoming price change for the subscription yet to be applied. Once the subscription renews with the new price or the subscription is canceled, no price change information will be returned.
-    "newPrice": { # Definition of a price, i.e. currency and units. # The new price the subscription will renew with if the price change is accepted by the user.
-      "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.
-    },
-    "state": 42, # The current state of the price change. Possible values are: 0. Outstanding: State for a pending price change waiting for the user to agree. In this state, you can optionally seek confirmation from the user using the In-App API. 1. Accepted: State for an accepted price change that the subscription will renew with unless it's canceled. The price change takes effect on a future date when the subscription renews. Note that the change might not occur when the subscription is renewed next.
-  },
-  "priceCurrencyCode": "A String", # ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP".
-  "profileId": "A String", # The Google profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
-  "profileName": "A String", # The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.
-  "promotionCode": "A String", # The promotion code applied on this purchase. This field is only set if a vanity code promotion is applied when the subscription was purchased.
-  "promotionType": 42, # The type of promotion applied on this purchase. This field is only set if a promotion is applied when the subscription was purchased. Possible values are: 0. One time code 1. Vanity code
-  "purchaseType": 42, # The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e. purchased using a promo code)
-  "startTimeMillis": "A String", # Time at which the subscription was granted, in milliseconds since the Epoch.
-  "userCancellationTimeMillis": "A String", # The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0.
-}
-
- -
- refund(packageName, subscriptionId, token, x__xgafv=None) -
Deprecated: Use orders.refund instead. Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.
-
-Args:
-  packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
-  subscriptionId: string, "The purchased subscription ID (for example, 'monthly001'). (required)
-  token: string, The token provided to the user's device when the subscription was purchased. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-
- -
- revoke(packageName, subscriptionId, token, x__xgafv=None) -
Deprecated: Use purchases.subscriptionsv2.revoke instead. Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.
-
-Args:
-  packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
-  subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
-  token: string, The token provided to the user's device when the subscription was purchased. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-
- \ No newline at end of file diff --git a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html index 6f2274eb03..60f27d5bda 100644 --- a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html +++ b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html @@ -203,7 +203,6 @@

Method Details

}, }, "kind": "A String", # This kind represents a SubscriptionPurchaseV2 object in the androidpublisher service. - "latestOrderId": "A String", # Deprecated: Use line_items.latest_successful_order_id instead. The order id of the latest order associated with the purchase of the subscription. For autoRenewing subscription, this is the order id of signup order if it is not renewed yet, or the last recurring order id (success, pending, or declined order). For prepaid subscription, this is the order id associated with the queried purchase token. "lineItems": [ # Item-level info for a subscription purchase. The items in the same purchase should be either all with AutoRenewingPlan or all with PrepaidPlan. { # Item-level info for a subscription purchase. "autoRenewingPlan": { # Information related to an auto renewing plan. # The item is auto renewing. diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index fea0e53585..62ae67eed6 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -439,6 +439,344 @@ } } }, +"appstoreappsreview": { +"methods": { +"createappstorehostedapp": { +"description": "Creates an app store hosted app. This must be called before any other RPCs for this hosted app.", +"flatPath": "androidpublisher/v3/appstore/{appStorePackageName}/apps:create", +"httpMethod": "POST", +"id": "androidpublisher.appstoreappsreview.createappstorehostedapp", +"parameterOrder": [ +"appStorePackageName" +], +"parameters": { +"appStorePackageName": { +"description": "Required. Package name of the third-party app store.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "androidpublisher/v3/appstore/{appStorePackageName}/apps:create", +"request": { +"$ref": "CreateAppStoreHostedAppRequest" +}, +"response": { +"$ref": "CreateAppStoreHostedAppResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +] +}, +"updateappstorehostedapp": { +"description": "Updates details for an app hosted on an app store. Use this to provide details for a new app, or to update details for an existing app. The update will be sent for review immediately after creation.", +"flatPath": "androidpublisher/v3/appstore/{appStorePackageName}/apps:update", +"httpMethod": "POST", +"id": "androidpublisher.appstoreappsreview.updateappstorehostedapp", +"parameterOrder": [ +"appStorePackageName" +], +"parameters": { +"appStorePackageName": { +"description": "Required. Package name of the third-party app store.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "androidpublisher/v3/appstore/{appStorePackageName}/apps:update", +"request": { +"$ref": "UpdateAppStoreHostedAppRequest" +}, +"response": { +"$ref": "UpdateAppStoreHostedAppResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +] +}, +"updateappstorehostedapppublishstatus": { +"description": "Updates the publish status of an app store hosted app. The default state after calling UpdateAppStoreHostedApp is PUBLISHED. It is not necessary to call this RPC explicitly to set an app to PUBLISHED.", +"flatPath": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}:updateAppStoreHostedAppPublishStatus", +"httpMethod": "POST", +"id": "androidpublisher.appstoreappsreview.updateappstorehostedapppublishstatus", +"parameterOrder": [ +"appStorePackageName", +"packageName" +], +"parameters": { +"appStorePackageName": { +"description": "Required. Package name of the third-party app store.", +"location": "path", +"required": true, +"type": "string" +}, +"packageName": { +"description": "Required. Package name of the app.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}:updateAppStoreHostedAppPublishStatus", +"request": { +"$ref": "UpdateAppStoreHostedAppPublishStatusRequest" +}, +"response": { +"$ref": "UpdateAppStoreHostedAppPublishStatusResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +] +}, +"uploadapk": { +"description": "Upload an APK file for the hosted app. Returns an ID to track this APK.", +"flatPath": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/apks:upload", +"httpMethod": "POST", +"id": "androidpublisher.appstoreappsreview.uploadapk", +"mediaUpload": { +"accept": [ +"application/octet-stream", +"application/vnd.android.package-archive" +], +"maxSize": "10737418240", +"protocols": { +"resumable": { +"multipart": true, +"path": "/resumable/upload/androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/apks:upload" +}, +"simple": { +"multipart": true, +"path": "/upload/androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/apks:upload" +} +} +}, +"parameterOrder": [ +"appStorePackageName", +"packageName" +], +"parameters": { +"appStorePackageName": { +"description": "Required. Package name of the third-party app store.", +"location": "path", +"required": true, +"type": "string" +}, +"packageName": { +"description": "Required. Package name of the app.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/apks:upload", +"request": { +"$ref": "UploadApkRequest" +}, +"response": { +"$ref": "UploadApkResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +], +"supportsMediaUpload": true +}, +"uploadappstoreapppolicydeclarationfile": { +"description": "Upload a policy declaration file for the hosted app. Returns an ID to track the file.", +"flatPath": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/policyDeclarationFiles:upload", +"httpMethod": "POST", +"id": "androidpublisher.appstoreappsreview.uploadappstoreapppolicydeclarationfile", +"mediaUpload": { +"accept": [ +"application/pdf", +"image/jpeg", +"image/png" +], +"maxSize": "10485760", +"protocols": { +"resumable": { +"multipart": true, +"path": "/resumable/upload/androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/policyDeclarationFiles:upload" +}, +"simple": { +"multipart": true, +"path": "/upload/androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/policyDeclarationFiles:upload" +} +} +}, +"parameterOrder": [ +"appStorePackageName", +"packageName" +], +"parameters": { +"appStorePackageName": { +"description": "Required. Package name of the third-party app store.", +"location": "path", +"required": true, +"type": "string" +}, +"packageName": { +"description": "Required. Package name of the app.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/policyDeclarationFiles:upload", +"request": { +"$ref": "UploadAppStoreAppPolicyDeclarationFileRequest" +}, +"response": { +"$ref": "UploadAppStoreAppPolicyDeclarationFileResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +], +"supportsMediaUpload": true +}, +"uploadimage": { +"description": "Upload a screenshot or app icon for the hosted app. Returns an ID to track the image.", +"flatPath": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/images:upload", +"httpMethod": "POST", +"id": "androidpublisher.appstoreappsreview.uploadimage", +"mediaUpload": { +"accept": [ +"image/*" +], +"maxSize": "15728640", +"protocols": { +"resumable": { +"multipart": true, +"path": "/resumable/upload/androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/images:upload" +}, +"simple": { +"multipart": true, +"path": "/upload/androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/images:upload" +} +} +}, +"parameterOrder": [ +"appStorePackageName", +"packageName" +], +"parameters": { +"appStorePackageName": { +"description": "Required. Package name of the third-party app store.", +"location": "path", +"required": true, +"type": "string" +}, +"packageName": { +"description": "Required. Package name of the app.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/images:upload", +"request": { +"$ref": "UploadImageRequest" +}, +"response": { +"$ref": "UploadImageResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +], +"supportsMediaUpload": true +} +} +}, +"appstorecatalog": { +"resources": { +"recentappviews": { +"methods": { +"get": { +"description": "Returns metadata about a recently updated app.", +"flatPath": "androidpublisher/v3/appstorecatalog/{appStorePackageName}/recentAppViews/{playAppPackageName}", +"httpMethod": "GET", +"id": "androidpublisher.appstorecatalog.recentappviews.get", +"parameterOrder": [ +"appStorePackageName", +"playAppPackageName" +], +"parameters": { +"appStorePackageName": { +"description": "Required. The package name of the app store on behalf of which the request is made.", +"location": "path", +"required": true, +"type": "string" +}, +"playAppPackageName": { +"description": "Required. The package name of the requested Play app.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "androidpublisher/v3/appstorecatalog/{appStorePackageName}/recentAppViews/{playAppPackageName}", +"response": { +"$ref": "RecentAppView" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +] +} +} +}, +"recentupdateevents": { +"methods": { +"list": { +"description": "Lists update events for eligible apps in the given time range.", +"flatPath": "androidpublisher/v3/appstorecatalog/{appStorePackageName}/recentUpdateEvents", +"httpMethod": "GET", +"id": "androidpublisher.appstorecatalog.recentupdateevents.list", +"parameterOrder": [ +"appStorePackageName" +], +"parameters": { +"appStorePackageName": { +"description": "Required. The package name of the app store on behalf of which the request is made.", +"location": "path", +"required": true, +"type": "string" +}, +"endTime": { +"description": "Required. The end time of the range (exclusive).", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of update events to return. The service may return fewer than this value. If unspecified, at most 100 update events will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListRecentUpdateEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRecentUpdateEvents` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"startTime": { +"description": "Required. The start time of the range (inclusive).", +"format": "google-datetime", +"location": "query", +"type": "string" +} +}, +"path": "androidpublisher/v3/appstorecatalog/{appStorePackageName}/recentUpdateEvents", +"response": { +"$ref": "ListRecentUpdateEventsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +] +} +} +} +} +}, "edits": { "methods": { "commit": { @@ -4965,127 +5303,16 @@ "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] +} +} }, -"get": { -"deprecated": true, -"description": "Deprecated: Use purchases.subscriptionsv2.get instead. Checks whether a user's subscription purchase is valid and returns its expiry time.", -"flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}", -"httpMethod": "GET", -"id": "androidpublisher.purchases.subscriptions.get", -"parameterOrder": [ -"packageName", -"subscriptionId", -"token" -], -"parameters": { -"packageName": { -"description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').", -"location": "path", -"required": true, -"type": "string" -}, -"subscriptionId": { -"description": "The purchased subscription ID (for example, 'monthly001').", -"location": "path", -"required": true, -"type": "string" -}, -"token": { -"description": "The token provided to the user's device when the subscription was purchased.", -"location": "path", -"required": true, -"type": "string" -} -}, -"path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}", -"response": { -"$ref": "SubscriptionPurchase" -}, -"scopes": [ -"https://www.googleapis.com/auth/androidpublisher" -] -}, -"refund": { -"deprecated": true, -"description": "Deprecated: Use orders.refund instead. Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.", -"flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:refund", -"httpMethod": "POST", -"id": "androidpublisher.purchases.subscriptions.refund", -"parameterOrder": [ -"packageName", -"subscriptionId", -"token" -], -"parameters": { -"packageName": { -"description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').", -"location": "path", -"required": true, -"type": "string" -}, -"subscriptionId": { -"description": "\"The purchased subscription ID (for example, 'monthly001').", -"location": "path", -"required": true, -"type": "string" -}, -"token": { -"description": "The token provided to the user's device when the subscription was purchased.", -"location": "path", -"required": true, -"type": "string" -} -}, -"path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:refund", -"scopes": [ -"https://www.googleapis.com/auth/androidpublisher" -] -}, -"revoke": { -"deprecated": true, -"description": "Deprecated: Use purchases.subscriptionsv2.revoke instead. Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.", -"flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:revoke", -"httpMethod": "POST", -"id": "androidpublisher.purchases.subscriptions.revoke", -"parameterOrder": [ -"packageName", -"subscriptionId", -"token" -], -"parameters": { -"packageName": { -"description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').", -"location": "path", -"required": true, -"type": "string" -}, -"subscriptionId": { -"description": "The purchased subscription ID (for example, 'monthly001').", -"location": "path", -"required": true, -"type": "string" -}, -"token": { -"description": "The token provided to the user's device when the subscription was purchased.", -"location": "path", -"required": true, -"type": "string" -} -}, -"path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:revoke", -"scopes": [ -"https://www.googleapis.com/auth/androidpublisher" -] -} -} -}, -"subscriptionsv2": { -"methods": { -"cancel": { -"description": "Cancel a subscription purchase for the user.", -"flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:cancel", -"httpMethod": "POST", -"id": "androidpublisher.purchases.subscriptionsv2.cancel", +"subscriptionsv2": { +"methods": { +"cancel": { +"description": "Cancel a subscription purchase for the user.", +"flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:cancel", +"httpMethod": "POST", +"id": "androidpublisher.purchases.subscriptionsv2.cancel", "parameterOrder": [ "packageName", "token" @@ -5685,7 +5912,7 @@ } } }, -"revision": "20260706", +"revision": "20260723", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6083,6 +6310,25 @@ }, "type": "object" }, +"AppContactInformation": { +"description": "Contact information for the app.", +"id": "AppContactInformation", +"properties": { +"contactEmail": { +"description": "The contact email for this app. Always set.", +"type": "string" +}, +"phoneNumber": { +"description": "The contact phone for this app. Optionally provided by the developer.", +"type": "string" +}, +"websiteUrl": { +"description": "The contact website url for this app. Optionally provided by the developer.", +"type": "string" +} +}, +"type": "object" +}, "AppDetails": { "description": "The app details. The resource for DetailsService.", "id": "AppDetails", @@ -6183,6 +6429,113 @@ }, "type": "object" }, +"AppStoreAppActiveApkSet": { +"description": "An installable set of active APKs. A set of APKs might only contain 1 APK if the app in question publishes using APKs. If the app uses app bundles (or a similar technology), this set should contain all APKs (even optional ones) that might be installed for this app. A set of APKs should be installable together. If certain APKs are exclusive to one another and cannot be installed together, then a separate AppStoreAppActiveApkSet should be created.", +"id": "AppStoreAppActiveApkSet", +"properties": { +"baseApkId": { +"description": "Required. The ID for the main base application module. Example: base.apk or app.apk.", +"type": "string" +}, +"splitApkId": { +"description": "Optional. IDs for split modules that might be installed in combination with the base APK. Can be empty if app bundles (or a similar technology) are not used. Example: config.en.apk.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AppStoreAppActiveApks": { +"description": "Information about active APKs of an app store hosted app.", +"id": "AppStoreAppActiveApks", +"properties": { +"activeApkSets": { +"description": "Required. List specifying which APK sets are distributed together. This list should contain all APKs that you're distributing for this app. Add an entry for each individual installable set of APKs.", +"items": { +"$ref": "AppStoreAppActiveApkSet" +}, +"type": "array" +} +}, +"type": "object" +}, +"AppStoreAppDetails": { +"description": "Details about the app.", +"id": "AppStoreAppDetails", +"properties": { +"contactEmail": { +"description": "Required. The app developer's contact email address.", +"type": "string" +}, +"developerName": { +"description": "Required. The app developer's name.", +"type": "string" +}, +"developerWebsite": { +"description": "Optional. Website link for the developer or app.", +"type": "string" +} +}, +"type": "object" +}, +"AppStoreAppPolicyDeclaration": { +"description": "A policy declaration with its responses.", +"id": "AppStoreAppPolicyDeclaration", +"properties": { +"declarationId": { +"description": "Required. ID of the policy declaration.", +"type": "string" +}, +"responses": { +"description": "Required. Responses provided for this declaration.", +"items": { +"$ref": "PolicyResponse" +}, +"type": "array" +} +}, +"type": "object" +}, +"AppStoreAppStoreListing": { +"description": "A localized store listing. These are the details about the app as shown in your app store.", +"id": "AppStoreAppStoreListing", +"properties": { +"appIconId": { +"description": "Required. Image ID generated from UploadImage for the main app icon.", +"type": "string" +}, +"appName": { +"description": "Required. The title of the app.", +"type": "string" +}, +"fullDescription": { +"description": "Required. Comprehensive description text about the app.", +"type": "string" +}, +"languageCode": { +"description": "Required. Language code (e.g., \"en-US\") of the listing.", +"type": "string" +}, +"screenshotId": { +"description": "Required. Multiple image IDs for screenshot galleries.", +"items": { +"type": "string" +}, +"type": "array" +}, +"shortDescription": { +"description": "Optional. Quick summary about the app.", +"type": "string" +}, +"videoLink": { +"description": "Optional. Link to a video about the app.", +"type": "string" +} +}, +"type": "object" +}, "AppVersionList": { "description": "Data format for a list of app versions.", "id": "AppVersionList", @@ -7032,6 +7385,198 @@ }, "type": "object" }, +"CatalogAppView": { +"description": "LINT.IfChange A view of a Google Play app within the Catalog Export for app stores.", +"id": "CatalogAppView", +"properties": { +"activeVersionNames": { +"description": "Active versions of the app mapped from `android:versionName` manifest attributes.", +"items": { +"type": "string" +}, +"type": "array" +}, +"appCategory": { +"description": "The category of the app.", +"enum": [ +"APP_CATEGORY_UNSPECIFIED", +"GAME", +"APP" +], +"enumDescriptions": [ +"Unspecified category.", +"Game app.", +"General app." +], +"type": "string" +}, +"appContactInformation": { +"$ref": "AppContactInformation", +"description": "Developer-provided contact information for the app." +}, +"appSubcategory": { +"description": "The subcategory of the app e.g. \"GAME_ACTION\".", +"type": "string" +}, +"deliveryToken": { +"description": "The token used for delivery of the app with the Google Play Inline Install API.", +"type": "string" +}, +"developerDetails": { +"$ref": "DeveloperDetails", +"description": "The developer details of the app." +}, +"deviceCompatibilityRequirements": { +"description": "The app may specify multiple sets of device compatibility requirements, and a device is considered compatible with the app if it satisfies at least one of `DeviceCompatibilityRequirements`.", +"items": { +"$ref": "DeviceCompatibilityRequirements" +}, +"type": "array" +}, +"excludedDevicesByIdentifier": { +"description": "List of devices excluded from the app's distribution even if they are otherwise compatible with the requirements from device_compatibility_requirements. These are OR-ed, i.e. a device is excluded if it matches any of the identifiers.", +"items": { +"$ref": "DeviceIdentifier" +}, +"type": "array" +}, +"excludedDevicesBySelector": { +"description": "List of devices excluded from the app's distribution even if they are otherwise compatible with the requirements from device_compatibility_requirements. A device is excluded if it matches any of given the selectors.", +"items": { +"$ref": "CatalogDeviceSelector" +}, +"type": "array" +}, +"firstReleaseDate": { +"$ref": "Date", +"description": "The date when the app was first released." +}, +"hasInAppAds": { +"description": "Whether the app has ads.", +"type": "boolean" +}, +"hasInAppPurchases": { +"description": "Whether the app has in-app purchases through Google Play.", +"type": "boolean" +}, +"iarcCertificateId": { +"description": "The IARC certificate ID for the app.", +"type": "string" +}, +"isAdultOnlyAudience": { +"description": "Whether the app is targeted to an adult-only (18+) audience.", +"type": "boolean" +}, +"lastPublishTime": { +"description": "The timestamp when the app was last published.", +"format": "google-datetime", +"type": "string" +}, +"localizedStoreListings": { +"$ref": "LocalizedStoreListings", +"description": "The localized store listings of the app which are shown on Google Play." +}, +"packageName": { +"description": "The package name of the app.", +"type": "string" +}, +"permissions": { +"description": "Required permissions declared by the app which apply for all Android SDK versions.", +"items": { +"$ref": "CatalogPermission" +}, +"type": "array" +}, +"permissionsSdk23": { +"description": "Required permissions declared by the app which apply for Android SDK versions SDK 23 and above.", +"items": { +"$ref": "CatalogPermission" +}, +"type": "array" +}, +"priceInTheUnitedStates": { +"$ref": "Money", +"description": "The price of the app in the United States. Empty if the app is free." +}, +"privacyPolicyUrl": { +"description": "The URL of the app's privacy policy.", +"type": "string" +}, +"salePriceInTheUnitedStates": { +"$ref": "Money", +"description": "The sale price of the app in the United States. Only populated for paid apps with an active US sale." +} +}, +"type": "object" +}, +"CatalogDeviceSelector": { +"description": "Defines a device selector for a device. A device is considered matched if it matches any of given the selectors.", +"id": "CatalogDeviceSelector", +"properties": { +"deviceTypeSelector": { +"description": "The device type selector.", +"enum": [ +"DEVICE_TYPE_SELECTOR_UNSPECIFIED", +"ANDROID_GO" +], +"enumDescriptions": [ +"Unspecified device type selector.", +"Android Go device type." +], +"type": "string" +}, +"ramSelector": { +"$ref": "RamSelector", +"description": "Defines a RAM selector for a device." +}, +"socSelectors": { +"description": "The SOC selectors. A device matches the device selector if it matches any of the SOC selectors.", +"items": { +"$ref": "SocSelector" +}, +"type": "array" +} +}, +"type": "object" +}, +"CatalogPermission": { +"description": "A permission declared by an app.", +"id": "CatalogPermission", +"properties": { +"maxSdkVersion": { +"description": "The `maxSdkVersion` attribute indicating up to which Android SDK version the permission is requested.", +"format": "int32", +"type": "integer" +}, +"name": { +"description": "The `name` attribute indicating the permission name.", +"type": "string" +} +}, +"type": "object" +}, +"CatalogSdkVersion": { +"description": "Defines a range of SDK versions. A device is considered compatible uf its\\ SDK version falls within the min_sdk_version and max_sdk_version range.", +"id": "CatalogSdkVersion", +"properties": { +"maxSdkVersion": { +"description": "The maximum SDK version required for the app (inclusive).", +"format": "int64", +"type": "string" +}, +"minSdkVersion": { +"description": "The minimum SDK version required for the app (inclusive).", +"format": "int64", +"type": "string" +}, +"targetSdkVersion": { +"description": "The target SDK version for the app.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "CoarseLocation": { "description": "Coarse Geographic location details for where the consumption happened.", "id": "CoarseLocation", @@ -7070,6 +7615,67 @@ }, "type": "object" }, +"CompatibleScreen": { +"description": "Compatible screens as listed in the `compatible-screens` Manifest tag.", +"id": "CompatibleScreen", +"properties": { +"density": { +"description": "Screen density.", +"enum": [ +"DENSITY_UNSPECIFIED", +"DENSITY_NODPI", +"DENSITY_LDPI", +"DENSITY_MDPI", +"DENSITY_TVDPI", +"DENSITY_HDPI", +"DENSITY_280", +"DENSITY_XHDPI", +"DENSITY_360", +"DENSITY_400", +"DENSITY_420", +"DENSITY_XXHDPI", +"DENSITY_560", +"DENSITY_XXXHDPI" +], +"enumDescriptions": [ +"Unspecified density.", +"No density.", +"Low density.", +"Medium density.", +"TV density.", +"High density.", +"280 dpi.", +"Extra high density.", +"360 dpi.", +"400 dpi.", +"420 dpi.", +"Extra extra high density.", +"560 dpi.", +"Extra extra extra high density." +], +"type": "string" +}, +"screenSize": { +"description": "The screen size.", +"enum": [ +"SCREEN_SIZE_UNSPECIFIED", +"SCREEN_SIZE_SMALL", +"SCREEN_SIZE_NORMAL", +"SCREEN_SIZE_LARGE", +"SCREEN_SIZE_EXTRA_LARGE" +], +"enumDescriptions": [ +"Unspecified screen size.", +"Small screen size.", +"Normal screen size.", +"Large screen size.", +"Extra large screen size." +], +"type": "string" +} +}, +"type": "object" +}, "ConsumptionUsageEvent": { "description": "List of events, each representing an instance where the user consumed or used the purchased item or service.", "id": "ConsumptionUsageEvent", @@ -7191,6 +7797,23 @@ }, "type": "object" }, +"CreateAppStoreHostedAppRequest": { +"description": "Request to create a new app record for an app store hosted app.", +"id": "CreateAppStoreHostedAppRequest", +"properties": { +"packageName": { +"description": "Required. Package name of the app.", +"type": "string" +} +}, +"type": "object" +}, +"CreateAppStoreHostedAppResponse": { +"description": "Response for creating a new app record for an app store hosted app.", +"id": "CreateAppStoreHostedAppResponse", +"properties": {}, +"type": "object" +}, "CreateDraftAppRecoveryRequest": { "description": "Request message for CreateDraftAppRecovery.", "id": "CreateDraftAppRecoveryRequest", @@ -7206,6 +7829,28 @@ }, "type": "object" }, +"Date": { +"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", +"id": "Date", +"properties": { +"day": { +"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", +"format": "int32", +"type": "integer" +}, +"month": { +"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", +"format": "int32", +"type": "integer" +}, +"year": { +"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "DeactivateBasePlanRequest": { "description": "Request message for DeactivateBasePlan.", "id": "DeactivateBasePlanRequest", @@ -7518,64 +8163,193 @@ "symbolType": { "description": "The type of the deobfuscation file.", "enum": [ -"deobfuscationFileTypeUnspecified", -"proguard", -"nativeCode" +"deobfuscationFileTypeUnspecified", +"proguard", +"nativeCode" +], +"enumDescriptions": [ +"Unspecified deobfuscation file type.", +"Proguard deobfuscation file type.", +"Native debugging symbols file type." +], +"type": "string" +} +}, +"type": "object" +}, +"DeobfuscationFilesUploadResponse": { +"description": "Responses for the upload.", +"id": "DeobfuscationFilesUploadResponse", +"properties": { +"deobfuscationFile": { +"$ref": "DeobfuscationFile", +"description": "The uploaded Deobfuscation File configuration." +} +}, +"type": "object" +}, +"DeployAppRecoveryRequest": { +"description": "Request message for DeployAppRecovery.", +"id": "DeployAppRecoveryRequest", +"properties": {}, +"type": "object" +}, +"DeployAppRecoveryResponse": { +"description": "Response message for DeployAppRecovery.", +"id": "DeployAppRecoveryResponse", +"properties": {}, +"type": "object" +}, +"DeveloperComment": { +"description": "Developer entry from conversation between user and developer.", +"id": "DeveloperComment", +"properties": { +"lastModified": { +"$ref": "Timestamp", +"description": "The last time at which this comment was updated." +}, +"text": { +"description": "The content of the comment, i.e. reply body.", +"type": "string" +} +}, +"type": "object" +}, +"DeveloperDetails": { +"description": "The developer details of a Google Play app.", +"id": "DeveloperDetails", +"properties": { +"address": { +"description": "The physical address of the developer.", +"type": "string" +}, +"contactEmail": { +"description": "The contact email of the developer.", +"type": "string" +}, +"developerName": { +"description": "The developer name of the app.", +"type": "string" +}, +"phoneNumber": { +"description": "The phone number of the developer.", +"type": "string" +}, +"website": { +"description": "The website of the developer.", +"type": "string" +} +}, +"type": "object" +}, +"DeveloperInitiatedCancellation": { +"description": "Information specific to cancellations initiated by developers.", +"id": "DeveloperInitiatedCancellation", +"properties": {}, +"type": "object" +}, +"DeviceCompatibilityRequirements": { +"description": "Defines a set of device compatibility requirements for the app. A device must satisfy all of the requirements in a set to be considered compatible with the app.", +"id": "DeviceCompatibilityRequirements", +"properties": { +"compatibleScreens": { +"description": "Compatible screens as listed in the `compatible-screens` Manifest tag.", +"items": { +"$ref": "CompatibleScreen" +}, +"type": "array" +}, +"glEsVersion": { +"description": "Required version of OpenGL ES.", +"format": "int32", +"type": "integer" +}, +"isScreenRequired": { +"description": "Specifies if the app requires a screen.", +"type": "boolean" +}, +"nativePlatforms": { +"description": "List of required ABIs (Application Binary Interface), e.g. `armeabi` or `x86`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"requiredSoftwareLibraries": { +"description": "List of required libraries as declared in the `uses-library` manifest tag.", +"items": { +"type": "string" +}, +"type": "array" +}, +"requiredSystemFeatures": { +"description": "The system features that the app requires. A device must have all of the system features to be considered compatible with the app.", +"items": { +"type": "string" +}, +"type": "array" +}, +"requiresSmallestWidthDp": { +"description": "Specifies the minimum smallest width required of the screen.", +"format": "int64", +"type": "string" +}, +"sdkVersion": { +"$ref": "CatalogSdkVersion", +"description": "Defines a range of SDK versions that the app is compatible with." +}, +"supportedGlTextures": { +"description": "Supported gl textures as specified by the `supported-gl-texture` Manifest tag.", +"items": { +"type": "string" +}, +"type": "array" +}, +"supportedScreens": { +"description": "Compatible screens as listed in the `supports-screens` Manifest tag.", +"items": { +"enum": [ +"SCREEN_SIZE_UNSPECIFIED", +"SCREEN_SIZE_SMALL", +"SCREEN_SIZE_NORMAL", +"SCREEN_SIZE_LARGE", +"SCREEN_SIZE_EXTRA_LARGE" +], +"enumDescriptions": [ +"Unspecified screen size.", +"Small screen size.", +"Normal screen size.", +"Large screen size.", +"Extra large screen size." +], +"type": "string" +}, +"type": "array" +}, +"use32BitAbi": { +"description": "Value of `android:use32BitAbi` flag retrieved from the Manifest.", +"enum": [ +"USE_32_BIT_ABI_UNSPECIFIED", +"USE_32_BIT_ABI_TRUE", +"USE_32_BIT_ABI_OTHER" ], "enumDescriptions": [ -"Unspecified deobfuscation file type.", -"Proguard deobfuscation file type.", -"Native debugging symbols file type." +"Unspecified 32-bit ABI usage.", +"Value of use32BitAbi is set to \"true\".", +"Value of use32BitAbi is not set or set to something other than \"true\"." ], "type": "string" -} -}, -"type": "object" -}, -"DeobfuscationFilesUploadResponse": { -"description": "Responses for the upload.", -"id": "DeobfuscationFilesUploadResponse", -"properties": { -"deobfuscationFile": { -"$ref": "DeobfuscationFile", -"description": "The uploaded Deobfuscation File configuration." -} -}, -"type": "object" -}, -"DeployAppRecoveryRequest": { -"description": "Request message for DeployAppRecovery.", -"id": "DeployAppRecoveryRequest", -"properties": {}, -"type": "object" -}, -"DeployAppRecoveryResponse": { -"description": "Response message for DeployAppRecovery.", -"id": "DeployAppRecoveryResponse", -"properties": {}, -"type": "object" }, -"DeveloperComment": { -"description": "Developer entry from conversation between user and developer.", -"id": "DeveloperComment", -"properties": { -"lastModified": { -"$ref": "Timestamp", -"description": "The last time at which this comment was updated." +"usesConfigurations": { +"description": "Lists all configurations marked as required by use of the `uses-configuration` manifest tag. Each instance of this proto represents a single `uses-configuration` entry. See http://developer.android.com/guide/topics/manifest/uses-configuration-element.html", +"items": { +"$ref": "UsesConfiguration" }, -"text": { -"description": "The content of the comment, i.e. reply body.", -"type": "string" +"type": "array" } }, "type": "object" }, -"DeveloperInitiatedCancellation": { -"description": "Information specific to cancellations initiated by developers.", -"id": "DeveloperInitiatedCancellation", -"properties": {}, -"type": "object" -}, "DeviceFeature": { "description": "Represents a device feature.", "id": "DeviceFeature", @@ -7636,6 +8410,21 @@ }, "type": "object" }, +"DeviceIdentifier": { +"description": "Defines a device identifier for a device.", +"id": "DeviceIdentifier", +"properties": { +"deviceBrand": { +"description": "The brand of the device.", +"type": "string" +}, +"deviceModel": { +"description": "The model of the device.", +"type": "string" +} +}, +"type": "object" +}, "DeviceMetadata": { "description": "Characteristics of the user's device.", "id": "DeviceMetadata", @@ -8489,6 +9278,20 @@ false }, "type": "object" }, +"Group": { +"description": "A group of responses.", +"id": "Group", +"properties": { +"responses": { +"description": "Required. Responses within a group.", +"items": { +"$ref": "NestedPolicyResponse" +}, +"type": "array" +} +}, +"type": "object" +}, "Image": { "description": "An uploaded image. The resource for ImagesService.", "id": "Image", @@ -8526,6 +9329,17 @@ false }, "type": "object" }, +"ImageAsset": { +"description": "An image asset.", +"id": "ImageAsset", +"properties": { +"imageUrl": { +"description": "The URL of the image asset.", +"type": "string" +} +}, +"type": "object" +}, "ImagesDeleteAllResponse": { "description": "Response for deleting all images.", "id": "ImagesDeleteAllResponse", @@ -8953,31 +9767,6 @@ false "properties": {}, "type": "object" }, -"IntroductoryPriceInfo": { -"description": "Contains the introductory price information for a subscription.", -"id": "IntroductoryPriceInfo", -"properties": { -"introductoryPriceAmountMicros": { -"description": "Introductory price of the subscription, not including tax. The currency is the same as price_currency_code. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is \u20ac1.99, price_amount_micros is 1990000.", -"format": "int64", -"type": "string" -}, -"introductoryPriceCurrencyCode": { -"description": "ISO 4217 currency code for the introductory subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is \"GBP\".", -"type": "string" -}, -"introductoryPriceCycles": { -"description": "The number of billing period to offer introductory pricing.", -"format": "int32", -"type": "integer" -}, -"introductoryPricePeriod": { -"description": "Introductory price period, specified in ISO 8601 format. Common values are (but not limited to) \"P1W\" (one week), \"P1M\" (one month), \"P3M\" (three months), \"P6M\" (six months), and \"P1Y\" (one year).", -"type": "string" -} -}, -"type": "object" -}, "IntroductoryPriceOfferPhase": { "description": "Details about introductory price offer phase.", "id": "IntroductoryPriceOfferPhase", @@ -9041,6 +9830,24 @@ false }, "type": "object" }, +"KeyedGroup": { +"description": "A group of responses, with a key.", +"id": "KeyedGroup", +"properties": { +"key": { +"description": "Required. Key for this group.", +"type": "string" +}, +"responses": { +"description": "Required. Responses in this group.", +"items": { +"$ref": "NestedPolicyResponse" +}, +"type": "array" +} +}, +"type": "object" +}, "LanguageTargeting": { "description": "Targeting based on language.", "id": "LanguageTargeting", @@ -9169,6 +9976,24 @@ false }, "type": "object" }, +"ListRecentUpdateEventsResponse": { +"description": "Response message for ListRecentUpdateEvents.", +"id": "ListRecentUpdateEventsResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"recentUpdateEvents": { +"description": "The list of recent update events.", +"items": { +"$ref": "RecentUpdateEvent" +}, +"type": "array" +} +}, +"type": "object" +}, "ListReleaseSummariesResponse": { "description": "Response listing all releases for a given track that are either ready to be sent for review, in review, approved, not approved or available.", "id": "ListReleaseSummariesResponse", @@ -9282,6 +10107,70 @@ false }, "type": "object" }, +"LocalizedStoreListing": { +"description": "A localized store listings of the app.", +"id": "LocalizedStoreListing", +"properties": { +"appName": { +"description": "The name of the app in this localization.", +"type": "string" +}, +"featureGraphic": { +"$ref": "ImageAsset", +"description": "The feature graphic of the app." +}, +"fullDescription": { +"description": "A longer description of the app in this localization.", +"type": "string" +}, +"icon": { +"$ref": "ImageAsset", +"description": "The icon of the app." +}, +"languageCode": { +"description": "The BCP-47 language code for this localization.", +"type": "string" +}, +"phoneScreenshots": { +"$ref": "ScreenshotSet", +"description": "The phone screenshots of the app." +}, +"shortDescription": { +"description": "A short description of the app in this localization.", +"type": "string" +}, +"tabletRegularScreenshots": { +"$ref": "ScreenshotSet", +"description": "The regular tablet screenshots of the app." +}, +"tabletSmallScreenshots": { +"$ref": "ScreenshotSet", +"description": "The small tablet screenshots of the app." +}, +"video": { +"$ref": "VideoAsset", +"description": "The video of the app." +} +}, +"type": "object" +}, +"LocalizedStoreListings": { +"description": "The localized store listings of an app.", +"id": "LocalizedStoreListings", +"properties": { +"defaultLanguageCode": { +"description": "The default language code of the app. If a localized store listing is not available for a given language, assets from the default language are used instead.", +"type": "string" +}, +"localizedStoreListings": { +"items": { +"$ref": "LocalizedStoreListing" +}, +"type": "array" +} +}, +"type": "object" +}, "LocalizedText": { "description": "Localized text in given language.", "id": "LocalizedText", @@ -9518,6 +10407,37 @@ false }, "type": "object" }, +"NestedPolicyResponse": { +"description": "An individual nested response to a policy question about an app. Nested responses are like regular responses but without groups.", +"id": "NestedPolicyResponse", +"properties": { +"booleanResponse": { +"$ref": "PolicyBooleanResponse", +"description": "Optional. A boolean response." +}, +"documentResponse": { +"$ref": "PolicyDocumentResponse", +"description": "Optional. A document response." +}, +"multipleChoiceResponse": { +"$ref": "PolicyMultipleChoiceResponse", +"description": "Optional. A multiple choice response." +}, +"questionId": { +"description": "Required. ID of the question being answered.", +"type": "string" +}, +"singleChoiceResponse": { +"$ref": "PolicySingleChoiceResponse", +"description": "Optional. A single choice response." +}, +"stringResponse": { +"$ref": "PolicyStringResponse", +"description": "Optional. A string response." +} +}, +"type": "object" +}, "OfferDetails": { "description": "Offer details information related to a purchase line item.", "id": "OfferDetails", @@ -10472,6 +11392,139 @@ false }, "type": "object" }, +"PolicyBooleanResponse": { +"description": "Responses that will only ever be a boolean.", +"id": "PolicyBooleanResponse", +"properties": { +"value": { +"description": "Required. Provided boolean value.", +"type": "boolean" +} +}, +"type": "object" +}, +"PolicyDocumentResponse": { +"description": "An uploaded document. Must be a single logical document (e.g. a financial license).", +"id": "PolicyDocumentResponse", +"properties": { +"documentId": { +"description": "Required. ID of the uploaded document.", +"type": "string" +}, +"expiryDate": { +"$ref": "Date", +"description": "Optional. Expiry date for the document." +}, +"nonExpiring": { +"description": "Optional. True if confirmed that the document does not have an expiry date.", +"type": "boolean" +} +}, +"type": "object" +}, +"PolicyGroupResponse": { +"description": "A repeated group of responses.", +"id": "PolicyGroupResponse", +"properties": { +"groups": { +"description": "Optional. Groups of responses to questions.", +"items": { +"$ref": "Group" +}, +"type": "array" +} +}, +"type": "object" +}, +"PolicyKeyedGroupResponse": { +"description": "A group of responses each identified by a distinct key within an allowed set.", +"id": "PolicyKeyedGroupResponse", +"properties": { +"groups": { +"description": "Optional. Groups of responses to questions. Each KeyedGroup.key must be unique within this list.", +"items": { +"$ref": "KeyedGroup" +}, +"type": "array" +} +}, +"type": "object" +}, +"PolicyMultipleChoiceResponse": { +"description": "Any response where multiple options can be chosen from several possibilities.", +"id": "PolicyMultipleChoiceResponse", +"properties": { +"values": { +"description": "Optional. Provided values.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"PolicyResponse": { +"description": "An individual response to a policy question about an app.", +"id": "PolicyResponse", +"properties": { +"booleanResponse": { +"$ref": "PolicyBooleanResponse", +"description": "Optional. A boolean response." +}, +"documentResponse": { +"$ref": "PolicyDocumentResponse", +"description": "Optional. A document response." +}, +"groupResponse": { +"$ref": "PolicyGroupResponse", +"description": "Optional. A group response." +}, +"keyedGroupResponse": { +"$ref": "PolicyKeyedGroupResponse", +"description": "Optional. A keyed group response." +}, +"multipleChoiceResponse": { +"$ref": "PolicyMultipleChoiceResponse", +"description": "Optional. A multiple choice response." +}, +"questionId": { +"description": "Required. ID of the question being answered.", +"type": "string" +}, +"singleChoiceResponse": { +"$ref": "PolicySingleChoiceResponse", +"description": "Optional. A single choice response." +}, +"stringResponse": { +"$ref": "PolicyStringResponse", +"description": "Optional. A string response." +} +}, +"type": "object" +}, +"PolicySingleChoiceResponse": { +"description": "Any response where a single option is chosen from several possibilities.", +"id": "PolicySingleChoiceResponse", +"properties": { +"value": { +"description": "Required. Provided value.", +"type": "string" +} +}, +"type": "object" +}, +"PolicyStringResponse": { +"description": "Any response best encoded as a string. Includes URLs and multiline text fields.", +"id": "PolicyStringResponse", +"properties": { +"value": { +"description": "Required. Provided string value.", +"type": "string" +} +}, +"type": "object" +}, "PreorderDetails": { "description": "Details of a pre-order purchase.", "id": "PreorderDetails", @@ -10875,25 +11928,78 @@ false }, "type": "object" }, -"PurchaseStateContext": { -"description": "Context about the purchase state.", -"id": "PurchaseStateContext", +"PurchaseStateContext": { +"description": "Context about the purchase state.", +"id": "PurchaseStateContext", +"properties": { +"purchaseState": { +"description": "Output only. The purchase state of the purchase.", +"enum": [ +"PURCHASE_STATE_UNSPECIFIED", +"PURCHASED", +"CANCELLED", +"PENDING" +], +"enumDescriptions": [ +"Purchase state unspecified. This value should never be set.", +"Purchased successfully.", +"Purchase canceled.", +"The purchase is in a pending state and has not yet been completed. For more information on handling pending purchases, see https://developer.android.com/google/play/billing/integrate#pending." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"RamSelector": { +"description": "Defines a RAM selector for a device.", +"id": "RamSelector", +"properties": { +"ramMbLessThanOrEqual": { +"description": "This will match any device that has less than or equal ram_mb_less_than_or_equal mb of RAM.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"RecentAppView": { +"description": "Metadata about a recently updated app.", +"id": "RecentAppView", +"properties": { +"appView": { +"$ref": "CatalogAppView", +"description": "Recently updated app view." +} +}, +"type": "object" +}, +"RecentUpdateEvent": { +"description": "A recent update event.", +"id": "RecentUpdateEvent", "properties": { -"purchaseState": { -"description": "Output only. The purchase state of the purchase.", +"eventTime": { +"description": "The timestamp of the update.", +"format": "google-datetime", +"type": "string" +}, +"playAppPackageName": { +"description": "The package name of the app.", +"type": "string" +}, +"updateType": { +"description": "The type of the update event.", "enum": [ -"PURCHASE_STATE_UNSPECIFIED", -"PURCHASED", -"CANCELLED", -"PENDING" +"UPDATE_TYPE_UNSPECIFIED", +"MODIFICATION", +"DELETION" ], "enumDescriptions": [ -"Purchase state unspecified. This value should never be set.", -"Purchased successfully.", -"Purchase canceled.", -"The purchase is in a pending state and has not yet been completed. For more information on handling pending purchases, see https://developer.android.com/google/play/billing/integrate#pending." +"Default value. This value is not used.", +"The app was modified.", +"The app stopped being eligible for catalog inclusion or was removed from the Play Store." ], -"readOnly": true, "type": "string" } }, @@ -11613,6 +12719,20 @@ false }, "type": "object" }, +"ScreenshotSet": { +"description": "A set of screenshots.", +"id": "ScreenshotSet", +"properties": { +"screenshots": { +"description": "The image assets of the screenshots.", +"items": { +"$ref": "ImageAsset" +}, +"type": "array" +} +}, +"type": "object" +}, "SdkVersion": { "description": "Represents an sdk version.", "id": "SdkVersion", @@ -11661,6 +12781,21 @@ false }, "type": "object" }, +"SocSelector": { +"description": "Defines a SOC selector for a device. This will match any device whose SoC (System on Chip) matches all fields in the selector.", +"id": "SocSelector", +"properties": { +"socMake": { +"description": "The manufacturer of the SoC.", +"type": "string" +}, +"socModel": { +"description": "The model of the SoC.", +"type": "string" +} +}, +"type": "object" +}, "SplitApkMetadata": { "description": "Holds data specific to Split APKs.", "id": "SplitApkMetadata", @@ -11783,22 +12918,6 @@ false }, "type": "object" }, -"SubscriptionCancelSurveyResult": { -"description": "Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).", -"id": "SubscriptionCancelSurveyResult", -"properties": { -"cancelSurveyReason": { -"description": "The cancellation reason the user chose in the survey. Possible values are: 0. Other 1. I don't use this service enough 2. Technical issues 3. Cost-related reasons 4. I found a better app", -"format": "int32", -"type": "integer" -}, -"userInputCancelReason": { -"description": "The customized input cancel reason from the user. Only present when cancelReason is 0.", -"type": "string" -} -}, -"type": "object" -}, "SubscriptionDeferralInfo": { "description": "A SubscriptionDeferralInfo contains the data needed to defer a subscription purchase to a future expiry time.", "id": "SubscriptionDeferralInfo", @@ -12049,156 +13168,6 @@ false }, "type": "object" }, -"SubscriptionPriceChange": { -"description": "Contains the price change information for a subscription that can be used to control the user journey for the price change in the app. This can be in the form of seeking confirmation from the user or tailoring the experience for a successful conversion.", -"id": "SubscriptionPriceChange", -"properties": { -"newPrice": { -"$ref": "Price", -"description": "The new price the subscription will renew with if the price change is accepted by the user." -}, -"state": { -"description": "The current state of the price change. Possible values are: 0. Outstanding: State for a pending price change waiting for the user to agree. In this state, you can optionally seek confirmation from the user using the In-App API. 1. Accepted: State for an accepted price change that the subscription will renew with unless it's canceled. The price change takes effect on a future date when the subscription renews. Note that the change might not occur when the subscription is renewed next.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"SubscriptionPurchase": { -"deprecated": true, -"description": "Deprecated: Use SubscriptionPurchaseV2 instead. A SubscriptionPurchase resource indicates the status of a user's subscription purchase.", -"id": "SubscriptionPurchase", -"properties": { -"acknowledgementState": { -"description": "The acknowledgement state of the subscription product. Possible values are: 0. Yet to be acknowledged 1. Acknowledged", -"format": "int32", -"type": "integer" -}, -"autoRenewing": { -"description": "Whether the subscription will automatically be renewed when it reaches its current expiry time.", -"type": "boolean" -}, -"autoResumeTimeMillis": { -"description": "Time at which the subscription will be automatically resumed, in milliseconds since the Epoch. Only present if the user has requested to pause the subscription.", -"format": "int64", -"type": "string" -}, -"cancelReason": { -"description": "The reason why a subscription was canceled or is not auto-renewing. Possible values are: 0. User canceled the subscription 1. Subscription was canceled by the system, for example because of a billing problem 2. Subscription was replaced with a new subscription 3. Subscription was canceled by the developer", -"format": "int32", -"type": "integer" -}, -"cancelSurveyResult": { -"$ref": "SubscriptionCancelSurveyResult", -"description": "Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey)." -}, -"countryCode": { -"description": "ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.", -"type": "string" -}, -"developerPayload": { -"description": "A developer-specified string that contains supplemental information about an order.", -"type": "string" -}, -"emailAddress": { -"description": "The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.", -"type": "string" -}, -"expiryTimeMillis": { -"description": "Time at which the subscription will expire, in milliseconds since the Epoch.", -"format": "int64", -"type": "string" -}, -"externalAccountId": { -"description": "User account identifier in the third-party service. Only present if account linking happened as part of the subscription purchase flow.", -"type": "string" -}, -"familyName": { -"description": "The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.", -"type": "string" -}, -"givenName": { -"description": "The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.", -"type": "string" -}, -"introductoryPriceInfo": { -"$ref": "IntroductoryPriceInfo", -"description": "Introductory price information of the subscription. This is only present when the subscription was purchased with an introductory price. This field does not indicate the subscription is currently in introductory price period." -}, -"kind": { -"description": "This kind represents a subscriptionPurchase object in the androidpublisher service.", -"type": "string" -}, -"linkedPurchaseToken": { -"description": "The purchase token of the originating purchase if this subscription is one of the following: 0. Re-signup of a canceled but non-lapsed subscription 1. Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set.", -"type": "string" -}, -"obfuscatedExternalAccountId": { -"description": "An obfuscated version of the id that is uniquely associated with the user's account in your app. Present for the following purchases: * If account linking happened as part of the subscription purchase flow. * It was specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made.", -"type": "string" -}, -"obfuscatedExternalProfileId": { -"description": "An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made.", -"type": "string" -}, -"orderId": { -"description": "The order id of the latest recurring order associated with the purchase of the subscription. If the subscription was canceled because payment was declined, this will be the order id from the payment declined order.", -"type": "string" -}, -"paymentState": { -"description": "The payment state of the subscription. Possible values are: 0. Payment pending 1. Payment received 2. Free trial 3. Pending deferred upgrade/downgrade Not present for canceled, expired subscriptions.", -"format": "int32", -"type": "integer" -}, -"priceAmountMicros": { -"description": "Price of the subscription, For tax exclusive countries, the price doesn't include tax. For tax inclusive countries, the price includes tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is \u20ac1.99, price_amount_micros is 1990000.", -"format": "int64", -"type": "string" -}, -"priceChange": { -"$ref": "SubscriptionPriceChange", -"description": "The latest price change information available. This is present only when there is an upcoming price change for the subscription yet to be applied. Once the subscription renews with the new price or the subscription is canceled, no price change information will be returned." -}, -"priceCurrencyCode": { -"description": "ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is \"GBP\".", -"type": "string" -}, -"profileId": { -"description": "The Google profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.", -"type": "string" -}, -"profileName": { -"description": "The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.", -"type": "string" -}, -"promotionCode": { -"description": "The promotion code applied on this purchase. This field is only set if a vanity code promotion is applied when the subscription was purchased.", -"type": "string" -}, -"promotionType": { -"description": "The type of promotion applied on this purchase. This field is only set if a promotion is applied when the subscription was purchased. Possible values are: 0. One time code 1. Vanity code", -"format": "int32", -"type": "integer" -}, -"purchaseType": { -"description": "The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e. purchased using a promo code)", -"format": "int32", -"type": "integer" -}, -"startTimeMillis": { -"description": "Time at which the subscription was granted, in milliseconds since the Epoch.", -"format": "int64", -"type": "string" -}, -"userCancellationTimeMillis": { -"description": "The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, "SubscriptionPurchaseLineItem": { "description": "Item-level info for a subscription purchase.", "id": "SubscriptionPurchaseLineItem", @@ -12289,11 +13258,6 @@ false "description": "This kind represents a SubscriptionPurchaseV2 object in the androidpublisher service.", "type": "string" }, -"latestOrderId": { -"deprecated": true, -"description": "Deprecated: Use line_items.latest_successful_order_id instead. The order id of the latest order associated with the purchase of the subscription. For autoRenewing subscription, this is the order id of signup order if it is not renewed yet, or the last recurring order id (success, pending, or declined order). For prepaid subscription, this is the order id associated with the queried purchase token.", -"type": "string" -}, "lineItems": { "description": "Item-level info for a subscription purchase. The items in the same purchase should be either all with AutoRenewingPlan or all with PrepaidPlan.", "items": { @@ -12905,6 +13869,72 @@ false }, "type": "object" }, +"UpdateAppStoreHostedAppPublishStatusRequest": { +"description": "Request to update the publish status of an app store hosted app. The default state for any app with an update is PUBLISHED. It is not necessary to call this RPC explicitly to set an app to PUBLISHED.", +"id": "UpdateAppStoreHostedAppPublishStatusRequest", +"properties": { +"publishState": { +"description": "Required. The new publish state for the hosted app.", +"enum": [ +"APP_STORE_APP_PUBLISH_STATE_UNSPECIFIED", +"APP_STORE_APP_PUBLISH_STATE_PUBLISHED", +"APP_STORE_APP_PUBLISH_STATE_UNPUBLISHED" +], +"enumDescriptions": [ +"Unspecified publish state. Do not use.", +"The app is published and available on the third-party app store.", +"The app is unpublished and no longer available on the third-party app store." +], +"type": "string" +} +}, +"type": "object" +}, +"UpdateAppStoreHostedAppPublishStatusResponse": { +"description": "Response for updating the publish status of an app store hosted app.", +"id": "UpdateAppStoreHostedAppPublishStatusResponse", +"properties": {}, +"type": "object" +}, +"UpdateAppStoreHostedAppRequest": { +"description": "Request to update an app record for an app store hosted app.", +"id": "UpdateAppStoreHostedAppRequest", +"properties": { +"activeApks": { +"$ref": "AppStoreAppActiveApks", +"description": "Required. Actively distributed APKs of the app." +}, +"activeLocalizedStoreListings": { +"description": "Required. Localized store listings details of the update.", +"items": { +"$ref": "AppStoreAppStoreListing" +}, +"type": "array" +}, +"appDetails": { +"$ref": "AppStoreAppDetails", +"description": "Required. General developer details for the app." +}, +"packageName": { +"description": "Required. Package name of the app.", +"type": "string" +}, +"policyDeclarations": { +"description": "Required. Policy declarations provided for the app.", +"items": { +"$ref": "AppStoreAppPolicyDeclaration" +}, +"type": "array" +} +}, +"type": "object" +}, +"UpdateAppStoreHostedAppResponse": { +"description": "Response for updating an app record for an app store hosted app.", +"id": "UpdateAppStoreHostedAppResponse", +"properties": {}, +"type": "object" +}, "UpdateBasePlanStateRequest": { "description": "Request message to update the state of a subscription base plan.", "id": "UpdateBasePlanStateRequest", @@ -13140,6 +14170,70 @@ false }, "type": "object" }, +"UploadApkRequest": { +"description": "Request to upload an APK.", +"id": "UploadApkRequest", +"properties": {}, +"type": "object" +}, +"UploadApkResponse": { +"description": "Response for uploading an APK.", +"id": "UploadApkResponse", +"properties": { +"apkId": { +"description": "The unique ID of the uploaded APK.", +"type": "string" +} +}, +"type": "object" +}, +"UploadAppStoreAppPolicyDeclarationFileRequest": { +"description": "Request to upload a policy declaration file.", +"id": "UploadAppStoreAppPolicyDeclarationFileRequest", +"properties": { +"fileType": { +"description": "Required. Type of the policy declaration file.", +"enum": [ +"DECLARATION_FILE_TYPE_UNSPECIFIED", +"DECLARATION_FILE_TYPE_DOCUMENT" +], +"enumDescriptions": [ +"Unspecified file type.", +"File type for PDF, JPEG, and PNG documents." +], +"type": "string" +} +}, +"type": "object" +}, +"UploadAppStoreAppPolicyDeclarationFileResponse": { +"description": "Response for uploading a policy declaration file.", +"id": "UploadAppStoreAppPolicyDeclarationFileResponse", +"properties": { +"fileId": { +"description": "The unique ID of the uploaded file.", +"type": "string" +} +}, +"type": "object" +}, +"UploadImageRequest": { +"description": "Request to upload an image.", +"id": "UploadImageRequest", +"properties": {}, +"type": "object" +}, +"UploadImageResponse": { +"description": "Response for uploading an image.", +"id": "UploadImageResponse", +"properties": { +"imageId": { +"description": "The unique ID of the uploaded image.", +"type": "string" +} +}, +"type": "object" +}, "User": { "description": "A user resource.", "id": "User", @@ -13380,6 +14474,77 @@ false }, "type": "object" }, +"UsesConfiguration": { +"description": "Represents all configurations marked as required by use of the uses-configuration manifest tag.", +"id": "UsesConfiguration", +"properties": { +"requiredKeyboardType": { +"description": "The type of keyboard required.", +"enum": [ +"KEYBOARD_TYPE_UNSPECIFIED", +"KEYBOARD_TYPE_UNDEFINED", +"KEYBOARD_TYPE_NO_KEYS", +"KEYBOARD_TYPE_QWERTY", +"KEYBOARD_TYPE_TWELVE_KEY" +], +"enumDescriptions": [ +"Unspecified keyboard type.", +"Undefined keyboard type.", +"No keys keyboard.", +"Qwerty keyboard.", +"Twelve key keyboard." +], +"type": "string" +}, +"requiredNavigationType": { +"description": "The navigation device required.", +"enum": [ +"NAVIGATION_TYPE_UNSPECIFIED", +"NAVIGATION_TYPE_UNDEFINED", +"NAVIGATION_TYPE_NO_NAVIGATION", +"NAVIGATION_TYPE_DPAD", +"NAVIGATION_TYPE_TRACKBALL", +"NAVIGATION_TYPE_WHEEL" +], +"enumDescriptions": [ +"Unspecified navigation type.", +"Undefined navigation type.", +"No navigation.", +"Dpad navigation.", +"Trackball navigation.", +"Wheel navigation." +], +"type": "string" +}, +"requiredTouchscreenType": { +"description": "The type of touchscreen required.", +"enum": [ +"TOUCHSCREEN_TYPE_UNSPECIFIED", +"TOUCHSCREEN_TYPE_UNDEFINED", +"TOUCHSCREEN_TYPE_NO_TOUCHSCREEN", +"TOUCHSCREEN_TYPE_STYLUS", +"TOUCHSCREEN_TYPE_FINGER" +], +"enumDescriptions": [ +"Unspecified touchscreen type.", +"Undefined touchscreen type.", +"No touchscreen.", +"Stylus touchscreen.", +"Finger touchscreen." +], +"type": "string" +}, +"requiresFiveWayNavigation": { +"description": "Whether or not the application requires a five-way navigation control.", +"type": "boolean" +}, +"requiresHardwareKeyboard": { +"description": "Whether or not the application requires a hardware keyboard.", +"type": "boolean" +} +}, +"type": "object" +}, "UsesPermission": { "description": "A permission used by this APK.", "id": "UsesPermission", @@ -13455,6 +14620,17 @@ false }, "type": "object" }, +"VideoAsset": { +"description": "A video asset.", +"id": "VideoAsset", +"properties": { +"videoUrl": { +"description": "The URL of the video asset.", +"type": "string" +} +}, +"type": "object" +}, "VoidedPurchase": { "description": "A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.", "id": "VoidedPurchase", From 9224d460206abbd986153fd491dd069db095736e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:58 +0000 Subject: [PATCH 11/84] feat(apihub): update the api #### apihub:v1 The following keys were added: - resources.projects.resources.locations.resources.servers.methods.configureAndDeployServer (Total Keys: 12) - schemas.GoogleCloudApihubV1ApigeeXTargetDetails (Total Keys: 6) - schemas.GoogleCloudApihubV1ConfigureAndDeployServerRequest (Total Keys: 3) - schemas.GoogleCloudApihubV1HttpOperationConfig (Total Keys: 5) - schemas.GoogleCloudApihubV1McpServerConfig (Total Keys: 5) - schemas.GoogleCloudApihubV1McpToolConfig (Total Keys: 4) - schemas.GoogleCloudApihubV1MetaData (Total Keys: 3) - schemas.GoogleCloudApihubV1OperationConfig (Total Keys: 4) --- docs/dyn/apihub_v1.projects.locations.html | 5 + .../apihub_v1.projects.locations.servers.html | 156 +++++++++++++++ .../discovery_cache/documents/apihub.v1.json | 188 +++++++++++++++++- 3 files changed, 346 insertions(+), 3 deletions(-) create mode 100644 docs/dyn/apihub_v1.projects.locations.servers.html diff --git a/docs/dyn/apihub_v1.projects.locations.html b/docs/dyn/apihub_v1.projects.locations.html index c8eb94575f..64615dcfea 100644 --- a/docs/dyn/apihub_v1.projects.locations.html +++ b/docs/dyn/apihub_v1.projects.locations.html @@ -139,6 +139,11 @@

Instance Methods

Returns the runtimeProjectAttachments Resource.

+

+ servers() +

+

Returns the servers Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/apihub_v1.projects.locations.servers.html b/docs/dyn/apihub_v1.projects.locations.servers.html new file mode 100644 index 0000000000..5048f6da5d --- /dev/null +++ b/docs/dyn/apihub_v1.projects.locations.servers.html @@ -0,0 +1,156 @@ + + + +

API hub API . projects . locations . servers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ configureAndDeployServer(parent, body=None, x__xgafv=None)

+

Configures and deploys a given server config for given target. Currently this API supports only deploying MCP server in Apigee X. For mcp server deployment in apigee X, if there is already a mcp proxy deployed, then this method will try to overwrite it by creating new revision i.e. all existing tools will be removed and new set of tools will be deployed.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ configureAndDeployServer(parent, body=None, x__xgafv=None) +
Configures and deploys a given server config for given target. Currently this API supports only deploying MCP server in Apigee X. For mcp server deployment in apigee X, if there is already a mcp proxy deployed, then this method will try to overwrite it by creating new revision i.e. all existing tools will be removed and new set of tools will be deployed.
+
+Args:
+  parent: string, Required. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ApiHub.ConfigureAndDeployServer.
+  "mcpServerConfig": { # MCP-specific server configuration. # MCP (Model Context Protocol) server configuration.
+    "apigeeXTargetDetails": { # The target configuration for Apigee X. Note: If this API is called while an earlier deployment is still in progress, the earlier deployment will be aborted and a new deployment will be triggered. # Optional. The target Apigee X configuration.
+      "deployedRevision": "A String", # Output only. The revision number of the Apigee proxy that was deployed.
+      "environment": "A String", # Required. The specific Apigee environment where the server will be deployed.
+      "metadata": { # Metadata for the server configuration in Apigee X. # Optional. Metadata for the proxy configuration in Apigee X.
+        "description": "A String", # Optional. Description for the server. For apigee target, this will be used as revision description.
+        "displayName": "A String", # Optional. Display name for the server. For apigee target, this will be used as revision display name.
+      },
+      "proxy": "A String", # Required. This name identifies the proxy resource in Apigee. It typically follows a standard alphanumeric format (e.g., "mcp-discovery-server").
+      "targetProject": "A String", # Required. The runtime project that hosts the Apigee X organization. This must be one of the runtime projects attached to the API Hub host project.
+    },
+    "tools": [ # Required. The tools to expose on the MCP server.
+      { # A tool exposed by the MCP server. Each tool wraps exactly one API Hub operation under a caller-supplied identifier.
+        "description": "A String", # Required. Description of what the tool does and how it is used. Description serves as key reference for the agent to know about the tool capabilities.
+        "operation": { # API hub Operation config. # Required. The API Hub operation this tool exposes. Each tool wraps exactly one operation; callers that want to expose multiple operations should declare multiple tools.
+          "httpOperation": { # Identifies a single API Hub operation by spec resource name + HTTP path + HTTP method. # The HTTP operation config.
+            "method": "A String", # Required. HTTP method of the operation within the referenced spec. (GET / PUT / POST / DELETE / OPTIONS / HEAD / PATCH / TRACE).
+            "path": "A String", # Required. HTTP path of the operation within the referenced spec. Match is exact (no template substitution): the path here must appear verbatim on an APIOperationRevision belonging to the spec.
+            "spec": "A String", # Required. Spec resource name: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+          },
+          "operation": "A String", # Full API Hub operation resource name: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+        },
+        "toolId": "A String", # Required. Caller-supplied identifier for the tool; each tool must have a unique identifier. This will be by used by agents to invoke the tool. Tool ID must be unique across all tools in the given MCP server configuration.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/apihub.v1.json b/googleapiclient/discovery_cache/documents/apihub.v1.json index 4e7be0c487..757643664a 100644 --- a/googleapiclient/discovery_cache/documents/apihub.v1.json +++ b/googleapiclient/discovery_cache/documents/apihub.v1.json @@ -3396,13 +3396,46 @@ ] } } +}, +"servers": { +"methods": { +"configureAndDeployServer": { +"description": "Configures and deploys a given server config for given target. Currently this API supports only deploying MCP server in Apigee X. For mcp server deployment in apigee X, if there is already a mcp proxy deployed, then this method will try to overwrite it by creating new revision i.e. all existing tools will be removed and new set of tools will be deployed.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/servers:configureAndDeployServer", +"httpMethod": "POST", +"id": "apihub.projects.locations.servers.configureAndDeployServer", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/servers:configureAndDeployServer", +"request": { +"$ref": "GoogleCloudApihubV1ConfigureAndDeployServerRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/apihub.readwrite", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} } } } } } }, -"revision": "20260622", +"revision": "20260720", "rootUrl": "https://apihub.googleapis.com/", "schemas": { "Empty": { @@ -3980,6 +4013,34 @@ }, "type": "object" }, +"GoogleCloudApihubV1ApigeeXTargetDetails": { +"description": "The target configuration for Apigee X. Note: If this API is called while an earlier deployment is still in progress, the earlier deployment will be aborted and a new deployment will be triggered.", +"id": "GoogleCloudApihubV1ApigeeXTargetDetails", +"properties": { +"deployedRevision": { +"description": "Output only. The revision number of the Apigee proxy that was deployed.", +"readOnly": true, +"type": "string" +}, +"environment": { +"description": "Required. The specific Apigee environment where the server will be deployed.", +"type": "string" +}, +"metadata": { +"$ref": "GoogleCloudApihubV1MetaData", +"description": "Optional. Metadata for the proxy configuration in Apigee X." +}, +"proxy": { +"description": "Required. This name identifies the proxy resource in Apigee. It typically follows a standard alphanumeric format (e.g., \"mcp-discovery-server\").", +"type": "string" +}, +"targetProject": { +"description": "Required. The runtime project that hosts the Apigee X organization. This must be one of the runtime projects attached to the API Hub host project.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudApihubV1ApplicationIntegrationEndpointDetails": { "description": "The details of the Application Integration endpoint to be triggered for curation.", "id": "GoogleCloudApihubV1ApplicationIntegrationEndpointDetails", @@ -4424,6 +4485,17 @@ }, "type": "object" }, +"GoogleCloudApihubV1ConfigureAndDeployServerRequest": { +"description": "Request message for ApiHub.ConfigureAndDeployServer.", +"id": "GoogleCloudApihubV1ConfigureAndDeployServerRequest", +"properties": { +"mcpServerConfig": { +"$ref": "GoogleCloudApihubV1McpServerConfig", +"description": "MCP (Model Context Protocol) server configuration." +} +}, +"type": "object" +}, "GoogleCloudApihubV1Curation": { "description": "A curation resource in the API Hub.", "id": "GoogleCloudApihubV1Curation", @@ -5397,6 +5469,47 @@ }, "type": "object" }, +"GoogleCloudApihubV1HttpOperationConfig": { +"description": "Identifies a single API Hub operation by spec resource name + HTTP path + HTTP method.", +"id": "GoogleCloudApihubV1HttpOperationConfig", +"properties": { +"method": { +"description": "Required. HTTP method of the operation within the referenced spec. (GET / PUT / POST / DELETE / OPTIONS / HEAD / PATCH / TRACE).", +"enum": [ +"METHOD_UNSPECIFIED", +"GET", +"PUT", +"POST", +"DELETE", +"OPTIONS", +"HEAD", +"PATCH", +"TRACE" +], +"enumDescriptions": [ +"Method unspecified.", +"Get Operation type.", +"Put Operation type.", +"Post Operation type.", +"Delete Operation type.", +"Options Operation type.", +"Head Operation type.", +"Patch Operation type.", +"Trace Operation type." +], +"type": "string" +}, +"path": { +"description": "Required. HTTP path of the operation within the referenced spec. Match is exact (no template substitution): the path here must appear verbatim on an APIOperationRevision belonging to the spec.", +"type": "string" +}, +"spec": { +"description": "Required. Spec resource name: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudApihubV1HttpOperationDetails": { "description": "An HTTP-based API Operation, sometimes called a \"REST\" Operation.", "id": "GoogleCloudApihubV1HttpOperationDetails", @@ -6005,6 +6118,24 @@ }, "type": "object" }, +"GoogleCloudApihubV1McpServerConfig": { +"description": "MCP-specific server configuration.", +"id": "GoogleCloudApihubV1McpServerConfig", +"properties": { +"apigeeXTargetDetails": { +"$ref": "GoogleCloudApihubV1ApigeeXTargetDetails", +"description": "Optional. The target Apigee X configuration." +}, +"tools": { +"description": "Required. The tools to expose on the MCP server.", +"items": { +"$ref": "GoogleCloudApihubV1McpToolConfig" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudApihubV1McpTool": { "description": "Details describing an MCP Tool.", "id": "GoogleCloudApihubV1McpTool", @@ -6036,6 +6167,40 @@ }, "type": "object" }, +"GoogleCloudApihubV1McpToolConfig": { +"description": "A tool exposed by the MCP server. Each tool wraps exactly one API Hub operation under a caller-supplied identifier.", +"id": "GoogleCloudApihubV1McpToolConfig", +"properties": { +"description": { +"description": "Required. Description of what the tool does and how it is used. Description serves as key reference for the agent to know about the tool capabilities.", +"type": "string" +}, +"operation": { +"$ref": "GoogleCloudApihubV1OperationConfig", +"description": "Required. The API Hub operation this tool exposes. Each tool wraps exactly one operation; callers that want to expose multiple operations should declare multiple tools." +}, +"toolId": { +"description": "Required. Caller-supplied identifier for the tool; each tool must have a unique identifier. This will be by used by agents to invoke the tool. Tool ID must be unique across all tools in the given MCP server configuration.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudApihubV1MetaData": { +"description": "Metadata for the server configuration in Apigee X.", +"id": "GoogleCloudApihubV1MetaData", +"properties": { +"description": { +"description": "Optional. Description for the server. For apigee target, this will be used as revision description.", +"type": "string" +}, +"displayName": { +"description": "Optional. Display name for the server. For apigee target, this will be used as revision display name.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudApihubV1MultiIntValues": { "description": "The config variable value of data type multi int.", "id": "GoogleCloudApihubV1MultiIntValues", @@ -6128,6 +6293,21 @@ }, "type": "object" }, +"GoogleCloudApihubV1OperationConfig": { +"description": "API hub Operation config.", +"id": "GoogleCloudApihubV1OperationConfig", +"properties": { +"httpOperation": { +"$ref": "GoogleCloudApihubV1HttpOperationConfig", +"description": "The HTTP operation config." +}, +"operation": { +"description": "Full API Hub operation resource name: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudApihubV1OperationDetails": { "description": "The operation details parsed from the spec.", "id": "GoogleCloudApihubV1OperationDetails", @@ -6319,7 +6499,8 @@ "CLOUD_API_GATEWAY", "CLOUD_ENDPOINTS", "API_DISCOVERY", -"OTHERS" +"OTHERS", +"AWS_API_GATEWAY" ], "enumDescriptions": [ "The gateway type is not specified.", @@ -6329,7 +6510,8 @@ "The gateway type is Cloud API Gateway.", "The gateway type is Cloud Endpoints.", "The gateway type is API Discovery.", -"The gateway type for any other types of gateways." +"The gateway type for any other types of gateways.", +"The gateway type is AWS API Gateway." ], "type": "string" }, From f9cb9f5ab22a950a47e3d05ff0c034dbd02c9ee0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:58 +0000 Subject: [PATCH 12/84] feat(apikeys): update the api #### apikeys:v2 The following keys were added: - resources.projects.resources.locations.resources.keys.methods.patch.parameters.checkExistingUsage (Total Keys: 2) --- .../dyn/apikeys_v2.projects.locations.keys.html | 9 +++++++-- .../discovery_cache/documents/apikeys.v2.json | 17 ++++++++++++++++- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/docs/dyn/apikeys_v2.projects.locations.keys.html b/docs/dyn/apikeys_v2.projects.locations.keys.html index 225dc302d7..25d4e90b78 100644 --- a/docs/dyn/apikeys_v2.projects.locations.keys.html +++ b/docs/dyn/apikeys_v2.projects.locations.keys.html @@ -96,7 +96,7 @@

Instance Methods

list_next()

Retrieves the next page of results.

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

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

Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.

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

@@ -398,7 +398,7 @@

Method Details

- patch(name, body=None, updateMask=None, x__xgafv=None) + patch(name, body=None, checkExistingUsage=None, updateMask=None, x__xgafv=None)
Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.
 
 Args:
@@ -454,6 +454,11 @@ 

Method Details

"updateTime": "A String", # Output only. A timestamp identifying the time this key was last updated. } + checkExistingUsage: string, Optional. Defines the behavior for checking existing usage when updating a key. + Allowed values + CHECK_EXISTING_USAGE_UNSPECIFIED - When unset, the default behavior is used, which is SKIP. + SKIP - If set, skip checking existing usage when updating a key. + CHECK - If set, existing usage is checked when updating the key. If the key has usage in the last 7 days, the request returns a FAILED_PRECONDITION error. updateMask: string, The field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: `display_name`, `restrictions`, and `annotations`. If an update mask is not provided, the service treats it as an implied mask equivalent to all allowed fields that are set on the wire. If the field mask has a special value "*", the service treats it equivalent to replace all allowed mutable fields. x__xgafv: string, V1 error format. Allowed values diff --git a/googleapiclient/discovery_cache/documents/apikeys.v2.json b/googleapiclient/discovery_cache/documents/apikeys.v2.json index 87e7165fa4..05ff74398b 100644 --- a/googleapiclient/discovery_cache/documents/apikeys.v2.json +++ b/googleapiclient/discovery_cache/documents/apikeys.v2.json @@ -336,6 +336,21 @@ "name" ], "parameters": { +"checkExistingUsage": { +"description": "Optional. Defines the behavior for checking existing usage when updating a key.", +"enum": [ +"CHECK_EXISTING_USAGE_UNSPECIFIED", +"SKIP", +"CHECK" +], +"enumDescriptions": [ +"When unset, the default behavior is used, which is SKIP.", +"If set, skip checking existing usage when updating a key.", +"If set, existing usage is checked when updating the key. If the key has usage in the last 7 days, the request returns a FAILED_PRECONDITION error." +], +"location": "query", +"type": "string" +}, "name": { "description": "Identifier. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.", "location": "path", @@ -396,7 +411,7 @@ } } }, -"revision": "20260317", +"revision": "20260721", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { From d78358a66a1a5850592f2a209a79552b435388a9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:58 +0000 Subject: [PATCH 13/84] feat(appengine): update the api #### appengine:v1 The following keys were added: - schemas.Version.properties.appEngineBundledServices (Total Keys: 2) --- .../appengine_v1.apps.services.versions.html | 12 +++++ ...ations.applications.services.versions.html | 3 ++ .../documents/appengine.v1.json | 45 ++++++++++++++++++- 3 files changed, 59 insertions(+), 1 deletion(-) diff --git a/docs/dyn/appengine_v1.apps.services.versions.html b/docs/dyn/appengine_v1.apps.services.versions.html index f529c72ebc..fab2c353a4 100644 --- a/docs/dyn/appengine_v1.apps.services.versions.html +++ b/docs/dyn/appengine_v1.apps.services.versions.html @@ -128,6 +128,9 @@

Method Details

"url": "A String", # URL to serve the endpoint at. }, "appEngineApis": True or False, # Allows App Engine second generation runtimes to access the legacy bundled services. + "appEngineBundledServices": [ # List of specific App Engine Bundled Services that are enabled for this Version. + "A String", + ], "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics. Instances are dynamically created and destroyed as needed in order to handle traffic. "coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment. "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage. @@ -474,6 +477,9 @@

Method Details

"url": "A String", # URL to serve the endpoint at. }, "appEngineApis": True or False, # Allows App Engine second generation runtimes to access the legacy bundled services. + "appEngineBundledServices": [ # List of specific App Engine Bundled Services that are enabled for this Version. + "A String", + ], "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics. Instances are dynamically created and destroyed as needed in order to handle traffic. "coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment. "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage. @@ -715,6 +721,9 @@

Method Details

"url": "A String", # URL to serve the endpoint at. }, "appEngineApis": True or False, # Allows App Engine second generation runtimes to access the legacy bundled services. + "appEngineBundledServices": [ # List of specific App Engine Bundled Services that are enabled for this Version. + "A String", + ], "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics. Instances are dynamically created and destroyed as needed in order to handle traffic. "coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment. "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage. @@ -959,6 +968,9 @@

Method Details

"url": "A String", # URL to serve the endpoint at. }, "appEngineApis": True or False, # Allows App Engine second generation runtimes to access the legacy bundled services. + "appEngineBundledServices": [ # List of specific App Engine Bundled Services that are enabled for this Version. + "A String", + ], "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics. Instances are dynamically created and destroyed as needed in order to handle traffic. "coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment. "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage. diff --git a/docs/dyn/appengine_v1.projects.locations.applications.services.versions.html b/docs/dyn/appengine_v1.projects.locations.applications.services.versions.html index fb1a9924a7..ab9e2ebb50 100644 --- a/docs/dyn/appengine_v1.projects.locations.applications.services.versions.html +++ b/docs/dyn/appengine_v1.projects.locations.applications.services.versions.html @@ -204,6 +204,9 @@

Method Details

"url": "A String", # URL to serve the endpoint at. }, "appEngineApis": True or False, # Allows App Engine second generation runtimes to access the legacy bundled services. + "appEngineBundledServices": [ # List of specific App Engine Bundled Services that are enabled for this Version. + "A String", + ], "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics. Instances are dynamically created and destroyed as needed in order to handle traffic. "coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment. "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage. diff --git a/googleapiclient/discovery_cache/documents/appengine.v1.json b/googleapiclient/discovery_cache/documents/appengine.v1.json index 6cf4d80356..fb897603af 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1.json @@ -2753,7 +2753,7 @@ } } }, -"revision": "20260429", +"revision": "20260717", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -5121,6 +5121,49 @@ true "description": "Allows App Engine second generation runtimes to access the legacy bundled services.", "type": "boolean" }, +"appEngineBundledServices": { +"description": "List of specific App Engine Bundled Services that are enabled for this Version.", +"items": { +"enum": [ +"BUNDLED_SERVICE_TYPE_UNSPECIFIED", +"BUNDLED_SERVICE_TYPE_APP_IDENTITY_SERVICE", +"BUNDLED_SERVICE_TYPE_BLOBSTORE", +"BUNDLED_SERVICE_TYPE_CAPABILITY_SERVICE", +"BUNDLED_SERVICE_TYPE_DATASTORE_V3", +"BUNDLED_SERVICE_TYPE_DEFERRED", +"BUNDLED_SERVICE_TYPE_IMAGES", +"BUNDLED_SERVICE_TYPE_MAIL", +"BUNDLED_SERVICE_TYPE_MEMCACHE", +"BUNDLED_SERVICE_TYPE_MODULES", +"BUNDLED_SERVICE_TYPE_NAMESPACES", +"BUNDLED_SERVICE_TYPE_NDB", +"BUNDLED_SERVICE_TYPE_SEARCH", +"BUNDLED_SERVICE_TYPE_TASKQUEUES", +"BUNDLED_SERVICE_TYPE_URLFETCH", +"BUNDLED_SERVICE_TYPE_USERS" +], +"enumDescriptions": [ +"Default, invalid value", +"App Identity Service", +"Blobstore", +"Capability Service", +"Datastore V3", +"Deferred", +"Images", +"Mail", +"Memcache", +"Modules", +"Namespaces", +"NDB", +"Search", +"Task Queues", +"URL Fetch", +"Users" +], +"type": "string" +}, +"type": "array" +}, "automaticScaling": { "$ref": "AutomaticScaling", "description": "Automatic scaling is based on request rate, response latencies, and other application metrics. Instances are dynamically created and destroyed as needed in order to handle traffic." From 2efadd02cc166f4bee44d234d88c6ea7054684cd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:59 +0000 Subject: [PATCH 14/84] feat(artifactregistry): update the api #### artifactregistry:v1 The following keys were added: - schemas.NoCacheFetching (Total Keys: 2) - schemas.RemoteRepositoryConfig.properties.noCache.$ref (Total Keys: 1) --- ...tregistry_v1.projects.locations.repositories.html | 10 ++++++++++ .../documents/artifactregistry.v1.json | 12 +++++++++++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html index 1e41e6181b..b04866bd03 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html @@ -315,6 +315,8 @@

Method Details

}, "publicRepository": "A String", # One of the publicly available Maven repositories supported by Artifact Registry. }, + "noCache": { # The configuration for the no-cache fetching mode, which acts as a non-caching proxy. # The remote repository will act as a non-caching proxy. + }, "npmRepository": { # Configuration for a Npm remote repository. # Specific settings for an Npm remote repository. "customRepository": { # Customer-specified publicly available remote repository. # Customer-specified remote repository. "uri": "A String", # An http/https uri reference to the upstream remote repository, for ex: "https://my.npm.registry/". @@ -564,6 +566,8 @@

Method Details

}, "publicRepository": "A String", # One of the publicly available Maven repositories supported by Artifact Registry. }, + "noCache": { # The configuration for the no-cache fetching mode, which acts as a non-caching proxy. # The remote repository will act as a non-caching proxy. + }, "npmRepository": { # Configuration for a Npm remote repository. # Specific settings for an Npm remote repository. "customRepository": { # Customer-specified publicly available remote repository. # Customer-specified remote repository. "uri": "A String", # An http/https uri reference to the upstream remote repository, for ex: "https://my.npm.registry/". @@ -747,6 +751,8 @@

Method Details

}, "publicRepository": "A String", # One of the publicly available Maven repositories supported by Artifact Registry. }, + "noCache": { # The configuration for the no-cache fetching mode, which acts as a non-caching proxy. # The remote repository will act as a non-caching proxy. + }, "npmRepository": { # Configuration for a Npm remote repository. # Specific settings for an Npm remote repository. "customRepository": { # Customer-specified publicly available remote repository. # Customer-specified remote repository. "uri": "A String", # An http/https uri reference to the upstream remote repository, for ex: "https://my.npm.registry/". @@ -899,6 +905,8 @@

Method Details

}, "publicRepository": "A String", # One of the publicly available Maven repositories supported by Artifact Registry. }, + "noCache": { # The configuration for the no-cache fetching mode, which acts as a non-caching proxy. # The remote repository will act as a non-caching proxy. + }, "npmRepository": { # Configuration for a Npm remote repository. # Specific settings for an Npm remote repository. "customRepository": { # Customer-specified publicly available remote repository. # Customer-specified remote repository. "uri": "A String", # An http/https uri reference to the upstream remote repository, for ex: "https://my.npm.registry/". @@ -1034,6 +1042,8 @@

Method Details

}, "publicRepository": "A String", # One of the publicly available Maven repositories supported by Artifact Registry. }, + "noCache": { # The configuration for the no-cache fetching mode, which acts as a non-caching proxy. # The remote repository will act as a non-caching proxy. + }, "npmRepository": { # Configuration for a Npm remote repository. # Specific settings for an Npm remote repository. "customRepository": { # Customer-specified publicly available remote repository. # Customer-specified remote repository. "uri": "A String", # An http/https uri reference to the upstream remote repository, for ex: "https://my.npm.registry/". diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index 869cc6d3c6..89954bc594 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -2714,7 +2714,7 @@ } } }, -"revision": "20260603", +"revision": "20260702", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -4182,6 +4182,12 @@ }, "type": "object" }, +"NoCacheFetching": { +"description": "The configuration for the no-cache fetching mode, which acts as a non-caching proxy.", +"id": "NoCacheFetching", +"properties": {}, +"type": "object" +}, "NpmPackage": { "description": "NpmPackage represents an npm artifact.", "id": "NpmPackage", @@ -4610,6 +4616,10 @@ false "$ref": "MavenRepository", "description": "Specific settings for a Maven remote repository." }, +"noCache": { +"$ref": "NoCacheFetching", +"description": "The remote repository will act as a non-caching proxy." +}, "npmRepository": { "$ref": "NpmRepository", "description": "Specific settings for an Npm remote repository." From c988da94666824a1fcec32d253915bcb280c9308 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:59 +0000 Subject: [PATCH 15/84] feat(assuredworkloads): update the api #### assuredworkloads:v1 The following keys were added: - resources.folders.resources.locations.resources.dbFrameworkComplianceReports.methods.aggregate (Total Keys: 19) - resources.folders.resources.locations.resources.dbFrameworkComplianceReports.methods.fetch (Total Keys: 16) - resources.folders.resources.locations.resources.dbFrameworkComplianceReports.resources.dbControlComplianceSummaries.methods.list (Total Keys: 18) - resources.folders.resources.locations.resources.dbFrameworkComplianceSummaries.methods.list (Total Keys: 20) - resources.organizations.resources.locations.resources.dbFrameworkComplianceReports.methods.aggregate (Total Keys: 19) - resources.organizations.resources.locations.resources.dbFrameworkComplianceReports.methods.fetch (Total Keys: 16) - resources.organizations.resources.locations.resources.dbFrameworkComplianceReports.resources.dbControlComplianceSummaries.methods.list (Total Keys: 18) - resources.organizations.resources.locations.resources.dbFrameworkComplianceSummaries.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.dbFrameworkComplianceReports.methods.aggregate (Total Keys: 19) - resources.projects.resources.locations.resources.dbFrameworkComplianceReports.methods.fetch (Total Keys: 16) - resources.projects.resources.locations.resources.dbFrameworkComplianceReports.resources.dbControlComplianceSummaries.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.dbFrameworkComplianceSummaries.methods.list (Total Keys: 20) - schemas.GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsV1AggregatedComplianceReport (Total Keys: 5) - schemas.GoogleCloudAssuredworkloadsV1CELExpression (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsV1CloudControlAssessmentDetails (Total Keys: 6) - schemas.GoogleCloudAssuredworkloadsV1CloudControlReport (Total Keys: 17) - schemas.GoogleCloudAssuredworkloadsV1ControlAssessmentDetails (Total Keys: 18) - schemas.GoogleCloudAssuredworkloadsV1DbControlComplianceSummary (Total Keys: 17) - schemas.GoogleCloudAssuredworkloadsV1DbFrameworkComplianceSummary (Total Keys: 18) - schemas.GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse (Total Keys: 16) - schemas.GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse (Total Keys: 6) - schemas.GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse (Total Keys: 6) - schemas.GoogleCloudAssuredworkloadsV1ManualCloudControlAssessmentDetails (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsV1Rule (Total Keys: 5) - schemas.GoogleCloudAssuredworkloadsV1SimilarControls (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsV1StringList (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsV1TargetResourceDetails (Total Keys: 9) - schemas.GoogleCloudAssuredworkloadsV1Trend (Total Keys: 8) #### assuredworkloads:v1beta1 The following keys were added: - resources.folders.resources.locations.resources.dbFindingSummaries.methods.list (Total Keys: 18) - resources.folders.resources.locations.resources.dbFrameworkComplianceReports.methods.aggregate (Total Keys: 19) - resources.folders.resources.locations.resources.dbFrameworkComplianceReports.methods.fetch (Total Keys: 16) - resources.folders.resources.locations.resources.dbFrameworkComplianceReports.resources.dbControlComplianceSummaries.methods.list (Total Keys: 18) - resources.folders.resources.locations.resources.dbFrameworkComplianceSummaries.methods.list (Total Keys: 20) - resources.organizations.resources.locations.resources.dbFindingSummaries.methods.list (Total Keys: 18) - resources.organizations.resources.locations.resources.dbFrameworkComplianceReports.methods.aggregate (Total Keys: 19) - resources.organizations.resources.locations.resources.dbFrameworkComplianceReports.methods.fetch (Total Keys: 16) - resources.organizations.resources.locations.resources.dbFrameworkComplianceReports.resources.dbControlComplianceSummaries.methods.list (Total Keys: 18) - resources.organizations.resources.locations.resources.dbFrameworkComplianceSummaries.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.dbFindingSummaries.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.dbFrameworkComplianceReports.methods.aggregate (Total Keys: 19) - resources.projects.resources.locations.resources.dbFrameworkComplianceReports.methods.fetch (Total Keys: 16) - resources.projects.resources.locations.resources.dbFrameworkComplianceReports.resources.dbControlComplianceSummaries.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.dbFrameworkComplianceSummaries.methods.list (Total Keys: 20) - schemas.GoogleCloudAssuredworkloadsV1beta1AggregateDbFrameworkComplianceReportResponse (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsV1beta1AggregatedComplianceReport (Total Keys: 5) - schemas.GoogleCloudAssuredworkloadsV1beta1CELExpression (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsV1beta1CloudControlAssessmentDetails (Total Keys: 6) - schemas.GoogleCloudAssuredworkloadsV1beta1CloudControlReport (Total Keys: 17) - schemas.GoogleCloudAssuredworkloadsV1beta1ControlAssessmentDetails (Total Keys: 18) - schemas.GoogleCloudAssuredworkloadsV1beta1DbControlComplianceSummary (Total Keys: 17) - schemas.GoogleCloudAssuredworkloadsV1beta1DbFindingSummary (Total Keys: 17) - schemas.GoogleCloudAssuredworkloadsV1beta1DbFrameworkComplianceSummary (Total Keys: 18) - schemas.GoogleCloudAssuredworkloadsV1beta1FetchDbFrameworkComplianceReportResponse (Total Keys: 16) - schemas.GoogleCloudAssuredworkloadsV1beta1ListDbControlComplianceSummariesResponse (Total Keys: 6) - schemas.GoogleCloudAssuredworkloadsV1beta1ListDbFindingSummariesResponse (Total Keys: 6) - schemas.GoogleCloudAssuredworkloadsV1beta1ListDbFrameworkComplianceSummariesResponse (Total Keys: 6) - schemas.GoogleCloudAssuredworkloadsV1beta1ManualCloudControlAssessmentDetails (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsV1beta1Rule (Total Keys: 5) - schemas.GoogleCloudAssuredworkloadsV1beta1SimilarControls (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsV1beta1StringList (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsV1beta1TargetResourceDetails (Total Keys: 9) - schemas.GoogleCloudAssuredworkloadsV1beta1Trend (Total Keys: 8) --- ...eReports.dbControlComplianceSummaries.html | 200 ++ ...ocations.dbFrameworkComplianceReports.html | 204 ++ ...ations.dbFrameworkComplianceSummaries.html | 183 ++ ...assuredworkloads_v1.folders.locations.html | 10 + ...eReports.dbControlComplianceSummaries.html | 200 ++ ...ocations.dbFrameworkComplianceReports.html | 204 ++ ...ations.dbFrameworkComplianceSummaries.html | 183 ++ ...dworkloads_v1.organizations.locations.html | 10 + ...eReports.dbControlComplianceSummaries.html | 200 ++ ...ocations.dbFrameworkComplianceReports.html | 204 ++ ...ations.dbFrameworkComplianceSummaries.html | 183 ++ ...ssuredworkloads_v1.projects.locations.html | 10 + .../dyn/assuredworkloads_v1beta1.folders.html | 91 + ....folders.locations.dbFindingSummaries.html | 141 ++ ...eReports.dbControlComplianceSummaries.html | 200 ++ ...ocations.dbFrameworkComplianceReports.html | 204 ++ ...ations.dbFrameworkComplianceSummaries.html | 183 ++ ...edworkloads_v1beta1.folders.locations.html | 101 + docs/dyn/assuredworkloads_v1beta1.html | 10 + ...izations.locations.dbFindingSummaries.html | 141 ++ ...eReports.dbControlComplianceSummaries.html | 200 ++ ...ocations.dbFrameworkComplianceReports.html | 204 ++ ...ations.dbFrameworkComplianceSummaries.html | 183 ++ ...loads_v1beta1.organizations.locations.html | 15 + .../assuredworkloads_v1beta1.projects.html | 4 +- ...projects.locations.dbFindingSummaries.html | 141 ++ ...eReports.dbControlComplianceSummaries.html | 200 ++ ...ocations.dbFrameworkComplianceReports.html | 204 ++ ...ations.dbFrameworkComplianceSummaries.html | 183 ++ ...dworkloads_v1beta1.projects.locations.html | 101 + .../documents/assuredworkloads.v1.json | 1420 ++++++++++- .../documents/assuredworkloads.v1beta1.json | 2249 ++++++++++++++--- 32 files changed, 7546 insertions(+), 420 deletions(-) create mode 100644 docs/dyn/assuredworkloads_v1.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1.folders.locations.dbFrameworkComplianceReports.html create mode 100644 docs/dyn/assuredworkloads_v1.folders.locations.dbFrameworkComplianceSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1.organizations.locations.dbFrameworkComplianceReports.html create mode 100644 docs/dyn/assuredworkloads_v1.organizations.locations.dbFrameworkComplianceSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1.projects.locations.dbFrameworkComplianceReports.html create mode 100644 docs/dyn/assuredworkloads_v1.projects.locations.dbFrameworkComplianceSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.folders.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFindingSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFrameworkComplianceReports.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFrameworkComplianceSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.folders.locations.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFindingSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFrameworkComplianceReports.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFrameworkComplianceSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFindingSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFrameworkComplianceReports.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFrameworkComplianceSummaries.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.projects.locations.html diff --git a/docs/dyn/assuredworkloads_v1.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html b/docs/dyn/assuredworkloads_v1.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html new file mode 100644 index 0000000000..91aaae783b --- /dev/null +++ b/docs/dyn/assuredworkloads_v1.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html @@ -0,0 +1,200 @@ + + + +

Assured Workloads API . folders . locations . dbFrameworkComplianceReports . dbControlComplianceSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the control compliance summary for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the control compliance summary for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return.
+  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 ListDBControlComplianceSummaries.
+  "dbControlComplianceSummaries": [ # The list of control compliance details.
+    { # The details for control compliance.
+      "cloudControlReports": [ # The list of cloud control reports.
+        { # The cloud control report.
+          "categories": [ # The list of categories for the cloud control.
+            "A String",
+          ],
+          "cloudControl": "A String", # The name of the cloud control.
+          "cloudControlAssessmentDetails": { # The cloud control assessment details for non-manual cloud controls. # The details of a cloud control assessment.
+            "evaluationState": "A String", # Output only. The evaluation status of the cloud control.
+            "findingsCount": 42, # The number of findings for the cloud control.
+          },
+          "cloudControlDeployment": "A String", # The name of the cloud control deployment.
+          "cloudControlType": "A String", # The type of the cloud control.
+          "description": "A String", # The description of the cloud control.
+          "displayName": "A String", # The display name of the cloud control.
+          "enforcementMode": "A String", # The enforcement mode of the cloud control.
+          "findingCategory": "A String", # The category of the finding.
+          "findingSeverity": "A String", # The severity of the finding.
+          "frameworkMajorRevisionIds": [ # The major revision IDs of the frameworks that the cloud control belongs to.
+            "A String",
+          ],
+          "majorRevisionId": "A String", # The major revision ID of the cloud control.
+          "manualCloudControlAssessmentDetails": { # The details for a manual cloud control assessment. # The details of a manual cloud control assessment.
+            "manualCloudControlGuide": [ # The guide for assessing a cloud control manually.
+              "A String",
+            ],
+          },
+          "minorRevisionId": "A String", # The minor revision ID of the cloud control.
+          "rules": [ # The list of rules that correspond to the cloud control.
+            { # A rule in the cloud control.
+              "celExpression": { # A Common Expression Language (CEL) expression that's used to create a rule. # The rule's logic expression in Common Expression Language (CEL).
+                "expression": "A String", # Required. The logical expression in CEL. The maximum length of the condition is 1000 characters. For more information, see [CEL expression](https://cloud.google.com/security-command-center/docs/compliance-manager-write-cel-expressions).
+                "resourceTypesValues": { # A list of strings for the parameter value. # The resource instance types on which this expression is defined. The format is `/`. For example: `compute.googleapis.com/Instance`
+                  "values": [ # Required. The strings in the list.
+                    "A String",
+                  ],
+                },
+              },
+              "description": "A String", # Optional. The rule description. The maximum length is 2000 characters.
+              "ruleActionTypes": [ # Required. The functionality that's enabled by the rule.
+                "A String",
+              ],
+            },
+          ],
+          "similarControls": [ # The list of similar controls.
+            { # The similar controls.
+              "controlId": "A String", # The ID of the control.
+              "framework": "A String", # The name of the framework.
+            },
+          ],
+        },
+      ],
+      "complianceFrameworks": [ # The list of compliance frameworks that the control belongs to.
+        "A String",
+      ],
+      "control": "A String", # The name of the control.
+      "controlResponsibilityType": "A String", # The responsibility type for the control.
+      "description": "A String", # The description of the control.
+      "displayName": "A String", # The display name of the control.
+      "isFakeControl": True or False, # Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.
+      "name": "A String", # Identifier. The name of the control compliance summary.
+      "overallEvaluationState": "A String", # Output only. The overall evaluation status of the control.
+      "similarControls": [ # The list of similar controls.
+        { # The similar controls.
+          "controlId": "A String", # The ID of the control.
+          "framework": "A String", # The name of the framework.
+        },
+      ],
+      "totalFindingsCount": 42, # The total number of findings for the control.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1.folders.locations.dbFrameworkComplianceReports.html b/docs/dyn/assuredworkloads_v1.folders.locations.dbFrameworkComplianceReports.html new file mode 100644 index 0000000000..167c6bc459 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1.folders.locations.dbFrameworkComplianceReports.html @@ -0,0 +1,204 @@ + + + +

Assured Workloads API . folders . locations . dbFrameworkComplianceReports

+

Instance Methods

+

+ dbControlComplianceSummaries() +

+

Returns the dbControlComplianceSummaries Resource.

+ +

+ aggregate(name, filter=None, interval_endTime=None, interval_startTime=None, x__xgafv=None)

+

Gets the aggregated compliance report over time for a given scope.

+

+ close()

+

Close httplib2 connections.

+

+ fetch(name, endTime=None, filter=None, x__xgafv=None)

+

Fetches the framework compliance report for a given scope.

+

Method Details

+
+ aggregate(name, filter=None, interval_endTime=None, interval_startTime=None, x__xgafv=None) +
Gets the aggregated compliance report over time for a given scope.
+
+Args:
+  name: string, Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` (required)
+  filter: string, Optional. The filtering results.
+  interval_endTime: string, Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+  interval_startTime: string, Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  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 AggregateDbFrameworkComplianceReport.
+  "aggregatedComplianceReports": [ # The list of aggregated compliance reports.
+    { # The aggregated compliance report.
+      "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+          "A String",
+        ],
+        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+        "failingControlIds": [ # The list of controls that are failing.
+          "A String",
+        ],
+        "failingControls": 42, # The number of controls that are failing.
+        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+          "A String",
+        ],
+        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+        "passingControlIds": [ # The list of controls that are passing or not assessed.
+          "A String",
+        ],
+        "passingControls": 42, # The number of controls that are passing or not assessed.
+      },
+      "reportTime": "A String", # The report time of the aggregated compliance report.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ fetch(name, endTime=None, filter=None, x__xgafv=None) +
Fetches the framework compliance report for a given scope.
+
+Args:
+  name: string, Required. The name of the framework compliance report to retrieve. (required)
+  endTime: string, Optional. The end time of the report.
+  filter: string, Optional. The filtering results.
+  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 FetchDbFrameworkComplianceReport.
+  "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+    "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+      "A String",
+    ],
+    "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+    "failingControlIds": [ # The list of controls that are failing.
+      "A String",
+    ],
+    "failingControls": 42, # The number of controls that are failing.
+    "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+      "A String",
+    ],
+    "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+    "passingControlIds": [ # The list of controls that are passing or not assessed.
+      "A String",
+    ],
+    "passingControls": 42, # The number of controls that are passing or not assessed.
+  },
+  "framework": "A String", # The name of the framework.
+  "frameworkCategories": [ # The list of framework categories supported.
+    "A String",
+  ],
+  "frameworkDescription": "A String", # The description of the framework.
+  "frameworkDisplayName": "A String", # Optional. The display name for the framework.
+  "frameworkType": "A String", # The type of the framework.
+  "majorRevisionId": "A String", # The latest major revision ID of the framework.
+  "minorRevisionId": "A String", # The latest minor revision ID of the latest major revision of the framework.
+  "name": "A String", # The name of the framework compliance report.
+  "supportedCloudProviders": [ # The list of cloud providers that are supported by the framework.
+    "A String",
+  ],
+  "targetResourceDetails": [ # The target resource details of the framework.
+    { # The details for a target resource.
+      "createTime": "A String", # The create time of the target resource.
+      "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
+      "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
+      "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
+      "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
+      "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
+      "updateTime": "A String", # The update time of the target resource.
+    },
+  ],
+  "updateTime": "A String", # Output only. The last updated time of the report.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1.folders.locations.dbFrameworkComplianceSummaries.html b/docs/dyn/assuredworkloads_v1.folders.locations.dbFrameworkComplianceSummaries.html new file mode 100644 index 0000000000..1bf989966b --- /dev/null +++ b/docs/dyn/assuredworkloads_v1.folders.locations.dbFrameworkComplianceSummaries.html @@ -0,0 +1,183 @@ + + + +

Assured Workloads API . folders . locations . dbFrameworkComplianceSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the framework compliance summary for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists the framework compliance summary for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.
+  view: string, Optional. Specifies the level of detail to return in the response.
+    Allowed values
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC - Includes basic compliance metadata, but omits trend data.
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL - Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days.
+  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 ListDbFrameworkComplianceSummariesResponse.
+  "dbFrameworkComplianceSummaries": [ # The list of framework compliance summaries.
+    { # The details for a framework compliance summary.
+      "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+          "A String",
+        ],
+        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+        "failingControlIds": [ # The list of controls that are failing.
+          "A String",
+        ],
+        "failingControls": 42, # The number of controls that are failing.
+        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+          "A String",
+        ],
+        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+        "passingControlIds": [ # The list of controls that are passing or not assessed.
+          "A String",
+        ],
+        "passingControls": 42, # The number of controls that are passing or not assessed.
+      },
+      "controlsPassingTrend": { # The trend of a compliance metric. # Output only. The trend of controls that are passing for the given duration.
+        "duration": "A String", # Output only. The duration for the trend.
+        "valuePercent": 3.14, # Output only. The trend value as a percentage. The value can be positive or negative.
+      },
+      "findingCount": "A String", # Output only. The count of the findings generated against the framework.
+      "framework": "A String", # The name of the framework.
+      "frameworkCategories": [ # The list of framework categories supported by the framework.
+        "A String",
+      ],
+      "frameworkDisplayName": "A String", # Optional. The display name for the framework.
+      "frameworkType": "A String", # The type of framework.
+      "majorRevisionId": "A String", # The major revision ID of the framework.
+      "minorRevisionId": "A String", # The minor revision ID of the framework.
+      "name": "A String", # Identifier. The name of the framework compliance summary.
+      "supportedCloudProviders": [ # The list of cloud providers supported by the framework.
+        "A String",
+      ],
+      "targetResourceDetails": [ # The target resource details for the framework.
+        { # The details for a target resource.
+          "createTime": "A String", # The create time of the target resource.
+          "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
+          "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
+          "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
+          "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
+          "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
+          "updateTime": "A String", # The update time of the target resource.
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1.folders.locations.html b/docs/dyn/assuredworkloads_v1.folders.locations.html index efe945a427..4a387f8c1d 100644 --- a/docs/dyn/assuredworkloads_v1.folders.locations.html +++ b/docs/dyn/assuredworkloads_v1.folders.locations.html @@ -79,6 +79,16 @@

Instance Methods

Returns the dbFindingSummaries Resource.

+

+ dbFrameworkComplianceReports() +

+

Returns the dbFrameworkComplianceReports Resource.

+ +

+ dbFrameworkComplianceSummaries() +

+

Returns the dbFrameworkComplianceSummaries Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/assuredworkloads_v1.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html b/docs/dyn/assuredworkloads_v1.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html new file mode 100644 index 0000000000..9db77360c1 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html @@ -0,0 +1,200 @@ + + + +

Assured Workloads API . organizations . locations . dbFrameworkComplianceReports . dbControlComplianceSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the control compliance summary for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the control compliance summary for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return.
+  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 ListDBControlComplianceSummaries.
+  "dbControlComplianceSummaries": [ # The list of control compliance details.
+    { # The details for control compliance.
+      "cloudControlReports": [ # The list of cloud control reports.
+        { # The cloud control report.
+          "categories": [ # The list of categories for the cloud control.
+            "A String",
+          ],
+          "cloudControl": "A String", # The name of the cloud control.
+          "cloudControlAssessmentDetails": { # The cloud control assessment details for non-manual cloud controls. # The details of a cloud control assessment.
+            "evaluationState": "A String", # Output only. The evaluation status of the cloud control.
+            "findingsCount": 42, # The number of findings for the cloud control.
+          },
+          "cloudControlDeployment": "A String", # The name of the cloud control deployment.
+          "cloudControlType": "A String", # The type of the cloud control.
+          "description": "A String", # The description of the cloud control.
+          "displayName": "A String", # The display name of the cloud control.
+          "enforcementMode": "A String", # The enforcement mode of the cloud control.
+          "findingCategory": "A String", # The category of the finding.
+          "findingSeverity": "A String", # The severity of the finding.
+          "frameworkMajorRevisionIds": [ # The major revision IDs of the frameworks that the cloud control belongs to.
+            "A String",
+          ],
+          "majorRevisionId": "A String", # The major revision ID of the cloud control.
+          "manualCloudControlAssessmentDetails": { # The details for a manual cloud control assessment. # The details of a manual cloud control assessment.
+            "manualCloudControlGuide": [ # The guide for assessing a cloud control manually.
+              "A String",
+            ],
+          },
+          "minorRevisionId": "A String", # The minor revision ID of the cloud control.
+          "rules": [ # The list of rules that correspond to the cloud control.
+            { # A rule in the cloud control.
+              "celExpression": { # A Common Expression Language (CEL) expression that's used to create a rule. # The rule's logic expression in Common Expression Language (CEL).
+                "expression": "A String", # Required. The logical expression in CEL. The maximum length of the condition is 1000 characters. For more information, see [CEL expression](https://cloud.google.com/security-command-center/docs/compliance-manager-write-cel-expressions).
+                "resourceTypesValues": { # A list of strings for the parameter value. # The resource instance types on which this expression is defined. The format is `/`. For example: `compute.googleapis.com/Instance`
+                  "values": [ # Required. The strings in the list.
+                    "A String",
+                  ],
+                },
+              },
+              "description": "A String", # Optional. The rule description. The maximum length is 2000 characters.
+              "ruleActionTypes": [ # Required. The functionality that's enabled by the rule.
+                "A String",
+              ],
+            },
+          ],
+          "similarControls": [ # The list of similar controls.
+            { # The similar controls.
+              "controlId": "A String", # The ID of the control.
+              "framework": "A String", # The name of the framework.
+            },
+          ],
+        },
+      ],
+      "complianceFrameworks": [ # The list of compliance frameworks that the control belongs to.
+        "A String",
+      ],
+      "control": "A String", # The name of the control.
+      "controlResponsibilityType": "A String", # The responsibility type for the control.
+      "description": "A String", # The description of the control.
+      "displayName": "A String", # The display name of the control.
+      "isFakeControl": True or False, # Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.
+      "name": "A String", # Identifier. The name of the control compliance summary.
+      "overallEvaluationState": "A String", # Output only. The overall evaluation status of the control.
+      "similarControls": [ # The list of similar controls.
+        { # The similar controls.
+          "controlId": "A String", # The ID of the control.
+          "framework": "A String", # The name of the framework.
+        },
+      ],
+      "totalFindingsCount": 42, # The total number of findings for the control.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1.organizations.locations.dbFrameworkComplianceReports.html b/docs/dyn/assuredworkloads_v1.organizations.locations.dbFrameworkComplianceReports.html new file mode 100644 index 0000000000..cf79e9a1fb --- /dev/null +++ b/docs/dyn/assuredworkloads_v1.organizations.locations.dbFrameworkComplianceReports.html @@ -0,0 +1,204 @@ + + + +

Assured Workloads API . organizations . locations . dbFrameworkComplianceReports

+

Instance Methods

+

+ dbControlComplianceSummaries() +

+

Returns the dbControlComplianceSummaries Resource.

+ +

+ aggregate(name, filter=None, interval_endTime=None, interval_startTime=None, x__xgafv=None)

+

Gets the aggregated compliance report over time for a given scope.

+

+ close()

+

Close httplib2 connections.

+

+ fetch(name, endTime=None, filter=None, x__xgafv=None)

+

Fetches the framework compliance report for a given scope.

+

Method Details

+
+ aggregate(name, filter=None, interval_endTime=None, interval_startTime=None, x__xgafv=None) +
Gets the aggregated compliance report over time for a given scope.
+
+Args:
+  name: string, Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` (required)
+  filter: string, Optional. The filtering results.
+  interval_endTime: string, Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+  interval_startTime: string, Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  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 AggregateDbFrameworkComplianceReport.
+  "aggregatedComplianceReports": [ # The list of aggregated compliance reports.
+    { # The aggregated compliance report.
+      "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+          "A String",
+        ],
+        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+        "failingControlIds": [ # The list of controls that are failing.
+          "A String",
+        ],
+        "failingControls": 42, # The number of controls that are failing.
+        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+          "A String",
+        ],
+        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+        "passingControlIds": [ # The list of controls that are passing or not assessed.
+          "A String",
+        ],
+        "passingControls": 42, # The number of controls that are passing or not assessed.
+      },
+      "reportTime": "A String", # The report time of the aggregated compliance report.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ fetch(name, endTime=None, filter=None, x__xgafv=None) +
Fetches the framework compliance report for a given scope.
+
+Args:
+  name: string, Required. The name of the framework compliance report to retrieve. (required)
+  endTime: string, Optional. The end time of the report.
+  filter: string, Optional. The filtering results.
+  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 FetchDbFrameworkComplianceReport.
+  "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+    "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+      "A String",
+    ],
+    "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+    "failingControlIds": [ # The list of controls that are failing.
+      "A String",
+    ],
+    "failingControls": 42, # The number of controls that are failing.
+    "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+      "A String",
+    ],
+    "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+    "passingControlIds": [ # The list of controls that are passing or not assessed.
+      "A String",
+    ],
+    "passingControls": 42, # The number of controls that are passing or not assessed.
+  },
+  "framework": "A String", # The name of the framework.
+  "frameworkCategories": [ # The list of framework categories supported.
+    "A String",
+  ],
+  "frameworkDescription": "A String", # The description of the framework.
+  "frameworkDisplayName": "A String", # Optional. The display name for the framework.
+  "frameworkType": "A String", # The type of the framework.
+  "majorRevisionId": "A String", # The latest major revision ID of the framework.
+  "minorRevisionId": "A String", # The latest minor revision ID of the latest major revision of the framework.
+  "name": "A String", # The name of the framework compliance report.
+  "supportedCloudProviders": [ # The list of cloud providers that are supported by the framework.
+    "A String",
+  ],
+  "targetResourceDetails": [ # The target resource details of the framework.
+    { # The details for a target resource.
+      "createTime": "A String", # The create time of the target resource.
+      "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
+      "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
+      "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
+      "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
+      "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
+      "updateTime": "A String", # The update time of the target resource.
+    },
+  ],
+  "updateTime": "A String", # Output only. The last updated time of the report.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1.organizations.locations.dbFrameworkComplianceSummaries.html b/docs/dyn/assuredworkloads_v1.organizations.locations.dbFrameworkComplianceSummaries.html new file mode 100644 index 0000000000..096ea3ba9c --- /dev/null +++ b/docs/dyn/assuredworkloads_v1.organizations.locations.dbFrameworkComplianceSummaries.html @@ -0,0 +1,183 @@ + + + +

Assured Workloads API . organizations . locations . dbFrameworkComplianceSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the framework compliance summary for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists the framework compliance summary for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.
+  view: string, Optional. Specifies the level of detail to return in the response.
+    Allowed values
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC - Includes basic compliance metadata, but omits trend data.
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL - Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days.
+  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 ListDbFrameworkComplianceSummariesResponse.
+  "dbFrameworkComplianceSummaries": [ # The list of framework compliance summaries.
+    { # The details for a framework compliance summary.
+      "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+          "A String",
+        ],
+        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+        "failingControlIds": [ # The list of controls that are failing.
+          "A String",
+        ],
+        "failingControls": 42, # The number of controls that are failing.
+        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+          "A String",
+        ],
+        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+        "passingControlIds": [ # The list of controls that are passing or not assessed.
+          "A String",
+        ],
+        "passingControls": 42, # The number of controls that are passing or not assessed.
+      },
+      "controlsPassingTrend": { # The trend of a compliance metric. # Output only. The trend of controls that are passing for the given duration.
+        "duration": "A String", # Output only. The duration for the trend.
+        "valuePercent": 3.14, # Output only. The trend value as a percentage. The value can be positive or negative.
+      },
+      "findingCount": "A String", # Output only. The count of the findings generated against the framework.
+      "framework": "A String", # The name of the framework.
+      "frameworkCategories": [ # The list of framework categories supported by the framework.
+        "A String",
+      ],
+      "frameworkDisplayName": "A String", # Optional. The display name for the framework.
+      "frameworkType": "A String", # The type of framework.
+      "majorRevisionId": "A String", # The major revision ID of the framework.
+      "minorRevisionId": "A String", # The minor revision ID of the framework.
+      "name": "A String", # Identifier. The name of the framework compliance summary.
+      "supportedCloudProviders": [ # The list of cloud providers supported by the framework.
+        "A String",
+      ],
+      "targetResourceDetails": [ # The target resource details for the framework.
+        { # The details for a target resource.
+          "createTime": "A String", # The create time of the target resource.
+          "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
+          "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
+          "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
+          "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
+          "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
+          "updateTime": "A String", # The update time of the target resource.
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1.organizations.locations.html b/docs/dyn/assuredworkloads_v1.organizations.locations.html index ced3fa8807..409ff9f45c 100644 --- a/docs/dyn/assuredworkloads_v1.organizations.locations.html +++ b/docs/dyn/assuredworkloads_v1.organizations.locations.html @@ -79,6 +79,16 @@

Instance Methods

Returns the dbFindingSummaries Resource.

+

+ dbFrameworkComplianceReports() +

+

Returns the dbFrameworkComplianceReports Resource.

+ +

+ dbFrameworkComplianceSummaries() +

+

Returns the dbFrameworkComplianceSummaries Resource.

+

operations()

diff --git a/docs/dyn/assuredworkloads_v1.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html b/docs/dyn/assuredworkloads_v1.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html new file mode 100644 index 0000000000..1d8e7eb0f6 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html @@ -0,0 +1,200 @@ + + + +

Assured Workloads API . projects . locations . dbFrameworkComplianceReports . dbControlComplianceSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the control compliance summary for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the control compliance summary for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return.
+  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 ListDBControlComplianceSummaries.
+  "dbControlComplianceSummaries": [ # The list of control compliance details.
+    { # The details for control compliance.
+      "cloudControlReports": [ # The list of cloud control reports.
+        { # The cloud control report.
+          "categories": [ # The list of categories for the cloud control.
+            "A String",
+          ],
+          "cloudControl": "A String", # The name of the cloud control.
+          "cloudControlAssessmentDetails": { # The cloud control assessment details for non-manual cloud controls. # The details of a cloud control assessment.
+            "evaluationState": "A String", # Output only. The evaluation status of the cloud control.
+            "findingsCount": 42, # The number of findings for the cloud control.
+          },
+          "cloudControlDeployment": "A String", # The name of the cloud control deployment.
+          "cloudControlType": "A String", # The type of the cloud control.
+          "description": "A String", # The description of the cloud control.
+          "displayName": "A String", # The display name of the cloud control.
+          "enforcementMode": "A String", # The enforcement mode of the cloud control.
+          "findingCategory": "A String", # The category of the finding.
+          "findingSeverity": "A String", # The severity of the finding.
+          "frameworkMajorRevisionIds": [ # The major revision IDs of the frameworks that the cloud control belongs to.
+            "A String",
+          ],
+          "majorRevisionId": "A String", # The major revision ID of the cloud control.
+          "manualCloudControlAssessmentDetails": { # The details for a manual cloud control assessment. # The details of a manual cloud control assessment.
+            "manualCloudControlGuide": [ # The guide for assessing a cloud control manually.
+              "A String",
+            ],
+          },
+          "minorRevisionId": "A String", # The minor revision ID of the cloud control.
+          "rules": [ # The list of rules that correspond to the cloud control.
+            { # A rule in the cloud control.
+              "celExpression": { # A Common Expression Language (CEL) expression that's used to create a rule. # The rule's logic expression in Common Expression Language (CEL).
+                "expression": "A String", # Required. The logical expression in CEL. The maximum length of the condition is 1000 characters. For more information, see [CEL expression](https://cloud.google.com/security-command-center/docs/compliance-manager-write-cel-expressions).
+                "resourceTypesValues": { # A list of strings for the parameter value. # The resource instance types on which this expression is defined. The format is `/`. For example: `compute.googleapis.com/Instance`
+                  "values": [ # Required. The strings in the list.
+                    "A String",
+                  ],
+                },
+              },
+              "description": "A String", # Optional. The rule description. The maximum length is 2000 characters.
+              "ruleActionTypes": [ # Required. The functionality that's enabled by the rule.
+                "A String",
+              ],
+            },
+          ],
+          "similarControls": [ # The list of similar controls.
+            { # The similar controls.
+              "controlId": "A String", # The ID of the control.
+              "framework": "A String", # The name of the framework.
+            },
+          ],
+        },
+      ],
+      "complianceFrameworks": [ # The list of compliance frameworks that the control belongs to.
+        "A String",
+      ],
+      "control": "A String", # The name of the control.
+      "controlResponsibilityType": "A String", # The responsibility type for the control.
+      "description": "A String", # The description of the control.
+      "displayName": "A String", # The display name of the control.
+      "isFakeControl": True or False, # Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.
+      "name": "A String", # Identifier. The name of the control compliance summary.
+      "overallEvaluationState": "A String", # Output only. The overall evaluation status of the control.
+      "similarControls": [ # The list of similar controls.
+        { # The similar controls.
+          "controlId": "A String", # The ID of the control.
+          "framework": "A String", # The name of the framework.
+        },
+      ],
+      "totalFindingsCount": 42, # The total number of findings for the control.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1.projects.locations.dbFrameworkComplianceReports.html b/docs/dyn/assuredworkloads_v1.projects.locations.dbFrameworkComplianceReports.html new file mode 100644 index 0000000000..6a2a2fd97a --- /dev/null +++ b/docs/dyn/assuredworkloads_v1.projects.locations.dbFrameworkComplianceReports.html @@ -0,0 +1,204 @@ + + + +

Assured Workloads API . projects . locations . dbFrameworkComplianceReports

+

Instance Methods

+

+ dbControlComplianceSummaries() +

+

Returns the dbControlComplianceSummaries Resource.

+ +

+ aggregate(name, filter=None, interval_endTime=None, interval_startTime=None, x__xgafv=None)

+

Gets the aggregated compliance report over time for a given scope.

+

+ close()

+

Close httplib2 connections.

+

+ fetch(name, endTime=None, filter=None, x__xgafv=None)

+

Fetches the framework compliance report for a given scope.

+

Method Details

+
+ aggregate(name, filter=None, interval_endTime=None, interval_startTime=None, x__xgafv=None) +
Gets the aggregated compliance report over time for a given scope.
+
+Args:
+  name: string, Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` (required)
+  filter: string, Optional. The filtering results.
+  interval_endTime: string, Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+  interval_startTime: string, Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  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 AggregateDbFrameworkComplianceReport.
+  "aggregatedComplianceReports": [ # The list of aggregated compliance reports.
+    { # The aggregated compliance report.
+      "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+          "A String",
+        ],
+        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+        "failingControlIds": [ # The list of controls that are failing.
+          "A String",
+        ],
+        "failingControls": 42, # The number of controls that are failing.
+        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+          "A String",
+        ],
+        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+        "passingControlIds": [ # The list of controls that are passing or not assessed.
+          "A String",
+        ],
+        "passingControls": 42, # The number of controls that are passing or not assessed.
+      },
+      "reportTime": "A String", # The report time of the aggregated compliance report.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ fetch(name, endTime=None, filter=None, x__xgafv=None) +
Fetches the framework compliance report for a given scope.
+
+Args:
+  name: string, Required. The name of the framework compliance report to retrieve. (required)
+  endTime: string, Optional. The end time of the report.
+  filter: string, Optional. The filtering results.
+  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 FetchDbFrameworkComplianceReport.
+  "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+    "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+      "A String",
+    ],
+    "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+    "failingControlIds": [ # The list of controls that are failing.
+      "A String",
+    ],
+    "failingControls": 42, # The number of controls that are failing.
+    "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+      "A String",
+    ],
+    "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+    "passingControlIds": [ # The list of controls that are passing or not assessed.
+      "A String",
+    ],
+    "passingControls": 42, # The number of controls that are passing or not assessed.
+  },
+  "framework": "A String", # The name of the framework.
+  "frameworkCategories": [ # The list of framework categories supported.
+    "A String",
+  ],
+  "frameworkDescription": "A String", # The description of the framework.
+  "frameworkDisplayName": "A String", # Optional. The display name for the framework.
+  "frameworkType": "A String", # The type of the framework.
+  "majorRevisionId": "A String", # The latest major revision ID of the framework.
+  "minorRevisionId": "A String", # The latest minor revision ID of the latest major revision of the framework.
+  "name": "A String", # The name of the framework compliance report.
+  "supportedCloudProviders": [ # The list of cloud providers that are supported by the framework.
+    "A String",
+  ],
+  "targetResourceDetails": [ # The target resource details of the framework.
+    { # The details for a target resource.
+      "createTime": "A String", # The create time of the target resource.
+      "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
+      "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
+      "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
+      "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
+      "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
+      "updateTime": "A String", # The update time of the target resource.
+    },
+  ],
+  "updateTime": "A String", # Output only. The last updated time of the report.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1.projects.locations.dbFrameworkComplianceSummaries.html b/docs/dyn/assuredworkloads_v1.projects.locations.dbFrameworkComplianceSummaries.html new file mode 100644 index 0000000000..997e08671e --- /dev/null +++ b/docs/dyn/assuredworkloads_v1.projects.locations.dbFrameworkComplianceSummaries.html @@ -0,0 +1,183 @@ + + + +

Assured Workloads API . projects . locations . dbFrameworkComplianceSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the framework compliance summary for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists the framework compliance summary for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.
+  view: string, Optional. Specifies the level of detail to return in the response.
+    Allowed values
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC - Includes basic compliance metadata, but omits trend data.
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL - Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days.
+  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 ListDbFrameworkComplianceSummariesResponse.
+  "dbFrameworkComplianceSummaries": [ # The list of framework compliance summaries.
+    { # The details for a framework compliance summary.
+      "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+          "A String",
+        ],
+        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+        "failingControlIds": [ # The list of controls that are failing.
+          "A String",
+        ],
+        "failingControls": 42, # The number of controls that are failing.
+        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+          "A String",
+        ],
+        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+        "passingControlIds": [ # The list of controls that are passing or not assessed.
+          "A String",
+        ],
+        "passingControls": 42, # The number of controls that are passing or not assessed.
+      },
+      "controlsPassingTrend": { # The trend of a compliance metric. # Output only. The trend of controls that are passing for the given duration.
+        "duration": "A String", # Output only. The duration for the trend.
+        "valuePercent": 3.14, # Output only. The trend value as a percentage. The value can be positive or negative.
+      },
+      "findingCount": "A String", # Output only. The count of the findings generated against the framework.
+      "framework": "A String", # The name of the framework.
+      "frameworkCategories": [ # The list of framework categories supported by the framework.
+        "A String",
+      ],
+      "frameworkDisplayName": "A String", # Optional. The display name for the framework.
+      "frameworkType": "A String", # The type of framework.
+      "majorRevisionId": "A String", # The major revision ID of the framework.
+      "minorRevisionId": "A String", # The minor revision ID of the framework.
+      "name": "A String", # Identifier. The name of the framework compliance summary.
+      "supportedCloudProviders": [ # The list of cloud providers supported by the framework.
+        "A String",
+      ],
+      "targetResourceDetails": [ # The target resource details for the framework.
+        { # The details for a target resource.
+          "createTime": "A String", # The create time of the target resource.
+          "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
+          "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
+          "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
+          "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
+          "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
+          "updateTime": "A String", # The update time of the target resource.
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1.projects.locations.html b/docs/dyn/assuredworkloads_v1.projects.locations.html index 5f479827ef..761e295de1 100644 --- a/docs/dyn/assuredworkloads_v1.projects.locations.html +++ b/docs/dyn/assuredworkloads_v1.projects.locations.html @@ -79,6 +79,16 @@

Instance Methods

Returns the dbFindingSummaries Resource.

+

+ dbFrameworkComplianceReports() +

+

Returns the dbFrameworkComplianceReports Resource.

+ +

+ dbFrameworkComplianceSummaries() +

+

Returns the dbFrameworkComplianceSummaries Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/assuredworkloads_v1beta1.folders.html b/docs/dyn/assuredworkloads_v1beta1.folders.html new file mode 100644 index 0000000000..842fa83da2 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.folders.html @@ -0,0 +1,91 @@ + + + +

Assured Workloads API . folders

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFindingSummaries.html b/docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFindingSummaries.html new file mode 100644 index 0000000000..30b5d202ce --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFindingSummaries.html @@ -0,0 +1,141 @@ + + + +

Assured Workloads API . folders . locations . dbFindingSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the finding summary by category for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the finding summary by category for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return.
+  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 ListDbFindingSummaries.
+  "dbFindingSummaries": [ # List of finding summary by category.
+    { # The details for a finding.
+      "findingCategory": "A String", # Output only. The category of the finding.
+      "findingClass": "A String", # Output only. The class of the finding.
+      "findingCount": "A String", # Output only. The count of the finding.
+      "name": "A String", # Identifier. The name of the finding summary.
+      "relatedFrameworks": [ # Optional. The list of compliance frameworks that the finding belongs to.
+        "A String",
+      ],
+      "severity": "A String", # Output only. The severity of the finding.
+      "updateTime": "A String", # Output only. The last updated time of the finding.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html b/docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html new file mode 100644 index 0000000000..ca7f6fc421 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html @@ -0,0 +1,200 @@ + + + +

Assured Workloads API . folders . locations . dbFrameworkComplianceReports . dbControlComplianceSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the control compliance summary for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the control compliance summary for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return.
+  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 ListDBControlComplianceSummaries.
+  "dbControlComplianceSummaries": [ # The list of control compliance details.
+    { # The details for control compliance.
+      "cloudControlReports": [ # The list of cloud control reports.
+        { # The cloud control report.
+          "categories": [ # The list of categories for the cloud control.
+            "A String",
+          ],
+          "cloudControl": "A String", # The name of the cloud control.
+          "cloudControlAssessmentDetails": { # The cloud control assessment details for non-manual cloud controls. # The details of a cloud control assessment.
+            "evaluationState": "A String", # Output only. The evaluation status of the cloud control.
+            "findingsCount": 42, # The number of findings for the cloud control.
+          },
+          "cloudControlDeployment": "A String", # The name of the cloud control deployment.
+          "cloudControlType": "A String", # The type of the cloud control.
+          "description": "A String", # The description of the cloud control.
+          "displayName": "A String", # The display name of the cloud control.
+          "enforcementMode": "A String", # The enforcement mode of the cloud control.
+          "findingCategory": "A String", # The category of the finding.
+          "findingSeverity": "A String", # The severity of the finding.
+          "frameworkMajorRevisionIds": [ # The major revision IDs of the frameworks that the cloud control belongs to.
+            "A String",
+          ],
+          "majorRevisionId": "A String", # The major revision ID of the cloud control.
+          "manualCloudControlAssessmentDetails": { # The details for a manual cloud control assessment. # The details of a manual cloud control assessment.
+            "manualCloudControlGuide": [ # The guide for assessing a cloud control manually.
+              "A String",
+            ],
+          },
+          "minorRevisionId": "A String", # The minor revision ID of the cloud control.
+          "rules": [ # The list of rules that correspond to the cloud control.
+            { # A rule in the cloud control.
+              "celExpression": { # A Common Expression Language (CEL) expression that's used to create a rule. # The rule's logic expression in Common Expression Language (CEL).
+                "expression": "A String", # Required. The logical expression in CEL. The maximum length of the condition is 1000 characters. For more information, see [CEL expression](https://cloud.google.com/security-command-center/docs/compliance-manager-write-cel-expressions).
+                "resourceTypesValues": { # A list of strings for the parameter value. # The resource instance types on which this expression is defined. The format is `/`. For example: `compute.googleapis.com/Instance`
+                  "values": [ # Required. The strings in the list.
+                    "A String",
+                  ],
+                },
+              },
+              "description": "A String", # Optional. The rule description. The maximum length is 2000 characters.
+              "ruleActionTypes": [ # Required. The functionality that's enabled by the rule.
+                "A String",
+              ],
+            },
+          ],
+          "similarControls": [ # The list of similar controls.
+            { # The similar controls.
+              "controlId": "A String", # The ID of the control.
+              "framework": "A String", # The name of the framework.
+            },
+          ],
+        },
+      ],
+      "complianceFrameworks": [ # The list of compliance frameworks that the control belongs to.
+        "A String",
+      ],
+      "control": "A String", # The name of the control.
+      "controlResponsibilityType": "A String", # The responsibility type for the control.
+      "description": "A String", # The description of the control.
+      "displayName": "A String", # The display name of the control.
+      "isFakeControl": True or False, # Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.
+      "name": "A String", # Identifier. The name of the control compliance summary.
+      "overallEvaluationState": "A String", # Output only. The overall evaluation status of the control.
+      "similarControls": [ # The list of similar controls.
+        { # The similar controls.
+          "controlId": "A String", # The ID of the control.
+          "framework": "A String", # The name of the framework.
+        },
+      ],
+      "totalFindingsCount": 42, # The total number of findings for the control.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFrameworkComplianceReports.html b/docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFrameworkComplianceReports.html new file mode 100644 index 0000000000..e915af25a6 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFrameworkComplianceReports.html @@ -0,0 +1,204 @@ + + + +

Assured Workloads API . folders . locations . dbFrameworkComplianceReports

+

Instance Methods

+

+ dbControlComplianceSummaries() +

+

Returns the dbControlComplianceSummaries Resource.

+ +

+ aggregate(name, filter=None, interval_endTime=None, interval_startTime=None, x__xgafv=None)

+

Gets the aggregated compliance report over time for a given scope.

+

+ close()

+

Close httplib2 connections.

+

+ fetch(name, endTime=None, filter=None, x__xgafv=None)

+

Fetches the framework compliance report for a given scope.

+

Method Details

+
+ aggregate(name, filter=None, interval_endTime=None, interval_startTime=None, x__xgafv=None) +
Gets the aggregated compliance report over time for a given scope.
+
+Args:
+  name: string, Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` (required)
+  filter: string, Optional. The filtering results.
+  interval_endTime: string, Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+  interval_startTime: string, Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  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 AggregateDbFrameworkComplianceReport.
+  "aggregatedComplianceReports": [ # The list of aggregated compliance reports.
+    { # The aggregated compliance report.
+      "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+          "A String",
+        ],
+        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+        "failingControlIds": [ # The list of controls that are failing.
+          "A String",
+        ],
+        "failingControls": 42, # The number of controls that are failing.
+        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+          "A String",
+        ],
+        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+        "passingControlIds": [ # The list of controls that are passing or not assessed.
+          "A String",
+        ],
+        "passingControls": 42, # The number of controls that are passing or not assessed.
+      },
+      "reportTime": "A String", # The report time of the aggregated compliance report.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ fetch(name, endTime=None, filter=None, x__xgafv=None) +
Fetches the framework compliance report for a given scope.
+
+Args:
+  name: string, Required. The name of the framework compliance report to retrieve. (required)
+  endTime: string, Optional. The end time of the report.
+  filter: string, Optional. The filtering results.
+  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 FetchDbFrameworkComplianceReport.
+  "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+    "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+      "A String",
+    ],
+    "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+    "failingControlIds": [ # The list of controls that are failing.
+      "A String",
+    ],
+    "failingControls": 42, # The number of controls that are failing.
+    "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+      "A String",
+    ],
+    "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+    "passingControlIds": [ # The list of controls that are passing or not assessed.
+      "A String",
+    ],
+    "passingControls": 42, # The number of controls that are passing or not assessed.
+  },
+  "framework": "A String", # The name of the framework.
+  "frameworkCategories": [ # The list of framework categories supported.
+    "A String",
+  ],
+  "frameworkDescription": "A String", # The description of the framework.
+  "frameworkDisplayName": "A String", # Optional. The display name for the framework.
+  "frameworkType": "A String", # The type of the framework.
+  "majorRevisionId": "A String", # The latest major revision ID of the framework.
+  "minorRevisionId": "A String", # The latest minor revision ID of the latest major revision of the framework.
+  "name": "A String", # The name of the framework compliance report.
+  "supportedCloudProviders": [ # The list of cloud providers that are supported by the framework.
+    "A String",
+  ],
+  "targetResourceDetails": [ # The target resource details of the framework.
+    { # The details for a target resource.
+      "createTime": "A String", # The create time of the target resource.
+      "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
+      "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
+      "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
+      "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
+      "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
+      "updateTime": "A String", # The update time of the target resource.
+    },
+  ],
+  "updateTime": "A String", # Output only. The last updated time of the report.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFrameworkComplianceSummaries.html b/docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFrameworkComplianceSummaries.html new file mode 100644 index 0000000000..0ade7cd1b1 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.folders.locations.dbFrameworkComplianceSummaries.html @@ -0,0 +1,183 @@ + + + +

Assured Workloads API . folders . locations . dbFrameworkComplianceSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the framework compliance summary for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists the framework compliance summary for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.
+  view: string, Optional. Specifies the level of detail to return in the response.
+    Allowed values
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC - Includes basic compliance metadata, but omits trend data.
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL - Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days.
+  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 ListDbFrameworkComplianceSummariesResponse.
+  "dbFrameworkComplianceSummaries": [ # The list of framework compliance summaries.
+    { # The details for a framework compliance summary.
+      "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+          "A String",
+        ],
+        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+        "failingControlIds": [ # The list of controls that are failing.
+          "A String",
+        ],
+        "failingControls": 42, # The number of controls that are failing.
+        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+          "A String",
+        ],
+        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+        "passingControlIds": [ # The list of controls that are passing or not assessed.
+          "A String",
+        ],
+        "passingControls": 42, # The number of controls that are passing or not assessed.
+      },
+      "controlsPassingTrend": { # The trend of a compliance metric. # Output only. The trend of controls that are passing for the given duration.
+        "duration": "A String", # Output only. The duration for the trend.
+        "valuePercent": 3.14, # Output only. The trend value as a percentage. The value can be positive or negative.
+      },
+      "findingCount": "A String", # Output only. The count of the findings generated against the framework.
+      "framework": "A String", # The name of the framework.
+      "frameworkCategories": [ # The list of framework categories supported by the framework.
+        "A String",
+      ],
+      "frameworkDisplayName": "A String", # Optional. The display name for the framework.
+      "frameworkType": "A String", # The type of framework.
+      "majorRevisionId": "A String", # The major revision ID of the framework.
+      "minorRevisionId": "A String", # The minor revision ID of the framework.
+      "name": "A String", # Identifier. The name of the framework compliance summary.
+      "supportedCloudProviders": [ # The list of cloud providers supported by the framework.
+        "A String",
+      ],
+      "targetResourceDetails": [ # The target resource details for the framework.
+        { # The details for a target resource.
+          "createTime": "A String", # The create time of the target resource.
+          "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
+          "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
+          "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
+          "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
+          "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
+          "updateTime": "A String", # The update time of the target resource.
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.folders.locations.html b/docs/dyn/assuredworkloads_v1beta1.folders.locations.html new file mode 100644 index 0000000000..a1ca768fa3 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.folders.locations.html @@ -0,0 +1,101 @@ + + + +

Assured Workloads API . folders . locations

+

Instance Methods

+

+ dbFindingSummaries() +

+

Returns the dbFindingSummaries Resource.

+ +

+ dbFrameworkComplianceReports() +

+

Returns the dbFrameworkComplianceReports Resource.

+ +

+ dbFrameworkComplianceSummaries() +

+

Returns the dbFrameworkComplianceSummaries Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.html b/docs/dyn/assuredworkloads_v1beta1.html index 4a60071fa8..4d92b2d6a6 100644 --- a/docs/dyn/assuredworkloads_v1beta1.html +++ b/docs/dyn/assuredworkloads_v1beta1.html @@ -79,11 +79,21 @@

Instance Methods

Returns the assuredworkloads Resource.

+

+ folders() +

+

Returns the folders Resource.

+

organizations()

Returns the organizations Resource.

+

+ projects() +

+

Returns the projects Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFindingSummaries.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFindingSummaries.html new file mode 100644 index 0000000000..8a1c0e6272 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFindingSummaries.html @@ -0,0 +1,141 @@ + + + +

Assured Workloads API . organizations . locations . dbFindingSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the finding summary by category for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the finding summary by category for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return.
+  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 ListDbFindingSummaries.
+  "dbFindingSummaries": [ # List of finding summary by category.
+    { # The details for a finding.
+      "findingCategory": "A String", # Output only. The category of the finding.
+      "findingClass": "A String", # Output only. The class of the finding.
+      "findingCount": "A String", # Output only. The count of the finding.
+      "name": "A String", # Identifier. The name of the finding summary.
+      "relatedFrameworks": [ # Optional. The list of compliance frameworks that the finding belongs to.
+        "A String",
+      ],
+      "severity": "A String", # Output only. The severity of the finding.
+      "updateTime": "A String", # Output only. The last updated time of the finding.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html new file mode 100644 index 0000000000..d1d03b9e0b --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html @@ -0,0 +1,200 @@ + + + +

Assured Workloads API . organizations . locations . dbFrameworkComplianceReports . dbControlComplianceSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the control compliance summary for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the control compliance summary for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return.
+  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 ListDBControlComplianceSummaries.
+  "dbControlComplianceSummaries": [ # The list of control compliance details.
+    { # The details for control compliance.
+      "cloudControlReports": [ # The list of cloud control reports.
+        { # The cloud control report.
+          "categories": [ # The list of categories for the cloud control.
+            "A String",
+          ],
+          "cloudControl": "A String", # The name of the cloud control.
+          "cloudControlAssessmentDetails": { # The cloud control assessment details for non-manual cloud controls. # The details of a cloud control assessment.
+            "evaluationState": "A String", # Output only. The evaluation status of the cloud control.
+            "findingsCount": 42, # The number of findings for the cloud control.
+          },
+          "cloudControlDeployment": "A String", # The name of the cloud control deployment.
+          "cloudControlType": "A String", # The type of the cloud control.
+          "description": "A String", # The description of the cloud control.
+          "displayName": "A String", # The display name of the cloud control.
+          "enforcementMode": "A String", # The enforcement mode of the cloud control.
+          "findingCategory": "A String", # The category of the finding.
+          "findingSeverity": "A String", # The severity of the finding.
+          "frameworkMajorRevisionIds": [ # The major revision IDs of the frameworks that the cloud control belongs to.
+            "A String",
+          ],
+          "majorRevisionId": "A String", # The major revision ID of the cloud control.
+          "manualCloudControlAssessmentDetails": { # The details for a manual cloud control assessment. # The details of a manual cloud control assessment.
+            "manualCloudControlGuide": [ # The guide for assessing a cloud control manually.
+              "A String",
+            ],
+          },
+          "minorRevisionId": "A String", # The minor revision ID of the cloud control.
+          "rules": [ # The list of rules that correspond to the cloud control.
+            { # A rule in the cloud control.
+              "celExpression": { # A Common Expression Language (CEL) expression that's used to create a rule. # The rule's logic expression in Common Expression Language (CEL).
+                "expression": "A String", # Required. The logical expression in CEL. The maximum length of the condition is 1000 characters. For more information, see [CEL expression](https://cloud.google.com/security-command-center/docs/compliance-manager-write-cel-expressions).
+                "resourceTypesValues": { # A list of strings for the parameter value. # The resource instance types on which this expression is defined. The format is `/`. For example: `compute.googleapis.com/Instance`
+                  "values": [ # Required. The strings in the list.
+                    "A String",
+                  ],
+                },
+              },
+              "description": "A String", # Optional. The rule description. The maximum length is 2000 characters.
+              "ruleActionTypes": [ # Required. The functionality that's enabled by the rule.
+                "A String",
+              ],
+            },
+          ],
+          "similarControls": [ # The list of similar controls.
+            { # The similar controls.
+              "controlId": "A String", # The ID of the control.
+              "framework": "A String", # The name of the framework.
+            },
+          ],
+        },
+      ],
+      "complianceFrameworks": [ # The list of compliance frameworks that the control belongs to.
+        "A String",
+      ],
+      "control": "A String", # The name of the control.
+      "controlResponsibilityType": "A String", # The responsibility type for the control.
+      "description": "A String", # The description of the control.
+      "displayName": "A String", # The display name of the control.
+      "isFakeControl": True or False, # Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.
+      "name": "A String", # Identifier. The name of the control compliance summary.
+      "overallEvaluationState": "A String", # Output only. The overall evaluation status of the control.
+      "similarControls": [ # The list of similar controls.
+        { # The similar controls.
+          "controlId": "A String", # The ID of the control.
+          "framework": "A String", # The name of the framework.
+        },
+      ],
+      "totalFindingsCount": 42, # The total number of findings for the control.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFrameworkComplianceReports.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFrameworkComplianceReports.html new file mode 100644 index 0000000000..0de86bb011 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFrameworkComplianceReports.html @@ -0,0 +1,204 @@ + + + +

Assured Workloads API . organizations . locations . dbFrameworkComplianceReports

+

Instance Methods

+

+ dbControlComplianceSummaries() +

+

Returns the dbControlComplianceSummaries Resource.

+ +

+ aggregate(name, filter=None, interval_endTime=None, interval_startTime=None, x__xgafv=None)

+

Gets the aggregated compliance report over time for a given scope.

+

+ close()

+

Close httplib2 connections.

+

+ fetch(name, endTime=None, filter=None, x__xgafv=None)

+

Fetches the framework compliance report for a given scope.

+

Method Details

+
+ aggregate(name, filter=None, interval_endTime=None, interval_startTime=None, x__xgafv=None) +
Gets the aggregated compliance report over time for a given scope.
+
+Args:
+  name: string, Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` (required)
+  filter: string, Optional. The filtering results.
+  interval_endTime: string, Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+  interval_startTime: string, Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  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 AggregateDbFrameworkComplianceReport.
+  "aggregatedComplianceReports": [ # The list of aggregated compliance reports.
+    { # The aggregated compliance report.
+      "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+          "A String",
+        ],
+        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+        "failingControlIds": [ # The list of controls that are failing.
+          "A String",
+        ],
+        "failingControls": 42, # The number of controls that are failing.
+        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+          "A String",
+        ],
+        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+        "passingControlIds": [ # The list of controls that are passing or not assessed.
+          "A String",
+        ],
+        "passingControls": 42, # The number of controls that are passing or not assessed.
+      },
+      "reportTime": "A String", # The report time of the aggregated compliance report.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ fetch(name, endTime=None, filter=None, x__xgafv=None) +
Fetches the framework compliance report for a given scope.
+
+Args:
+  name: string, Required. The name of the framework compliance report to retrieve. (required)
+  endTime: string, Optional. The end time of the report.
+  filter: string, Optional. The filtering results.
+  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 FetchDbFrameworkComplianceReport.
+  "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+    "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+      "A String",
+    ],
+    "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+    "failingControlIds": [ # The list of controls that are failing.
+      "A String",
+    ],
+    "failingControls": 42, # The number of controls that are failing.
+    "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+      "A String",
+    ],
+    "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+    "passingControlIds": [ # The list of controls that are passing or not assessed.
+      "A String",
+    ],
+    "passingControls": 42, # The number of controls that are passing or not assessed.
+  },
+  "framework": "A String", # The name of the framework.
+  "frameworkCategories": [ # The list of framework categories supported.
+    "A String",
+  ],
+  "frameworkDescription": "A String", # The description of the framework.
+  "frameworkDisplayName": "A String", # Optional. The display name for the framework.
+  "frameworkType": "A String", # The type of the framework.
+  "majorRevisionId": "A String", # The latest major revision ID of the framework.
+  "minorRevisionId": "A String", # The latest minor revision ID of the latest major revision of the framework.
+  "name": "A String", # The name of the framework compliance report.
+  "supportedCloudProviders": [ # The list of cloud providers that are supported by the framework.
+    "A String",
+  ],
+  "targetResourceDetails": [ # The target resource details of the framework.
+    { # The details for a target resource.
+      "createTime": "A String", # The create time of the target resource.
+      "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
+      "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
+      "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
+      "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
+      "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
+      "updateTime": "A String", # The update time of the target resource.
+    },
+  ],
+  "updateTime": "A String", # Output only. The last updated time of the report.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFrameworkComplianceSummaries.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFrameworkComplianceSummaries.html new file mode 100644 index 0000000000..f88df0df09 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.dbFrameworkComplianceSummaries.html @@ -0,0 +1,183 @@ + + + +

Assured Workloads API . organizations . locations . dbFrameworkComplianceSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the framework compliance summary for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists the framework compliance summary for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.
+  view: string, Optional. Specifies the level of detail to return in the response.
+    Allowed values
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC - Includes basic compliance metadata, but omits trend data.
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL - Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days.
+  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 ListDbFrameworkComplianceSummariesResponse.
+  "dbFrameworkComplianceSummaries": [ # The list of framework compliance summaries.
+    { # The details for a framework compliance summary.
+      "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+          "A String",
+        ],
+        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+        "failingControlIds": [ # The list of controls that are failing.
+          "A String",
+        ],
+        "failingControls": 42, # The number of controls that are failing.
+        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+          "A String",
+        ],
+        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+        "passingControlIds": [ # The list of controls that are passing or not assessed.
+          "A String",
+        ],
+        "passingControls": 42, # The number of controls that are passing or not assessed.
+      },
+      "controlsPassingTrend": { # The trend of a compliance metric. # Output only. The trend of controls that are passing for the given duration.
+        "duration": "A String", # Output only. The duration for the trend.
+        "valuePercent": 3.14, # Output only. The trend value as a percentage. The value can be positive or negative.
+      },
+      "findingCount": "A String", # Output only. The count of the findings generated against the framework.
+      "framework": "A String", # The name of the framework.
+      "frameworkCategories": [ # The list of framework categories supported by the framework.
+        "A String",
+      ],
+      "frameworkDisplayName": "A String", # Optional. The display name for the framework.
+      "frameworkType": "A String", # The type of framework.
+      "majorRevisionId": "A String", # The major revision ID of the framework.
+      "minorRevisionId": "A String", # The minor revision ID of the framework.
+      "name": "A String", # Identifier. The name of the framework compliance summary.
+      "supportedCloudProviders": [ # The list of cloud providers supported by the framework.
+        "A String",
+      ],
+      "targetResourceDetails": [ # The target resource details for the framework.
+        { # The details for a target resource.
+          "createTime": "A String", # The create time of the target resource.
+          "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
+          "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
+          "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
+          "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
+          "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
+          "updateTime": "A String", # The update time of the target resource.
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.html index 3d7ea355e8..6a87ce08a9 100644 --- a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.html +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.html @@ -74,6 +74,21 @@

Assured Workloads API . organizations . locations

Instance Methods

+

+ dbFindingSummaries() +

+

Returns the dbFindingSummaries Resource.

+ +

+ dbFrameworkComplianceReports() +

+

Returns the dbFrameworkComplianceReports Resource.

+ +

+ dbFrameworkComplianceSummaries() +

+

Returns the dbFrameworkComplianceSummaries Resource.

+

operations()

diff --git a/docs/dyn/assuredworkloads_v1beta1.projects.html b/docs/dyn/assuredworkloads_v1beta1.projects.html index 9a64a43c32..afab33fbee 100644 --- a/docs/dyn/assuredworkloads_v1beta1.projects.html +++ b/docs/dyn/assuredworkloads_v1beta1.projects.html @@ -75,9 +75,9 @@

Assured Workloads API . projects

Instance Methods

- organizations() + locations()

-

Returns the organizations Resource.

+

Returns the locations Resource.

close()

diff --git a/docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFindingSummaries.html b/docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFindingSummaries.html new file mode 100644 index 0000000000..d6e9dc2e48 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFindingSummaries.html @@ -0,0 +1,141 @@ + + + +

Assured Workloads API . projects . locations . dbFindingSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the finding summary by category for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the finding summary by category for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return.
+  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 ListDbFindingSummaries.
+  "dbFindingSummaries": [ # List of finding summary by category.
+    { # The details for a finding.
+      "findingCategory": "A String", # Output only. The category of the finding.
+      "findingClass": "A String", # Output only. The class of the finding.
+      "findingCount": "A String", # Output only. The count of the finding.
+      "name": "A String", # Identifier. The name of the finding summary.
+      "relatedFrameworks": [ # Optional. The list of compliance frameworks that the finding belongs to.
+        "A String",
+      ],
+      "severity": "A String", # Output only. The severity of the finding.
+      "updateTime": "A String", # Output only. The last updated time of the finding.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html b/docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html new file mode 100644 index 0000000000..73d2280f19 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.html @@ -0,0 +1,200 @@ + + + +

Assured Workloads API . projects . locations . dbFrameworkComplianceReports . dbControlComplianceSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the control compliance summary for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the control compliance summary for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return.
+  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 ListDBControlComplianceSummaries.
+  "dbControlComplianceSummaries": [ # The list of control compliance details.
+    { # The details for control compliance.
+      "cloudControlReports": [ # The list of cloud control reports.
+        { # The cloud control report.
+          "categories": [ # The list of categories for the cloud control.
+            "A String",
+          ],
+          "cloudControl": "A String", # The name of the cloud control.
+          "cloudControlAssessmentDetails": { # The cloud control assessment details for non-manual cloud controls. # The details of a cloud control assessment.
+            "evaluationState": "A String", # Output only. The evaluation status of the cloud control.
+            "findingsCount": 42, # The number of findings for the cloud control.
+          },
+          "cloudControlDeployment": "A String", # The name of the cloud control deployment.
+          "cloudControlType": "A String", # The type of the cloud control.
+          "description": "A String", # The description of the cloud control.
+          "displayName": "A String", # The display name of the cloud control.
+          "enforcementMode": "A String", # The enforcement mode of the cloud control.
+          "findingCategory": "A String", # The category of the finding.
+          "findingSeverity": "A String", # The severity of the finding.
+          "frameworkMajorRevisionIds": [ # The major revision IDs of the frameworks that the cloud control belongs to.
+            "A String",
+          ],
+          "majorRevisionId": "A String", # The major revision ID of the cloud control.
+          "manualCloudControlAssessmentDetails": { # The details for a manual cloud control assessment. # The details of a manual cloud control assessment.
+            "manualCloudControlGuide": [ # The guide for assessing a cloud control manually.
+              "A String",
+            ],
+          },
+          "minorRevisionId": "A String", # The minor revision ID of the cloud control.
+          "rules": [ # The list of rules that correspond to the cloud control.
+            { # A rule in the cloud control.
+              "celExpression": { # A Common Expression Language (CEL) expression that's used to create a rule. # The rule's logic expression in Common Expression Language (CEL).
+                "expression": "A String", # Required. The logical expression in CEL. The maximum length of the condition is 1000 characters. For more information, see [CEL expression](https://cloud.google.com/security-command-center/docs/compliance-manager-write-cel-expressions).
+                "resourceTypesValues": { # A list of strings for the parameter value. # The resource instance types on which this expression is defined. The format is `/`. For example: `compute.googleapis.com/Instance`
+                  "values": [ # Required. The strings in the list.
+                    "A String",
+                  ],
+                },
+              },
+              "description": "A String", # Optional. The rule description. The maximum length is 2000 characters.
+              "ruleActionTypes": [ # Required. The functionality that's enabled by the rule.
+                "A String",
+              ],
+            },
+          ],
+          "similarControls": [ # The list of similar controls.
+            { # The similar controls.
+              "controlId": "A String", # The ID of the control.
+              "framework": "A String", # The name of the framework.
+            },
+          ],
+        },
+      ],
+      "complianceFrameworks": [ # The list of compliance frameworks that the control belongs to.
+        "A String",
+      ],
+      "control": "A String", # The name of the control.
+      "controlResponsibilityType": "A String", # The responsibility type for the control.
+      "description": "A String", # The description of the control.
+      "displayName": "A String", # The display name of the control.
+      "isFakeControl": True or False, # Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.
+      "name": "A String", # Identifier. The name of the control compliance summary.
+      "overallEvaluationState": "A String", # Output only. The overall evaluation status of the control.
+      "similarControls": [ # The list of similar controls.
+        { # The similar controls.
+          "controlId": "A String", # The ID of the control.
+          "framework": "A String", # The name of the framework.
+        },
+      ],
+      "totalFindingsCount": 42, # The total number of findings for the control.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFrameworkComplianceReports.html b/docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFrameworkComplianceReports.html new file mode 100644 index 0000000000..16a2d4de7e --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFrameworkComplianceReports.html @@ -0,0 +1,204 @@ + + + +

Assured Workloads API . projects . locations . dbFrameworkComplianceReports

+

Instance Methods

+

+ dbControlComplianceSummaries() +

+

Returns the dbControlComplianceSummaries Resource.

+ +

+ aggregate(name, filter=None, interval_endTime=None, interval_startTime=None, x__xgafv=None)

+

Gets the aggregated compliance report over time for a given scope.

+

+ close()

+

Close httplib2 connections.

+

+ fetch(name, endTime=None, filter=None, x__xgafv=None)

+

Fetches the framework compliance report for a given scope.

+

Method Details

+
+ aggregate(name, filter=None, interval_endTime=None, interval_startTime=None, x__xgafv=None) +
Gets the aggregated compliance report over time for a given scope.
+
+Args:
+  name: string, Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` (required)
+  filter: string, Optional. The filtering results.
+  interval_endTime: string, Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+  interval_startTime: string, Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  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 AggregateDbFrameworkComplianceReport.
+  "aggregatedComplianceReports": [ # The list of aggregated compliance reports.
+    { # The aggregated compliance report.
+      "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+          "A String",
+        ],
+        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+        "failingControlIds": [ # The list of controls that are failing.
+          "A String",
+        ],
+        "failingControls": 42, # The number of controls that are failing.
+        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+          "A String",
+        ],
+        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+        "passingControlIds": [ # The list of controls that are passing or not assessed.
+          "A String",
+        ],
+        "passingControls": 42, # The number of controls that are passing or not assessed.
+      },
+      "reportTime": "A String", # The report time of the aggregated compliance report.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ fetch(name, endTime=None, filter=None, x__xgafv=None) +
Fetches the framework compliance report for a given scope.
+
+Args:
+  name: string, Required. The name of the framework compliance report to retrieve. (required)
+  endTime: string, Optional. The end time of the report.
+  filter: string, Optional. The filtering results.
+  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 FetchDbFrameworkComplianceReport.
+  "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+    "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+      "A String",
+    ],
+    "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+    "failingControlIds": [ # The list of controls that are failing.
+      "A String",
+    ],
+    "failingControls": 42, # The number of controls that are failing.
+    "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+      "A String",
+    ],
+    "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+    "passingControlIds": [ # The list of controls that are passing or not assessed.
+      "A String",
+    ],
+    "passingControls": 42, # The number of controls that are passing or not assessed.
+  },
+  "framework": "A String", # The name of the framework.
+  "frameworkCategories": [ # The list of framework categories supported.
+    "A String",
+  ],
+  "frameworkDescription": "A String", # The description of the framework.
+  "frameworkDisplayName": "A String", # Optional. The display name for the framework.
+  "frameworkType": "A String", # The type of the framework.
+  "majorRevisionId": "A String", # The latest major revision ID of the framework.
+  "minorRevisionId": "A String", # The latest minor revision ID of the latest major revision of the framework.
+  "name": "A String", # The name of the framework compliance report.
+  "supportedCloudProviders": [ # The list of cloud providers that are supported by the framework.
+    "A String",
+  ],
+  "targetResourceDetails": [ # The target resource details of the framework.
+    { # The details for a target resource.
+      "createTime": "A String", # The create time of the target resource.
+      "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
+      "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
+      "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
+      "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
+      "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
+      "updateTime": "A String", # The update time of the target resource.
+    },
+  ],
+  "updateTime": "A String", # Output only. The last updated time of the report.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFrameworkComplianceSummaries.html b/docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFrameworkComplianceSummaries.html new file mode 100644 index 0000000000..2d01a1f7f8 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.projects.locations.dbFrameworkComplianceSummaries.html @@ -0,0 +1,183 @@ + + + +

Assured Workloads API . projects . locations . dbFrameworkComplianceSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the framework compliance summary for a given scope.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists the framework compliance summary for a given scope.
+
+Args:
+  parent: string, Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location} (required)
+  filter: string, Optional. The filtering results.
+  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
+  pageToken: string, Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.
+  view: string, Optional. Specifies the level of detail to return in the response.
+    Allowed values
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC - Includes basic compliance metadata, but omits trend data.
+      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL - Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days.
+  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 ListDbFrameworkComplianceSummariesResponse.
+  "dbFrameworkComplianceSummaries": [ # The list of framework compliance summaries.
+    { # The details for a framework compliance summary.
+      "controlAssessmentDetails": { # The details for a control assessment. # The control assessment details of the framework.
+        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
+          "A String",
+        ],
+        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
+        "failingControlIds": [ # The list of controls that are failing.
+          "A String",
+        ],
+        "failingControls": 42, # The number of controls that are failing.
+        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
+          "A String",
+        ],
+        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
+        "passingControlIds": [ # The list of controls that are passing or not assessed.
+          "A String",
+        ],
+        "passingControls": 42, # The number of controls that are passing or not assessed.
+      },
+      "controlsPassingTrend": { # The trend of a compliance metric. # Output only. The trend of controls that are passing for the given duration.
+        "duration": "A String", # Output only. The duration for the trend.
+        "valuePercent": 3.14, # Output only. The trend value as a percentage. The value can be positive or negative.
+      },
+      "findingCount": "A String", # Output only. The count of the findings generated against the framework.
+      "framework": "A String", # The name of the framework.
+      "frameworkCategories": [ # The list of framework categories supported by the framework.
+        "A String",
+      ],
+      "frameworkDisplayName": "A String", # Optional. The display name for the framework.
+      "frameworkType": "A String", # The type of framework.
+      "majorRevisionId": "A String", # The major revision ID of the framework.
+      "minorRevisionId": "A String", # The minor revision ID of the framework.
+      "name": "A String", # Identifier. The name of the framework compliance summary.
+      "supportedCloudProviders": [ # The list of cloud providers supported by the framework.
+        "A String",
+      ],
+      "targetResourceDetails": [ # The target resource details for the framework.
+        { # The details for a target resource.
+          "createTime": "A String", # The create time of the target resource.
+          "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
+          "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
+          "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
+          "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
+          "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
+          "updateTime": "A String", # The update time of the target resource.
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.projects.locations.html b/docs/dyn/assuredworkloads_v1beta1.projects.locations.html new file mode 100644 index 0000000000..f2be2c79aa --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.projects.locations.html @@ -0,0 +1,101 @@ + + + +

Assured Workloads API . projects . locations

+

Instance Methods

+

+ dbFindingSummaries() +

+

Returns the dbFindingSummaries Resource.

+ +

+ dbFrameworkComplianceReports() +

+

Returns the dbFrameworkComplianceReports Resource.

+ +

+ dbFrameworkComplianceSummaries() +

+

Returns the dbFrameworkComplianceSummaries Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index 68c4eca96a..e2e2114545 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -193,6 +193,195 @@ ] } } +}, +"dbFrameworkComplianceReports": { +"methods": { +"aggregate": { +"description": "Gets the aggregated compliance report over time for a given scope.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", +"httpMethod": "GET", +"id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.aggregate", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"interval.endTime": { +"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"interval.startTime": { +"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:aggregate", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetch": { +"description": "Fetches the framework compliance report for a given scope.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", +"httpMethod": "GET", +"id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.fetch", +"parameterOrder": [ +"name" +], +"parameters": { +"endTime": { +"description": "Optional. The end time of the report.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the framework compliance report to retrieve.", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:fetch", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"dbControlComplianceSummaries": { +"methods": { +"list": { +"description": "Lists the control compliance summary for a given scope.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", +"httpMethod": "GET", +"id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token that identifies the page of results that the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/dbControlComplianceSummaries", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"dbFrameworkComplianceSummaries": { +"methods": { +"list": { +"description": "Lists the framework compliance summary for a given scope.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceSummaries", +"httpMethod": "GET", +"id": "assuredworkloads.folders.locations.dbFrameworkComplianceSummaries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location}", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. Specifies the level of detail to return in the response.", +"enum": [ +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the BASIC view.", +"Includes basic compliance metadata, but omits trend data.", +"Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." +], +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/dbFrameworkComplianceSummaries", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} } } } @@ -247,6 +436,195 @@ } } }, +"dbFrameworkComplianceReports": { +"methods": { +"aggregate": { +"description": "Gets the aggregated compliance report over time for a given scope.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.aggregate", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"interval.endTime": { +"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"interval.startTime": { +"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:aggregate", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetch": { +"description": "Fetches the framework compliance report for a given scope.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.fetch", +"parameterOrder": [ +"name" +], +"parameters": { +"endTime": { +"description": "Optional. The end time of the report.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the framework compliance report to retrieve.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:fetch", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"dbControlComplianceSummaries": { +"methods": { +"list": { +"description": "Lists the control compliance summary for a given scope.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token that identifies the page of results that the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/dbControlComplianceSummaries", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"dbFrameworkComplianceSummaries": { +"methods": { +"list": { +"description": "Lists the framework compliance summary for a given scope.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceSummaries", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceSummaries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location}", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. Specifies the level of detail to return in the response.", +"enum": [ +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the BASIC view.", +"Includes basic compliance metadata, but omits trend data.", +"Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." +], +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/dbFrameworkComplianceSummaries", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "operations": { "methods": { "get": { @@ -752,100 +1130,282 @@ "parent": { "description": "Optional. The parent resource shared by all violations being acknowledged. Format: organizations/{organization}/locations/{location}/workloads/{workload}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/violations:batchAcknowledgeViolations", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1BatchAcknowledgeViolationsRequest" +}, +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1BatchAcknowledgeViolationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Retrieves Assured Workload Violation based on ID.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.violations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1Violation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.violations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A custom filter for filtering by the Violations properties.", +"location": "query", +"type": "string" +}, +"interval.endTime": { +"description": "The end of the time window.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"interval.startTime": { +"description": "The start of the time window.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Actionable sorting delegation.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token returned from previous request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/violations", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1ListViolationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +}, +"projects": { +"resources": { +"locations": { +"resources": { +"dbFindingSummaries": { +"methods": { +"list": { +"description": "Lists the finding summary by category for a given scope.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFindingSummaries", +"httpMethod": "GET", +"id": "assuredworkloads.projects.locations.dbFindingSummaries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token that identifies the page of results that the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/dbFindingSummaries", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"dbFrameworkComplianceReports": { +"methods": { +"aggregate": { +"description": "Gets the aggregated compliance report over time for a given scope.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", +"httpMethod": "GET", +"id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.aggregate", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"interval.endTime": { +"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"interval.startTime": { +"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/violations:batchAcknowledgeViolations", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1BatchAcknowledgeViolationsRequest" -}, +"path": "v1/{+name}:aggregate", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1BatchAcknowledgeViolationsResponse" +"$ref": "GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"get": { -"description": "Retrieves Assured Workload Violation based on ID.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}", +"fetch": { +"description": "Fetches the framework compliance report for a given scope.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", "httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.violations.get", +"id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.fetch", "parameterOrder": [ "name" ], "parameters": { +"endTime": { +"description": "Optional. The end time of the report.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, "name": { -"description": "Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}", +"description": "Required. The name of the framework compliance report to retrieve.", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+name}:fetch", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1Violation" +"$ref": "GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} }, +"resources": { +"dbControlComplianceSummaries": { +"methods": { "list": { -"description": "Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations", +"description": "Lists the control compliance summary for a given scope.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", "httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.violations.list", +"id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "Optional. A custom filter for filtering by the Violations properties.", -"location": "query", -"type": "string" -}, -"interval.endTime": { -"description": "The end of the time window.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"interval.startTime": { -"description": "The start of the time window.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. Actionable sorting delegation.", +"description": "Optional. The filtering results.", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. Page size.", +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. Page token returned from previous request.", +"description": "Optional. A token that identifies the page of results that the server should return.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`.", +"description": "Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/violations", +"path": "v1/{+parent}/dbControlComplianceSummaries", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListViolationsResponse" +"$ref": "GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -854,22 +1414,14 @@ } } } -} -} -} -} }, -"projects": { -"resources": { -"locations": { -"resources": { -"dbFindingSummaries": { +"dbFrameworkComplianceSummaries": { "methods": { "list": { -"description": "Lists the finding summary by category for a given scope.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFindingSummaries", +"description": "Lists the framework compliance summary for a given scope.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceSummaries", "httpMethod": "GET", -"id": "assuredworkloads.projects.locations.dbFindingSummaries.list", +"id": "assuredworkloads.projects.locations.dbFrameworkComplianceSummaries.list", "parameterOrder": [ "parent" ], @@ -880,27 +1432,42 @@ "type": "string" }, "pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return.", +"description": "Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location}", +"description": "Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. Specifies the level of detail to return in the response.", +"enum": [ +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the BASIC view.", +"Includes basic compliance metadata, but omits trend data.", +"Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." +], +"location": "query", +"type": "string" } }, -"path": "v1/{+parent}/dbFindingSummaries", +"path": "v1/{+parent}/dbFrameworkComplianceSummaries", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse" +"$ref": "GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -913,7 +1480,7 @@ } } }, -"revision": "20260623", +"revision": "20260719", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -952,6 +1519,36 @@ "properties": {}, "type": "object" }, +"GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse": { +"description": "The response message for AggregateDbFrameworkComplianceReport.", +"id": "GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse", +"properties": { +"aggregatedComplianceReports": { +"description": "The list of aggregated compliance reports.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1AggregatedComplianceReport" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1AggregatedComplianceReport": { +"description": "The aggregated compliance report.", +"id": "GoogleCloudAssuredworkloadsV1AggregatedComplianceReport", +"properties": { +"controlAssessmentDetails": { +"$ref": "GoogleCloudAssuredworkloadsV1ControlAssessmentDetails", +"description": "The control assessment details of the framework." +}, +"reportTime": { +"description": "The report time of the aggregated compliance report.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse": { "description": "Response containing the analysis results for the hypothetical resource move.", "id": "GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse", @@ -1143,6 +1740,227 @@ }, "type": "object" }, +"GoogleCloudAssuredworkloadsV1CELExpression": { +"description": "A Common Expression Language (CEL) expression that's used to create a rule.", +"id": "GoogleCloudAssuredworkloadsV1CELExpression", +"properties": { +"expression": { +"description": "Required. The logical expression in CEL. The maximum length of the condition is 1000 characters. For more information, see [CEL expression](https://cloud.google.com/security-command-center/docs/compliance-manager-write-cel-expressions).", +"type": "string" +}, +"resourceTypesValues": { +"$ref": "GoogleCloudAssuredworkloadsV1StringList", +"description": "The resource instance types on which this expression is defined. The format is `/`. For example: `compute.googleapis.com/Instance`" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1CloudControlAssessmentDetails": { +"description": "The cloud control assessment details for non-manual cloud controls.", +"id": "GoogleCloudAssuredworkloadsV1CloudControlAssessmentDetails", +"properties": { +"evaluationState": { +"description": "Output only. The evaluation status of the cloud control.", +"enum": [ +"EVALUATION_STATE_UNSPECIFIED", +"EVALUATION_STATE_PASSED", +"EVALUATION_STATE_FAILED", +"EVALUATION_STATE_NOT_ASSESSED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The control is passing.", +"The control is failing.", +"The control is not assessed." +], +"readOnly": true, +"type": "string" +}, +"findingsCount": { +"description": "The number of findings for the cloud control.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1CloudControlReport": { +"description": "The cloud control report.", +"id": "GoogleCloudAssuredworkloadsV1CloudControlReport", +"properties": { +"categories": { +"description": "The list of categories for the cloud control.", +"items": { +"type": "string" +}, +"type": "array" +}, +"cloudControl": { +"description": "The name of the cloud control.", +"type": "string" +}, +"cloudControlAssessmentDetails": { +"$ref": "GoogleCloudAssuredworkloadsV1CloudControlAssessmentDetails", +"description": "The details of a cloud control assessment." +}, +"cloudControlDeployment": { +"description": "The name of the cloud control deployment.", +"type": "string" +}, +"cloudControlType": { +"description": "The type of the cloud control.", +"enum": [ +"TYPE_UNSPECIFIED", +"CUSTOM", +"BUILT_IN" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"A cloud control that's created and managed by you.", +"A cloud control that's provided and managed by Google." +], +"type": "string" +}, +"description": { +"description": "The description of the cloud control.", +"type": "string" +}, +"displayName": { +"description": "The display name of the cloud control.", +"type": "string" +}, +"enforcementMode": { +"description": "The enforcement mode of the cloud control.", +"enum": [ +"ENFORCEMENT_MODE_UNSPECIFIED", +"PREVENTIVE", +"DETECTIVE", +"AUDIT" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The cloud control is enforced to prevent non-compliance.", +"The cloud control is enforced to detect non-compliance.", +"The cloud control is enforced to audit for non-compliance." +], +"type": "string" +}, +"findingCategory": { +"description": "The category of the finding.", +"type": "string" +}, +"findingSeverity": { +"description": "The severity of the finding.", +"enum": [ +"SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. A critical threat is a threat that can access, modify, or delete data or execute unauthorized code within existing resources.", +"A high-risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. A high-risk threat is a threat that can create new computational resources in an environment but can't access data or execute code in existing resources.", +"A medium-risk vulnerability can be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. A medium-risk threat can cause operational impact but might not access data or execute unauthorized code.", +"A low-risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. A low-risk threat is a threat that has obtained minimal access to an environment but can't access data, execute code, or create resources." +], +"type": "string" +}, +"frameworkMajorRevisionIds": { +"description": "The major revision IDs of the frameworks that the cloud control belongs to.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"majorRevisionId": { +"description": "The major revision ID of the cloud control.", +"format": "int64", +"type": "string" +}, +"manualCloudControlAssessmentDetails": { +"$ref": "GoogleCloudAssuredworkloadsV1ManualCloudControlAssessmentDetails", +"description": "The details of a manual cloud control assessment." +}, +"minorRevisionId": { +"description": "The minor revision ID of the cloud control.", +"format": "int64", +"type": "string" +}, +"rules": { +"description": "The list of rules that correspond to the cloud control.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1Rule" +}, +"type": "array" +}, +"similarControls": { +"description": "The list of similar controls.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1SimilarControls" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1ControlAssessmentDetails": { +"description": "The details for a control assessment.", +"id": "GoogleCloudAssuredworkloadsV1ControlAssessmentDetails", +"properties": { +"assessedPassingControlIds": { +"description": "The list of controls that were assessed and are passing.", +"items": { +"type": "string" +}, +"type": "array" +}, +"assessedPassingControls": { +"description": "The number of controls that were assessed and are passing.", +"format": "int32", +"type": "integer" +}, +"failingControlIds": { +"description": "The list of controls that are failing.", +"items": { +"type": "string" +}, +"type": "array" +}, +"failingControls": { +"description": "The number of controls that are failing.", +"format": "int32", +"type": "integer" +}, +"notAssessedControlIds": { +"description": "The list of controls that aren't assessed because they require manual review.", +"items": { +"type": "string" +}, +"type": "array" +}, +"notAssessedControls": { +"description": "The number of controls that aren't assessed because they require manual review.", +"format": "int32", +"type": "integer" +}, +"passingControlIds": { +"description": "The list of controls that are passing or not assessed.", +"items": { +"type": "string" +}, +"type": "array" +}, +"passingControls": { +"description": "The number of controls that are passing or not assessed.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata": { "description": "Operation metadata to give request details of CreateWorkload.", "id": "GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata", @@ -1295,18 +2113,104 @@ false ], "type": "string" }, -"createTime": { -"description": "Optional. Time when the operation was created.", -"format": "google-datetime", +"createTime": { +"description": "Optional. Time when the operation was created.", +"format": "google-datetime", +"type": "string" +}, +"displayName": { +"description": "Optional. The display name of the workload.", +"type": "string" +}, +"parent": { +"description": "Optional. The parent of the workload.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1DbControlComplianceSummary": { +"description": "The details for control compliance.", +"id": "GoogleCloudAssuredworkloadsV1DbControlComplianceSummary", +"properties": { +"cloudControlReports": { +"description": "The list of cloud control reports.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1CloudControlReport" +}, +"type": "array" +}, +"complianceFrameworks": { +"description": "The list of compliance frameworks that the control belongs to.", +"items": { +"type": "string" +}, +"type": "array" +}, +"control": { +"description": "The name of the control.", +"type": "string" +}, +"controlResponsibilityType": { +"description": "The responsibility type for the control.", +"enum": [ +"REGULATORY_CONTROL_RESPONSIBILITY_TYPE_UNSPECIFIED", +"GOOGLE", +"CUSTOMER", +"SHARED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Google's responsibility.", +"Your responsibility.", +"Shared responsibility." +], +"type": "string" +}, +"description": { +"description": "The description of the control.", "type": "string" }, "displayName": { -"description": "Optional. The display name of the workload.", +"description": "The display name of the control.", "type": "string" }, -"parent": { -"description": "Optional. The parent of the workload.", +"isFakeControl": { +"description": "Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.", +"type": "boolean" +}, +"name": { +"description": "Identifier. The name of the control compliance summary.", +"type": "string" +}, +"overallEvaluationState": { +"description": "Output only. The overall evaluation status of the control.", +"enum": [ +"EVALUATION_STATE_UNSPECIFIED", +"EVALUATION_STATE_PASSED", +"EVALUATION_STATE_FAILED", +"EVALUATION_STATE_NOT_ASSESSED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The control is passing.", +"The control is failing.", +"The control is not assessed." +], +"readOnly": true, "type": "string" +}, +"similarControls": { +"description": "The list of similar controls.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1SimilarControls" +}, +"type": "array" +}, +"totalFindingsCount": { +"description": "The total number of findings for the control.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -1394,6 +2298,113 @@ false }, "type": "object" }, +"GoogleCloudAssuredworkloadsV1DbFrameworkComplianceSummary": { +"description": "The details for a framework compliance summary.", +"id": "GoogleCloudAssuredworkloadsV1DbFrameworkComplianceSummary", +"properties": { +"controlAssessmentDetails": { +"$ref": "GoogleCloudAssuredworkloadsV1ControlAssessmentDetails", +"description": "The control assessment details of the framework." +}, +"controlsPassingTrend": { +"$ref": "GoogleCloudAssuredworkloadsV1Trend", +"description": "Output only. The trend of controls that are passing for the given duration.", +"readOnly": true +}, +"findingCount": { +"description": "Output only. The count of the findings generated against the framework.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"framework": { +"description": "The name of the framework.", +"type": "string" +}, +"frameworkCategories": { +"description": "The list of framework categories supported by the framework.", +"items": { +"enum": [ +"FRAMEWORK_CATEGORY_UNSPECIFIED", +"INDUSTRY_DEFINED_STANDARD", +"ASSURED_WORKLOADS", +"DATA_SECURITY", +"GOOGLE_BEST_PRACTICES", +"CUSTOM_FRAMEWORK" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"An industry-defined framework.", +"An Assured Workloads framework.", +"A data security posture framework.", +"A Google's best practices framework.", +"A user-created framework." +], +"type": "string" +}, +"type": "array" +}, +"frameworkDisplayName": { +"description": "Optional. The display name for the framework.", +"type": "string" +}, +"frameworkType": { +"description": "The type of framework.", +"enum": [ +"FRAMEWORK_TYPE_UNSPECIFIED", +"BUILT_IN", +"CUSTOM" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"A framework that's provided and managed by Google.", +"A framework that's created and managed by you." +], +"type": "string" +}, +"majorRevisionId": { +"description": "The major revision ID of the framework.", +"format": "int64", +"type": "string" +}, +"minorRevisionId": { +"description": "The minor revision ID of the framework.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Identifier. The name of the framework compliance summary.", +"type": "string" +}, +"supportedCloudProviders": { +"description": "The list of cloud providers supported by the framework.", +"items": { +"enum": [ +"CLOUD_PROVIDER_UNSPECIFIED", +"AWS", +"AZURE", +"GCP" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Amazon Web Services (AWS).", +"Microsoft Azure.", +"Google Cloud." +], +"type": "string" +}, +"type": "array" +}, +"targetResourceDetails": { +"description": "The target resource details for the framework.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1TargetResourceDetails" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse": { "description": "Response for EnableComplianceUpdates endpoint.", "id": "GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse", @@ -1406,6 +2417,131 @@ false "properties": {}, "type": "object" }, +"GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse": { +"description": "The response message for FetchDbFrameworkComplianceReport.", +"id": "GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse", +"properties": { +"controlAssessmentDetails": { +"$ref": "GoogleCloudAssuredworkloadsV1ControlAssessmentDetails", +"description": "The control assessment details of the framework." +}, +"framework": { +"description": "The name of the framework.", +"type": "string" +}, +"frameworkCategories": { +"description": "The list of framework categories supported.", +"items": { +"enum": [ +"FRAMEWORK_CATEGORY_UNSPECIFIED", +"INDUSTRY_DEFINED_STANDARD", +"ASSURED_WORKLOADS", +"DATA_SECURITY", +"GOOGLE_BEST_PRACTICES", +"CUSTOM_FRAMEWORK" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"An industry-defined framework.", +"An Assured Workloads framework.", +"A data security posture framework.", +"A Google's best practices framework.", +"A user-created framework." +], +"type": "string" +}, +"type": "array" +}, +"frameworkDescription": { +"description": "The description of the framework.", +"type": "string" +}, +"frameworkDisplayName": { +"description": "Optional. The display name for the framework.", +"type": "string" +}, +"frameworkType": { +"description": "The type of the framework.", +"enum": [ +"FRAMEWORK_TYPE_UNSPECIFIED", +"BUILT_IN", +"CUSTOM" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"A framework that's provided and managed by Google.", +"A framework that's created and managed by you." +], +"type": "string" +}, +"majorRevisionId": { +"description": "The latest major revision ID of the framework.", +"format": "int64", +"type": "string" +}, +"minorRevisionId": { +"description": "The latest minor revision ID of the latest major revision of the framework.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "The name of the framework compliance report.", +"type": "string" +}, +"supportedCloudProviders": { +"description": "The list of cloud providers that are supported by the framework.", +"items": { +"enum": [ +"CLOUD_PROVIDER_UNSPECIFIED", +"AWS", +"AZURE", +"GCP" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Amazon Web Services (AWS).", +"Microsoft Azure.", +"Google Cloud." +], +"type": "string" +}, +"type": "array" +}, +"targetResourceDetails": { +"description": "The target resource details of the framework.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1TargetResourceDetails" +}, +"type": "array" +}, +"updateTime": { +"description": "Output only. The last updated time of the report.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse": { +"description": "The response message for ListDBControlComplianceSummaries.", +"id": "GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse", +"properties": { +"dbControlComplianceSummaries": { +"description": "The list of control compliance details.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1DbControlComplianceSummary" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Output only. The token to retrieve the next page of results.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse": { "description": "The response message for ListDbFindingSummaries.", "id": "GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse", @@ -1425,6 +2561,25 @@ false }, "type": "object" }, +"GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse": { +"description": "The response message for ListDbFrameworkComplianceSummariesResponse.", +"id": "GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse", +"properties": { +"dbFrameworkComplianceSummaries": { +"description": "The list of framework compliance summaries.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1DbFrameworkComplianceSummary" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Output only. The token to retrieve the next page of results.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAssuredworkloadsV1ListViolationsResponse": { "description": "Response of ListViolations endpoint.", "id": "GoogleCloudAssuredworkloadsV1ListViolationsResponse", @@ -1484,6 +2639,20 @@ false }, "type": "object" }, +"GoogleCloudAssuredworkloadsV1ManualCloudControlAssessmentDetails": { +"description": "The details for a manual cloud control assessment.", +"id": "GoogleCloudAssuredworkloadsV1ManualCloudControlAssessmentDetails", +"properties": { +"manualCloudControlGuide": { +"description": "The guide for assessing a cloud control manually.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAssuredworkloadsV1MoveAnalysisGroup": { "description": "Represents a logical group of checks performed for an asset. If successful, the group contains the analysis result, otherwise it contains an error with the failure reason.", "id": "GoogleCloudAssuredworkloadsV1MoveAnalysisGroup", @@ -1718,6 +2887,127 @@ false }, "type": "object" }, +"GoogleCloudAssuredworkloadsV1Rule": { +"description": "A rule in the cloud control.", +"id": "GoogleCloudAssuredworkloadsV1Rule", +"properties": { +"celExpression": { +"$ref": "GoogleCloudAssuredworkloadsV1CELExpression", +"description": "The rule's logic expression in Common Expression Language (CEL)." +}, +"description": { +"description": "Optional. The rule description. The maximum length is 2000 characters.", +"type": "string" +}, +"ruleActionTypes": { +"description": "Required. The functionality that's enabled by the rule.", +"items": { +"enum": [ +"RULE_ACTION_TYPE_UNSPECIFIED", +"RULE_ACTION_TYPE_PREVENTIVE", +"RULE_ACTION_TYPE_DETECTIVE", +"RULE_ACTION_TYPE_AUDIT" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The rule is intended to prevent non-compliance.", +"The rule is intended to detect non-compliance.", +"The rule is intended to audit non-compliance." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1SimilarControls": { +"description": "The similar controls.", +"id": "GoogleCloudAssuredworkloadsV1SimilarControls", +"properties": { +"controlId": { +"description": "The ID of the control.", +"type": "string" +}, +"framework": { +"description": "The name of the framework.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1StringList": { +"description": "A list of strings for the parameter value.", +"id": "GoogleCloudAssuredworkloadsV1StringList", +"properties": { +"values": { +"description": "Required. The strings in the list.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1TargetResourceDetails": { +"description": "The details for a target resource.", +"id": "GoogleCloudAssuredworkloadsV1TargetResourceDetails", +"properties": { +"createTime": { +"description": "The create time of the target resource.", +"format": "google-datetime", +"type": "string" +}, +"frameworkDeployment": { +"description": "The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`", +"type": "string" +}, +"majorRevisionId": { +"description": "The major revision ID of the framework for the target resource.", +"format": "int64", +"type": "string" +}, +"minorRevisionId": { +"description": "The minor revision ID of the framework for the target resource.", +"format": "int64", +"type": "string" +}, +"targetResource": { +"description": "The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.", +"type": "string" +}, +"targetResourceDisplayName": { +"description": "The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.", +"type": "string" +}, +"updateTime": { +"description": "The update time of the target resource.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1Trend": { +"description": "The trend of a compliance metric.", +"id": "GoogleCloudAssuredworkloadsV1Trend", +"properties": { +"duration": { +"description": "Output only. The duration for the trend.", +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"valuePercent": { +"description": "Output only. The trend value as a percentage. The value can be positive or negative.", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudAssuredworkloadsV1UpdateDetails": { "description": "The details of the update.", "id": "GoogleCloudAssuredworkloadsV1UpdateDetails", diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json index ad95923e91..05a1d8b840 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json @@ -145,613 +145,1303 @@ } } }, -"organizations": { +"folders": { "resources": { "locations": { "resources": { -"operations": { +"dbFindingSummaries": { "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": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", +"list": { +"description": "Lists the finding summary by category for a given scope.", +"flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/dbFindingSummaries", "httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.operations.get", +"id": "assuredworkloads.folders.locations.dbFindingSummaries.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource.", +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token that identifies the page of results that the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", +"pattern": "^folders/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+parent}/dbFindingSummaries", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbFindingSummariesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations", +"dbFrameworkComplianceReports": { +"methods": { +"aggregate": { +"description": "Gets the aggregated compliance report over time for a given scope.", +"flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", "httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.operations.list", +"id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.aggregate", "parameterOrder": [ "name" ], "parameters": { "filter": { -"description": "The standard list filter.", +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"interval.endTime": { +"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"interval.startTime": { +"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", +"format": "google-datetime", "location": "query", "type": "string" }, "name": { -"description": "The name of the operation's parent resource.", +"description": "Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+$", +"pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "required": true, "type": "string" +} }, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" +"path": "v1beta1/{+name}:aggregate", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1AggregateDbFrameworkComplianceReportResponse" }, -"pageToken": { -"description": "The standard list page token.", +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetch": { +"description": "Fetches the framework compliance report for a given scope.", +"flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", +"httpMethod": "GET", +"id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.fetch", +"parameterOrder": [ +"name" +], +"parameters": { +"endTime": { +"description": "Optional. The end time of the report.", +"format": "google-datetime", "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.", +"filter": { +"description": "Optional. The filtering results.", "location": "query", -"type": "boolean" +"type": "string" +}, +"name": { +"description": "Required. The name of the framework compliance report to retrieve.", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1beta1/{+name}/operations", +"path": "v1beta1/{+name}:fetch", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1FetchDbFrameworkComplianceReportResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } -} }, -"violations": { +"resources": { +"dbControlComplianceSummaries": { "methods": { -"batchAcknowledgeViolations": { -"description": "Acknowledges multiple existing violations. By acknowledging violations, users acknowledge the existence of compliance violations in their workload and decide to ignore them due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted. This is a batch version of AcknowledgeViolation.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/violations:batchAcknowledgeViolations", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.violations.batchAcknowledgeViolations", +"list": { +"description": "Lists the control compliance summary for a given scope.", +"flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", +"httpMethod": "GET", +"id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", "parameterOrder": [ "parent" ], "parameters": { +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token that identifies the page of results that the server should return.", +"location": "query", +"type": "string" +}, "parent": { -"description": "Optional. The parent resource shared by all violations being acknowledged. Format: organizations/{organization}/locations/{location}/workloads/{workload}", +"description": "Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+$", +"pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/violations:batchAcknowledgeViolations", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsRequest" -}, +"path": "v1beta1/{+parent}/dbControlComplianceSummaries", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbControlComplianceSummariesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } +} +} }, -"workloads": { +"dbFrameworkComplianceSummaries": { "methods": { -"analyzeWorkloadMove": { -"description": "Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove", +"list": { +"description": "Lists the framework compliance summary for a given scope.", +"flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceSummaries", "httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.analyzeWorkloadMove", +"id": "assuredworkloads.folders.locations.dbFrameworkComplianceSummaries.list", "parameterOrder": [ -"target" +"parent" ], "parameters": { -"assetTypes": { -"description": "Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", +"filter": { +"description": "Optional. The filtering results.", "location": "query", -"repeated": true, "type": "string" }, "pageSize": { -"description": "Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50.", +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. The page token from the previous response. It needs to be passed in the second and following requests.", -"location": "query", -"type": "string" -}, -"project": { -"description": "The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: \"projects/{PROJECT_NUMBER}\" or \"projects/{PROJECT_ID}\" For example: \"projects/951040570662\" when specifying a project number, or \"projects/my-project-123\" when specifying a project ID.", +"description": "Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.", "location": "query", "type": "string" }, -"target": { -"description": "Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-2\"", +"parent": { +"description": "Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"pattern": "^folders/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. Specifies the level of detail to return in the response.", +"enum": [ +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the BASIC view.", +"Includes basic compliance metadata, but omits trend data.", +"Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." +], +"location": "query", +"type": "string" } }, -"path": "v1beta1/{+target}:analyzeWorkloadMove", +"path": "v1beta1/{+parent}/dbFrameworkComplianceSummaries", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbFrameworkComplianceSummariesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} +} +} +} +} }, -"create": { -"description": "Creates Assured Workload.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.create", +"organizations": { +"resources": { +"locations": { +"resources": { +"dbFindingSummaries": { +"methods": { +"list": { +"description": "Lists the finding summary by category for a given scope.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/dbFindingSummaries", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.dbFindingSummaries.list", "parameterOrder": [ "parent" ], "parameters": { -"externalId": { -"description": "Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.", +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token that identifies the page of results that the server should return.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`.", +"description": "Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location}", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/workloads", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" -}, +"path": "v1beta1/{+parent}/dbFindingSummaries", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbFindingSummariesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"delete": { -"description": "Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", -"httpMethod": "DELETE", -"id": "assuredworkloads.organizations.locations.workloads.delete", +"dbFrameworkComplianceReports": { +"methods": { +"aggregate": { +"description": "Gets the aggregated compliance report over time for a given scope.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.aggregate", "parameterOrder": [ "name" ], "parameters": { -"etag": { -"description": "Optional. The etag of the workload. If this is provided, it must match the server's etag.", +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"interval.endTime": { +"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"interval.startTime": { +"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", +"format": "google-datetime", "location": "query", "type": "string" }, "name": { -"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", +"description": "Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+name}:aggregate", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleCloudAssuredworkloadsV1beta1AggregateDbFrameworkComplianceReportResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"enableComplianceUpdates": { -"description": "This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have `resourcemanager.folders.getIamPolicy` and `resourcemanager.folders.setIamPolicy` permissions on the assured workload folder.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableComplianceUpdates", -"httpMethod": "PUT", -"id": "assuredworkloads.organizations.locations.workloads.enableComplianceUpdates", +"fetch": { +"description": "Fetches the framework compliance report for a given scope.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.fetch", "parameterOrder": [ "name" ], "parameters": { +"endTime": { +"description": "Optional. The end time of the report.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, "name": { -"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", +"description": "Required. The name of the framework compliance report to retrieve.", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:enableComplianceUpdates", +"path": "v1beta1/{+name}:fetch", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1EnableComplianceUpdatesResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1FetchDbFrameworkComplianceReportResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} }, -"enableResourceMonitoring": { -"description": "Enable resource violation monitoring for a workload.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.enableResourceMonitoring", +"resources": { +"dbControlComplianceSummaries": { +"methods": { +"list": { +"description": "Lists the control compliance summary for a given scope.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token that identifies the page of results that the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:enableResourceMonitoring", +"path": "v1beta1/{+parent}/dbControlComplianceSummaries", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1EnableResourceMonitoringResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbControlComplianceSummariesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -}, -"get": { -"description": "Gets Assured Workload associated with a CRM Node", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" +} +} +} } }, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, +"dbFrameworkComplianceSummaries": { +"methods": { "list": { -"description": "Lists Assured Workloads under a CRM Node.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads", +"description": "Lists the framework compliance summary for a given scope.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceSummaries", "httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.list", +"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceSummaries.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.", +"description": "Optional. The filtering results.", "location": "query", "type": "string" }, "pageSize": { -"description": "Page size.", +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.", +"description": "Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`.", +"description": "Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location}", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. Specifies the level of detail to return in the response.", +"enum": [ +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the BASIC view.", +"Includes basic compliance metadata, but omits trend data.", +"Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." +], +"location": "query", +"type": "string" } }, -"path": "v1beta1/{+parent}/workloads", +"path": "v1beta1/{+parent}/dbFrameworkComplianceSummaries", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbFrameworkComplianceSummariesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"patch": { -"description": "Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", -"httpMethod": "PATCH", -"id": "assuredworkloads.organizations.locations.workloads.patch", +"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": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", +"description": "The name of the operation resource.", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Required. The list of fields to be updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, "path": "v1beta1/{+name}", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" -}, "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"restrictAllowedResources": { -"description": "Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.restrictAllowedResources", +"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/organizations/{organizationsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.operations.list", "parameterOrder": [ "name" ], "parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, "name": { -"description": "Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", +"description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" -} }, -"path": "v1beta1/{+name}:restrictAllowedResources", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest" +"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": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse" +"$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } +} }, -"resources": { -"updates": { +"violations": { "methods": { -"apply": { -"description": "This endpoint creates a new operation to apply the given update.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates/{updatesId}:apply", +"batchAcknowledgeViolations": { +"description": "Acknowledges multiple existing violations. By acknowledging violations, users acknowledge the existence of compliance violations in their workload and decide to ignore them due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted. This is a batch version of AcknowledgeViolation.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/violations:batchAcknowledgeViolations", "httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.updates.apply", +"id": "assuredworkloads.organizations.locations.violations.batchAcknowledgeViolations", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Required. The resource name of the update. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}/updates/{update_id}", +"parent": { +"description": "Optional. The parent resource shared by all violations being acknowledged. Format: organizations/{organization}/locations/{location}/workloads/{workload}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/updates/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:apply", +"path": "v1beta1/{+parent}/violations:batchAcknowledgeViolations", "request": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateRequest" +"$ref": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsRequest" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"list": { -"description": "This endpoint lists all updates for the given workload.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates", +"workloads": { +"methods": { +"analyzeWorkloadMove": { +"description": "Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove", "httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.updates.list", +"id": "assuredworkloads.organizations.locations.workloads.analyzeWorkloadMove", "parameterOrder": [ -"parent" +"target" ], "parameters": { +"assetTypes": { +"description": "Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", +"location": "query", +"repeated": true, +"type": "string" +}, "pageSize": { -"description": "Page size. The default value is 20 and the max allowed value is 100.", +"description": "Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Page token returned from previous request.", +"description": "Optional. The page token from the previous response. It needs to be passed in the second and following requests.", "location": "query", "type": "string" }, -"parent": { -"description": "Required. organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", +"project": { +"description": "The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: \"projects/{PROJECT_NUMBER}\" or \"projects/{PROJECT_ID}\" For example: \"projects/951040570662\" when specifying a project number, or \"projects/my-project-123\" when specifying a project ID.", +"location": "query", +"type": "string" +}, +"target": { +"description": "Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-2\"", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/updates", +"path": "v1beta1/{+target}:analyzeWorkloadMove", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadUpdatesResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} }, -"violations": { -"methods": { -"acknowledge": { -"description": "Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge", +"create": { +"description": "Creates Assured Workload.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads", "httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.violations.acknowledge", +"id": "assuredworkloads.organizations.locations.workloads.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}", +"externalId": { +"description": "Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`.", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:acknowledge", +"path": "v1beta1/{+parent}/workloads", "request": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest" +"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" }, "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"batchAcknowledgeViolations": { -"description": "Acknowledges multiple existing violations. By acknowledging violations, users acknowledge the existence of compliance violations in their workload and decide to ignore them due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted. This is a batch version of AcknowledgeViolation.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations:batchAcknowledgeViolations", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.violations.batchAcknowledgeViolations", +"delete": { +"description": "Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", +"httpMethod": "DELETE", +"id": "assuredworkloads.organizations.locations.workloads.delete", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Optional. The parent resource shared by all violations being acknowledged. Format: organizations/{organization}/locations/{location}/workloads/{workload}", +"etag": { +"description": "Optional. The etag of the workload. If this is provided, it must match the server's etag.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/violations:batchAcknowledgeViolations", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsRequest" -}, +"path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsResponse" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"get": { -"description": "Retrieves Assured Workload Violation based on ID.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.violations.get", +"enableComplianceUpdates": { +"description": "This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have `resourcemanager.folders.getIamPolicy` and `resourcemanager.folders.setIamPolicy` permissions on the assured workload folder.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableComplianceUpdates", +"httpMethod": "PUT", +"id": "assuredworkloads.organizations.locations.workloads.enableComplianceUpdates", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}", +"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+name}:enableComplianceUpdates", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1Violation" +"$ref": "GoogleCloudAssuredworkloadsV1beta1EnableComplianceUpdatesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations", +"enableResourceMonitoring": { +"description": "Enable resource violation monitoring for a workload.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.locations.workloads.enableResourceMonitoring", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:enableResourceMonitoring", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1EnableResourceMonitoringResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets Assured Workload associated with a CRM Node", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Assured Workloads under a CRM Node.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/workloads", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", +"httpMethod": "PATCH", +"id": "assuredworkloads.organizations.locations.workloads.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The list of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" +}, +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"restrictAllowedResources": { +"description": "Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.locations.workloads.restrictAllowedResources", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:restrictAllowedResources", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest" +}, +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"updates": { +"methods": { +"apply": { +"description": "This endpoint creates a new operation to apply the given update.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates/{updatesId}:apply", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.locations.workloads.updates.apply", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the update. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}/updates/{update_id}", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/updates/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:apply", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "This endpoint lists all updates for the given workload.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.updates.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Page size. The default value is 20 and the max allowed value is 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Page token returned from previous request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/updates", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadUpdatesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"violations": { +"methods": { +"acknowledge": { +"description": "Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.locations.workloads.violations.acknowledge", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:acknowledge", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest" +}, +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"batchAcknowledgeViolations": { +"description": "Acknowledges multiple existing violations. By acknowledging violations, users acknowledge the existence of compliance violations in their workload and decide to ignore them due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted. This is a batch version of AcknowledgeViolation.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations:batchAcknowledgeViolations", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.locations.workloads.violations.batchAcknowledgeViolations", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Optional. The parent resource shared by all violations being acknowledged. Format: organizations/{organization}/locations/{location}/workloads/{workload}", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/violations:batchAcknowledgeViolations", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsRequest" +}, +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Retrieves Assured Workload Violation based on ID.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.violations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1Violation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.violations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A custom filter for filtering by the Violations properties.", +"location": "query", +"type": "string" +}, +"interval.endTime": { +"description": "The end of the time window.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"interval.startTime": { +"description": "The start of the time window.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Actionable sorting delegation.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token returned from previous request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/violations", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"violations": { +"methods": { +"batchAcknowledgeViolations": { +"description": "Acknowledges multiple existing violations. By acknowledging violations, users acknowledge the existence of compliance violations in their workload and decide to ignore them due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted. This is a batch version of AcknowledgeViolation.", +"flatPath": "v1beta1/organizations/{organizationsId}/violations:batchAcknowledgeViolations", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.violations.batchAcknowledgeViolations", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Optional. The parent resource shared by all violations being acknowledged. Format: organizations/{organization}/locations/{location}/workloads/{workload}", +"location": "path", +"pattern": "^organizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/violations:batchAcknowledgeViolations", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsRequest" +}, +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"projects": { +"resources": { +"locations": { +"resources": { +"dbFindingSummaries": { +"methods": { +"list": { +"description": "Lists the finding summary by category for a given scope.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dbFindingSummaries", "httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.violations.list", +"id": "assuredworkloads.projects.locations.dbFindingSummaries.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "Optional. A custom filter for filtering by the Violations properties.", +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token that identifies the page of results that the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/dbFindingSummaries", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbFindingSummariesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"dbFrameworkComplianceReports": { +"methods": { +"aggregate": { +"description": "Gets the aggregated compliance report over time for a given scope.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", +"httpMethod": "GET", +"id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.aggregate", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "Optional. The filtering results.", "location": "query", "type": "string" }, "interval.endTime": { -"description": "The end of the time window.", +"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "format": "google-datetime", "location": "query", "type": "string" }, "interval.startTime": { -"description": "The start of the time window.", +"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", "format": "google-datetime", "location": "query", "type": "string" }, -"orderBy": { -"description": "Optional. Actionable sorting delegation.", +"name": { +"description": "Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:aggregate", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1AggregateDbFrameworkComplianceReportResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetch": { +"description": "Fetches the framework compliance report for a given scope.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", +"httpMethod": "GET", +"id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.fetch", +"parameterOrder": [ +"name" +], +"parameters": { +"endTime": { +"description": "Optional. The end time of the report.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the framework compliance report to retrieve.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:fetch", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1FetchDbFrameworkComplianceReportResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"dbControlComplianceSummaries": { +"methods": { +"list": { +"description": "Lists the control compliance summary for a given scope.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", +"httpMethod": "GET", +"id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The filtering results.", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. Page size.", +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. Page token returned from previous request.", +"description": "Optional. A token that identifies the page of results that the server should return.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`.", +"description": "Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/violations", +"path": "v1beta1/{+parent}/dbControlComplianceSummaries", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbControlComplianceSummariesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -760,34 +1450,60 @@ } } } -} -} }, -"violations": { +"dbFrameworkComplianceSummaries": { "methods": { -"batchAcknowledgeViolations": { -"description": "Acknowledges multiple existing violations. By acknowledging violations, users acknowledge the existence of compliance violations in their workload and decide to ignore them due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted. This is a batch version of AcknowledgeViolation.", -"flatPath": "v1beta1/organizations/{organizationsId}/violations:batchAcknowledgeViolations", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.violations.batchAcknowledgeViolations", +"list": { +"description": "Lists the framework compliance summary for a given scope.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceSummaries", +"httpMethod": "GET", +"id": "assuredworkloads.projects.locations.dbFrameworkComplianceSummaries.list", "parameterOrder": [ "parent" ], "parameters": { +"filter": { +"description": "Optional. The filtering results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.", +"location": "query", +"type": "string" +}, "parent": { -"description": "Optional. The parent resource shared by all violations being acknowledged. Format: organizations/{organization}/locations/{location}/workloads/{workload}", +"description": "Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location}", "location": "path", -"pattern": "^organizations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" -} }, -"path": "v1beta1/{+parent}/violations:batchAcknowledgeViolations", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsRequest" +"view": { +"description": "Optional. Specifies the level of detail to return in the response.", +"enum": [ +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", +"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the BASIC view.", +"Includes basic compliance metadata, but omits trend data.", +"Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." +], +"location": "query", +"type": "string" +} }, +"path": "v1beta1/{+parent}/dbFrameworkComplianceSummaries", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbFrameworkComplianceSummariesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -797,8 +1513,10 @@ } } } +} +} }, -"revision": "20260623", +"revision": "20260719", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -837,6 +1555,36 @@ "properties": {}, "type": "object" }, +"GoogleCloudAssuredworkloadsV1beta1AggregateDbFrameworkComplianceReportResponse": { +"description": "The response message for AggregateDbFrameworkComplianceReport.", +"id": "GoogleCloudAssuredworkloadsV1beta1AggregateDbFrameworkComplianceReportResponse", +"properties": { +"aggregatedComplianceReports": { +"description": "The list of aggregated compliance reports.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1AggregatedComplianceReport" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1AggregatedComplianceReport": { +"description": "The aggregated compliance report.", +"id": "GoogleCloudAssuredworkloadsV1beta1AggregatedComplianceReport", +"properties": { +"controlAssessmentDetails": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1ControlAssessmentDetails", +"description": "The control assessment details of the framework." +}, +"reportTime": { +"description": "The report time of the aggregated compliance report.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse": { "description": "Response containing the analysis results for the hypothetical resource move.", "id": "GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse", @@ -962,66 +1710,287 @@ }, "type": "object" }, -"GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis": { -"description": "Represents move analysis results for an asset.", -"id": "GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis", +"GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis": { +"description": "Represents move analysis results for an asset.", +"id": "GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis", +"properties": { +"analysisGroups": { +"description": "List of eligible analyses performed for the asset.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1MoveAnalysisGroup" +}, +"type": "array" +}, +"asset": { +"description": "The full resource name of the asset being analyzed. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1", +"type": "string" +}, +"assetType": { +"description": "Type of the asset being analyzed. Possible values will be among the ones listed [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsRequest": { +"description": "Request for acknowledging the violations in a batch", +"id": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsRequest", +"properties": { +"acknowledgeType": { +"description": "Optional. Acknowledge type of specified violations.", +"enum": [ +"ACKNOWLEDGE_TYPE_UNSPECIFIED", +"SINGLE_VIOLATION", +"EXISTING_CHILD_RESOURCE_VIOLATIONS" +], +"enumDescriptions": [ +"Acknowledge type unspecified.", +"Acknowledge only the specific violation.", +"Acknowledge specified orgPolicy violation and also associated resource violations." +], +"type": "string" +}, +"comment": { +"description": "Required. Business justification explaining the need for violations acknowledgement", +"type": "string" +}, +"names": { +"description": "Required. The resource names of the Violations to acknowledge. Format for each name: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsResponse": { +"description": "Response for batch violation acknowledgement", +"id": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsResponse", +"properties": { +"acknowledgedViolationsCount": { +"description": "Count of acknowledged violations.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1CELExpression": { +"description": "A Common Expression Language (CEL) expression that's used to create a rule.", +"id": "GoogleCloudAssuredworkloadsV1beta1CELExpression", +"properties": { +"expression": { +"description": "Required. The logical expression in CEL. The maximum length of the condition is 1000 characters. For more information, see [CEL expression](https://cloud.google.com/security-command-center/docs/compliance-manager-write-cel-expressions).", +"type": "string" +}, +"resourceTypesValues": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1StringList", +"description": "The resource instance types on which this expression is defined. The format is `/`. For example: `compute.googleapis.com/Instance`" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1CloudControlAssessmentDetails": { +"description": "The cloud control assessment details for non-manual cloud controls.", +"id": "GoogleCloudAssuredworkloadsV1beta1CloudControlAssessmentDetails", +"properties": { +"evaluationState": { +"description": "Output only. The evaluation status of the cloud control.", +"enum": [ +"EVALUATION_STATE_UNSPECIFIED", +"EVALUATION_STATE_PASSED", +"EVALUATION_STATE_FAILED", +"EVALUATION_STATE_NOT_ASSESSED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The control is passing.", +"The control is failing.", +"The control is not assessed." +], +"readOnly": true, +"type": "string" +}, +"findingsCount": { +"description": "The number of findings for the cloud control.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1CloudControlReport": { +"description": "The cloud control report.", +"id": "GoogleCloudAssuredworkloadsV1beta1CloudControlReport", "properties": { -"analysisGroups": { -"description": "List of eligible analyses performed for the asset.", +"categories": { +"description": "The list of categories for the cloud control.", "items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1MoveAnalysisGroup" +"type": "string" }, "type": "array" }, -"asset": { -"description": "The full resource name of the asset being analyzed. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1", +"cloudControl": { +"description": "The name of the cloud control.", "type": "string" }, -"assetType": { -"description": "Type of the asset being analyzed. Possible values will be among the ones listed [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", +"cloudControlAssessmentDetails": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1CloudControlAssessmentDetails", +"description": "The details of a cloud control assessment." +}, +"cloudControlDeployment": { +"description": "The name of the cloud control deployment.", "type": "string" -} }, -"type": "object" +"cloudControlType": { +"description": "The type of the cloud control.", +"enum": [ +"TYPE_UNSPECIFIED", +"CUSTOM", +"BUILT_IN" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"A cloud control that's created and managed by you.", +"A cloud control that's provided and managed by Google." +], +"type": "string" }, -"GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsRequest": { -"description": "Request for acknowledging the violations in a batch", -"id": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsRequest", -"properties": { -"acknowledgeType": { -"description": "Optional. Acknowledge type of specified violations.", +"description": { +"description": "The description of the cloud control.", +"type": "string" +}, +"displayName": { +"description": "The display name of the cloud control.", +"type": "string" +}, +"enforcementMode": { +"description": "The enforcement mode of the cloud control.", "enum": [ -"ACKNOWLEDGE_TYPE_UNSPECIFIED", -"SINGLE_VIOLATION", -"EXISTING_CHILD_RESOURCE_VIOLATIONS" +"ENFORCEMENT_MODE_UNSPECIFIED", +"PREVENTIVE", +"DETECTIVE", +"AUDIT" ], "enumDescriptions": [ -"Acknowledge type unspecified.", -"Acknowledge only the specific violation.", -"Acknowledge specified orgPolicy violation and also associated resource violations." +"Default value. This value is unused.", +"The cloud control is enforced to prevent non-compliance.", +"The cloud control is enforced to detect non-compliance.", +"The cloud control is enforced to audit for non-compliance." ], "type": "string" }, -"comment": { -"description": "Required. Business justification explaining the need for violations acknowledgement", +"findingCategory": { +"description": "The category of the finding.", "type": "string" }, -"names": { -"description": "Required. The resource names of the Violations to acknowledge. Format for each name: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}", +"findingSeverity": { +"description": "The severity of the finding.", +"enum": [ +"SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. A critical threat is a threat that can access, modify, or delete data or execute unauthorized code within existing resources.", +"A high-risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. A high-risk threat is a threat that can create new computational resources in an environment but can't access data or execute code in existing resources.", +"A medium-risk vulnerability can be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. A medium-risk threat can cause operational impact but might not access data or execute unauthorized code.", +"A low-risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. A low-risk threat is a threat that has obtained minimal access to an environment but can't access data, execute code, or create resources." +], +"type": "string" +}, +"frameworkMajorRevisionIds": { +"description": "The major revision IDs of the frameworks that the cloud control belongs to.", "items": { +"format": "int64", "type": "string" }, "type": "array" +}, +"majorRevisionId": { +"description": "The major revision ID of the cloud control.", +"format": "int64", +"type": "string" +}, +"manualCloudControlAssessmentDetails": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1ManualCloudControlAssessmentDetails", +"description": "The details of a manual cloud control assessment." +}, +"minorRevisionId": { +"description": "The minor revision ID of the cloud control.", +"format": "int64", +"type": "string" +}, +"rules": { +"description": "The list of rules that correspond to the cloud control.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1Rule" +}, +"type": "array" +}, +"similarControls": { +"description": "The list of similar controls.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1SimilarControls" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsResponse": { -"description": "Response for batch violation acknowledgement", -"id": "GoogleCloudAssuredworkloadsV1beta1BatchAcknowledgeViolationsResponse", +"GoogleCloudAssuredworkloadsV1beta1ControlAssessmentDetails": { +"description": "The details for a control assessment.", +"id": "GoogleCloudAssuredworkloadsV1beta1ControlAssessmentDetails", "properties": { -"acknowledgedViolationsCount": { -"description": "Count of acknowledged violations.", +"assessedPassingControlIds": { +"description": "The list of controls that were assessed and are passing.", +"items": { +"type": "string" +}, +"type": "array" +}, +"assessedPassingControls": { +"description": "The number of controls that were assessed and are passing.", +"format": "int32", +"type": "integer" +}, +"failingControlIds": { +"description": "The list of controls that are failing.", +"items": { +"type": "string" +}, +"type": "array" +}, +"failingControls": { +"description": "The number of controls that are failing.", +"format": "int32", +"type": "integer" +}, +"notAssessedControlIds": { +"description": "The list of controls that aren't assessed because they require manual review.", +"items": { +"type": "string" +}, +"type": "array" +}, +"notAssessedControls": { +"description": "The number of controls that aren't assessed because they require manual review.", +"format": "int32", +"type": "integer" +}, +"passingControlIds": { +"description": "The list of controls that are passing or not assessed.", +"items": { +"type": "string" +}, +"type": "array" +}, +"passingControls": { +"description": "The number of controls that are passing or not assessed.", "format": "int32", "type": "integer" } @@ -1131,72 +2100,348 @@ false, false ], "enumDescriptions": [ -"The default value. This value is used if the control package is omitted or unknown.", -"Specifies a [Sovereign Controls by Partners](https://cloud.google.com/sovereign-controls-by-partners/docs/overview) control package. To use this control package, you must also specify the partner field from the list of Sovereign Controls by Partners.", -"Australia Data Boundary and Support", -"Canada Data Boundary and Support", -"Data Boundary for Canada Controlled Goods", -"Data Boundary for Canada Protected B", -"Data Boundary for Criminal Justice Information Systems (CJIS)", -"Data Boundary for FedRAMP High", -"Data Boundary for FedRAMP Moderate", -"Data Boundary for Impact Level 2 (IL2)", -"Data Boundary for Impact Level 4 (IL4)", -"Data Boundary for Impact Level 5 (IL5)", -"Data Boundary for IRS Publication 1075", -"Data Boundary for International Traffic in Arms Regulations (ITAR)", -"European Union (EU) Data Boundary and Support", -"Israel Data Boundary and Support", -"Japan Data Boundary", -"Switzerland Data Boundary with Access Justifications", -"Kingdom of Saudi Arabia (KSA) Data Boundary with Access Justifications", -"Data boundary for one of Assured Workloads' *Free tier* control packages. Determines the region by specifying the data location during workload creation.", -"United States (US) Data Boundary and Support", -"United States (US) Data Boundary for Healthcare and Life Sciences", -"United States (US) Data Boundary for Healthcare and Life Sciences with Support", -"Use the AUSTRALIA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_CANADA_PROTECTED_B enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the CANADA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_CANADA_CONTROLLED_GOODS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_CJIS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the EU_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_FEDRAMP_HIGH enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_FEDRAMP_MODERATE enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", -"Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", -"Use the DATA_BOUNDARY_FOR_IL2 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_IL4 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_IL5 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_IRS_PUBLICATION_1075 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_ITAR enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the JAPAN_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the REGIONAL_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the US_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed." +"The default value. This value is used if the control package is omitted or unknown.", +"Specifies a [Sovereign Controls by Partners](https://cloud.google.com/sovereign-controls-by-partners/docs/overview) control package. To use this control package, you must also specify the partner field from the list of Sovereign Controls by Partners.", +"Australia Data Boundary and Support", +"Canada Data Boundary and Support", +"Data Boundary for Canada Controlled Goods", +"Data Boundary for Canada Protected B", +"Data Boundary for Criminal Justice Information Systems (CJIS)", +"Data Boundary for FedRAMP High", +"Data Boundary for FedRAMP Moderate", +"Data Boundary for Impact Level 2 (IL2)", +"Data Boundary for Impact Level 4 (IL4)", +"Data Boundary for Impact Level 5 (IL5)", +"Data Boundary for IRS Publication 1075", +"Data Boundary for International Traffic in Arms Regulations (ITAR)", +"European Union (EU) Data Boundary and Support", +"Israel Data Boundary and Support", +"Japan Data Boundary", +"Switzerland Data Boundary with Access Justifications", +"Kingdom of Saudi Arabia (KSA) Data Boundary with Access Justifications", +"Data boundary for one of Assured Workloads' *Free tier* control packages. Determines the region by specifying the data location during workload creation.", +"United States (US) Data Boundary and Support", +"United States (US) Data Boundary for Healthcare and Life Sciences", +"United States (US) Data Boundary for Healthcare and Life Sciences with Support", +"Use the AUSTRALIA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_CANADA_PROTECTED_B enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the CANADA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_CANADA_CONTROLLED_GOODS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_CJIS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the EU_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_FEDRAMP_HIGH enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_FEDRAMP_MODERATE enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", +"Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", +"Use the DATA_BOUNDARY_FOR_IL2 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_IL4 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_IL5 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_IRS_PUBLICATION_1075 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_ITAR enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the JAPAN_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the REGIONAL_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the US_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed." +], +"type": "string" +}, +"createTime": { +"description": "Optional. Time when the operation was created.", +"format": "google-datetime", +"type": "string" +}, +"displayName": { +"description": "Optional. The display name of the workload.", +"type": "string" +}, +"parent": { +"description": "Optional. The parent of the workload.", +"type": "string" +}, +"resourceSettings": { +"description": "Optional. Resource properties in the input that are used for creating/customizing workload resources.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1DbControlComplianceSummary": { +"description": "The details for control compliance.", +"id": "GoogleCloudAssuredworkloadsV1beta1DbControlComplianceSummary", +"properties": { +"cloudControlReports": { +"description": "The list of cloud control reports.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1CloudControlReport" +}, +"type": "array" +}, +"complianceFrameworks": { +"description": "The list of compliance frameworks that the control belongs to.", +"items": { +"type": "string" +}, +"type": "array" +}, +"control": { +"description": "The name of the control.", +"type": "string" +}, +"controlResponsibilityType": { +"description": "The responsibility type for the control.", +"enum": [ +"REGULATORY_CONTROL_RESPONSIBILITY_TYPE_UNSPECIFIED", +"GOOGLE", +"CUSTOMER", +"SHARED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Google's responsibility.", +"Your responsibility.", +"Shared responsibility." +], +"type": "string" +}, +"description": { +"description": "The description of the control.", +"type": "string" +}, +"displayName": { +"description": "The display name of the control.", +"type": "string" +}, +"isFakeControl": { +"description": "Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.", +"type": "boolean" +}, +"name": { +"description": "Identifier. The name of the control compliance summary.", +"type": "string" +}, +"overallEvaluationState": { +"description": "Output only. The overall evaluation status of the control.", +"enum": [ +"EVALUATION_STATE_UNSPECIFIED", +"EVALUATION_STATE_PASSED", +"EVALUATION_STATE_FAILED", +"EVALUATION_STATE_NOT_ASSESSED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The control is passing.", +"The control is failing.", +"The control is not assessed." +], +"readOnly": true, +"type": "string" +}, +"similarControls": { +"description": "The list of similar controls.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1SimilarControls" +}, +"type": "array" +}, +"totalFindingsCount": { +"description": "The total number of findings for the control.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1DbFindingSummary": { +"description": "The details for a finding.", +"id": "GoogleCloudAssuredworkloadsV1beta1DbFindingSummary", +"properties": { +"findingCategory": { +"description": "Output only. The category of the finding.", +"readOnly": true, +"type": "string" +}, +"findingClass": { +"description": "Output only. The class of the finding.", +"enum": [ +"FINDING_CLASS_UNSPECIFIED", +"THREAT", +"VULNERABILITY", +"MISCONFIGURATION", +"OBSERVATION", +"SCC_ERROR", +"POSTURE_VIOLATION", +"TOXIC_COMBINATION", +"SENSITIVE_DATA_RISK", +"CHOKEPOINT" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The activity is unwanted or malicious.", +"A potential weakness in software that increases risk to confidentiality, integrity, and availability.", +"A potential weakness in a cloud resource or asset configuration that increases risk.", +"A security observation that is for informational purposes.", +"An error that prevents Security Command Center from functioning properly.", +"A potential security risk that's due to a change in the security posture.", +"A combination of security issues that represent a more severe security problem when taken together.", +"A potential security risk to data assets that contain sensitive data.", +"A resource or resource group where high risk attack paths converge, based on attack path simulations (APS)." +], +"readOnly": true, +"type": "string" +}, +"findingCount": { +"description": "Output only. The count of the finding.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The name of the finding summary.", +"type": "string" +}, +"relatedFrameworks": { +"description": "Optional. The list of compliance frameworks that the finding belongs to.", +"items": { +"type": "string" +}, +"type": "array" +}, +"severity": { +"description": "Output only. The severity of the finding.", +"enum": [ +"SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. A critical threat is a threat that can access, modify, or delete data or execute unauthorized code within existing resources.", +"A high-risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. A high-risk threat is a threat that can create new computational resources in an environment but can't access data or execute code in existing resources.", +"A medium-risk vulnerability can be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. A medium-risk threat can cause operational impact but might not access data or execute unauthorized code.", +"A low-risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. A low-risk threat is a threat that has obtained minimal access to an environment but can't access data, execute code, or create resources." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The last updated time of the finding.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1DbFrameworkComplianceSummary": { +"description": "The details for a framework compliance summary.", +"id": "GoogleCloudAssuredworkloadsV1beta1DbFrameworkComplianceSummary", +"properties": { +"controlAssessmentDetails": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1ControlAssessmentDetails", +"description": "The control assessment details of the framework." +}, +"controlsPassingTrend": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1Trend", +"description": "Output only. The trend of controls that are passing for the given duration.", +"readOnly": true +}, +"findingCount": { +"description": "Output only. The count of the findings generated against the framework.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"framework": { +"description": "The name of the framework.", +"type": "string" +}, +"frameworkCategories": { +"description": "The list of framework categories supported by the framework.", +"items": { +"enum": [ +"FRAMEWORK_CATEGORY_UNSPECIFIED", +"INDUSTRY_DEFINED_STANDARD", +"ASSURED_WORKLOADS", +"DATA_SECURITY", +"GOOGLE_BEST_PRACTICES", +"CUSTOM_FRAMEWORK" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"An industry-defined framework.", +"An Assured Workloads framework.", +"A data security posture framework.", +"A Google's best practices framework.", +"A user-created framework." ], "type": "string" }, -"createTime": { -"description": "Optional. Time when the operation was created.", -"format": "google-datetime", +"type": "array" +}, +"frameworkDisplayName": { +"description": "Optional. The display name for the framework.", "type": "string" }, -"displayName": { -"description": "Optional. The display name of the workload.", +"frameworkType": { +"description": "The type of framework.", +"enum": [ +"FRAMEWORK_TYPE_UNSPECIFIED", +"BUILT_IN", +"CUSTOM" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"A framework that's provided and managed by Google.", +"A framework that's created and managed by you." +], "type": "string" }, -"parent": { -"description": "Optional. The parent of the workload.", +"majorRevisionId": { +"description": "The major revision ID of the framework.", +"format": "int64", "type": "string" }, -"resourceSettings": { -"description": "Optional. Resource properties in the input that are used for creating/customizing workload resources.", +"minorRevisionId": { +"description": "The minor revision ID of the framework.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Identifier. The name of the framework compliance summary.", +"type": "string" +}, +"supportedCloudProviders": { +"description": "The list of cloud providers supported by the framework.", "items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings" +"enum": [ +"CLOUD_PROVIDER_UNSPECIFIED", +"AWS", +"AZURE", +"GCP" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Amazon Web Services (AWS).", +"Microsoft Azure.", +"Google Cloud." +], +"type": "string" +}, +"type": "array" +}, +"targetResourceDetails": { +"description": "The target resource details for the framework.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1TargetResourceDetails" }, "type": "array" } @@ -1215,6 +2460,169 @@ false "properties": {}, "type": "object" }, +"GoogleCloudAssuredworkloadsV1beta1FetchDbFrameworkComplianceReportResponse": { +"description": "The response message for FetchDbFrameworkComplianceReport.", +"id": "GoogleCloudAssuredworkloadsV1beta1FetchDbFrameworkComplianceReportResponse", +"properties": { +"controlAssessmentDetails": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1ControlAssessmentDetails", +"description": "The control assessment details of the framework." +}, +"framework": { +"description": "The name of the framework.", +"type": "string" +}, +"frameworkCategories": { +"description": "The list of framework categories supported.", +"items": { +"enum": [ +"FRAMEWORK_CATEGORY_UNSPECIFIED", +"INDUSTRY_DEFINED_STANDARD", +"ASSURED_WORKLOADS", +"DATA_SECURITY", +"GOOGLE_BEST_PRACTICES", +"CUSTOM_FRAMEWORK" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"An industry-defined framework.", +"An Assured Workloads framework.", +"A data security posture framework.", +"A Google's best practices framework.", +"A user-created framework." +], +"type": "string" +}, +"type": "array" +}, +"frameworkDescription": { +"description": "The description of the framework.", +"type": "string" +}, +"frameworkDisplayName": { +"description": "Optional. The display name for the framework.", +"type": "string" +}, +"frameworkType": { +"description": "The type of the framework.", +"enum": [ +"FRAMEWORK_TYPE_UNSPECIFIED", +"BUILT_IN", +"CUSTOM" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"A framework that's provided and managed by Google.", +"A framework that's created and managed by you." +], +"type": "string" +}, +"majorRevisionId": { +"description": "The latest major revision ID of the framework.", +"format": "int64", +"type": "string" +}, +"minorRevisionId": { +"description": "The latest minor revision ID of the latest major revision of the framework.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "The name of the framework compliance report.", +"type": "string" +}, +"supportedCloudProviders": { +"description": "The list of cloud providers that are supported by the framework.", +"items": { +"enum": [ +"CLOUD_PROVIDER_UNSPECIFIED", +"AWS", +"AZURE", +"GCP" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Amazon Web Services (AWS).", +"Microsoft Azure.", +"Google Cloud." +], +"type": "string" +}, +"type": "array" +}, +"targetResourceDetails": { +"description": "The target resource details of the framework.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1TargetResourceDetails" +}, +"type": "array" +}, +"updateTime": { +"description": "Output only. The last updated time of the report.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1ListDbControlComplianceSummariesResponse": { +"description": "The response message for ListDBControlComplianceSummaries.", +"id": "GoogleCloudAssuredworkloadsV1beta1ListDbControlComplianceSummariesResponse", +"properties": { +"dbControlComplianceSummaries": { +"description": "The list of control compliance details.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1DbControlComplianceSummary" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Output only. The token to retrieve the next page of results.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1ListDbFindingSummariesResponse": { +"description": "The response message for ListDbFindingSummaries.", +"id": "GoogleCloudAssuredworkloadsV1beta1ListDbFindingSummariesResponse", +"properties": { +"dbFindingSummaries": { +"description": "List of finding summary by category.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1DbFindingSummary" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Output only. The token to retrieve the next page of results.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1ListDbFrameworkComplianceSummariesResponse": { +"description": "The response message for ListDbFrameworkComplianceSummariesResponse.", +"id": "GoogleCloudAssuredworkloadsV1beta1ListDbFrameworkComplianceSummariesResponse", +"properties": { +"dbFrameworkComplianceSummaries": { +"description": "The list of framework compliance summaries.", +"items": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1DbFrameworkComplianceSummary" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Output only. The token to retrieve the next page of results.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse": { "description": "Response of ListViolations endpoint.", "id": "GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse", @@ -1274,6 +2682,20 @@ false }, "type": "object" }, +"GoogleCloudAssuredworkloadsV1beta1ManualCloudControlAssessmentDetails": { +"description": "The details for a manual cloud control assessment.", +"id": "GoogleCloudAssuredworkloadsV1beta1ManualCloudControlAssessmentDetails", +"properties": { +"manualCloudControlGuide": { +"description": "The guide for assessing a cloud control manually.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAssuredworkloadsV1beta1MoveAnalysisGroup": { "description": "Represents a logical group of checks performed for an asset. If successful, the group contains the analysis result, otherwise it contains an error with the failure reason.", "id": "GoogleCloudAssuredworkloadsV1beta1MoveAnalysisGroup", @@ -1488,6 +2910,127 @@ false }, "type": "object" }, +"GoogleCloudAssuredworkloadsV1beta1Rule": { +"description": "A rule in the cloud control.", +"id": "GoogleCloudAssuredworkloadsV1beta1Rule", +"properties": { +"celExpression": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1CELExpression", +"description": "The rule's logic expression in Common Expression Language (CEL)." +}, +"description": { +"description": "Optional. The rule description. The maximum length is 2000 characters.", +"type": "string" +}, +"ruleActionTypes": { +"description": "Required. The functionality that's enabled by the rule.", +"items": { +"enum": [ +"RULE_ACTION_TYPE_UNSPECIFIED", +"RULE_ACTION_TYPE_PREVENTIVE", +"RULE_ACTION_TYPE_DETECTIVE", +"RULE_ACTION_TYPE_AUDIT" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The rule is intended to prevent non-compliance.", +"The rule is intended to detect non-compliance.", +"The rule is intended to audit non-compliance." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1SimilarControls": { +"description": "The similar controls.", +"id": "GoogleCloudAssuredworkloadsV1beta1SimilarControls", +"properties": { +"controlId": { +"description": "The ID of the control.", +"type": "string" +}, +"framework": { +"description": "The name of the framework.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1StringList": { +"description": "A list of strings for the parameter value.", +"id": "GoogleCloudAssuredworkloadsV1beta1StringList", +"properties": { +"values": { +"description": "Required. The strings in the list.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1TargetResourceDetails": { +"description": "The details for a target resource.", +"id": "GoogleCloudAssuredworkloadsV1beta1TargetResourceDetails", +"properties": { +"createTime": { +"description": "The create time of the target resource.", +"format": "google-datetime", +"type": "string" +}, +"frameworkDeployment": { +"description": "The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`", +"type": "string" +}, +"majorRevisionId": { +"description": "The major revision ID of the framework for the target resource.", +"format": "int64", +"type": "string" +}, +"minorRevisionId": { +"description": "The minor revision ID of the framework for the target resource.", +"format": "int64", +"type": "string" +}, +"targetResource": { +"description": "The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.", +"type": "string" +}, +"targetResourceDisplayName": { +"description": "The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.", +"type": "string" +}, +"updateTime": { +"description": "The update time of the target resource.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAssuredworkloadsV1beta1Trend": { +"description": "The trend of a compliance metric.", +"id": "GoogleCloudAssuredworkloadsV1beta1Trend", +"properties": { +"duration": { +"description": "Output only. The duration for the trend.", +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"valuePercent": { +"description": "Output only. The trend value as a percentage. The value can be positive or negative.", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudAssuredworkloadsV1beta1UpdateDetails": { "description": "The details of the update.", "id": "GoogleCloudAssuredworkloadsV1beta1UpdateDetails", From c8bc8ffcb800a39ce0bf5021b035d46fb4a7a555 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:59 +0000 Subject: [PATCH 16/84] feat(authorizedbuyersmarketplace): update the api #### authorizedbuyersmarketplace:v1alpha The following keys were added: - schemas.CuratedPackage.properties.curationFeeVisibility.type (Total Keys: 1) #### authorizedbuyersmarketplace:v1beta The following keys were added: - schemas.CuratedPackage.properties.curationFeeVisibility.type (Total Keys: 1) --- ...rketplace_v1alpha.buyers.dataSegments.html | 16 ++++++------- ...lace_v1alpha.curators.curatedPackages.html | 8 +++++++ ...place_v1beta.curators.curatedPackages.html | 8 +++++++ ...ketplace_v1beta.curators.dataSegments.html | 16 ++++++------- .../authorizedbuyersmarketplace.v1alpha.json | 24 +++++++++++++++---- .../authorizedbuyersmarketplace.v1beta.json | 24 +++++++++++++++---- 6 files changed, 72 insertions(+), 24 deletions(-) diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html index a578d4073a..83967db1a3 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html @@ -119,7 +119,7 @@

Method Details

Returns: An object of the form: - { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. + { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -147,7 +147,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. +{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -168,7 +168,7 @@

Method Details

Returns: An object of the form: - { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. + { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -202,7 +202,7 @@

Method Details

Returns: An object of the form: - { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. + { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -230,7 +230,7 @@

Method Details

Returns: An object of the form: - { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. + { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -262,7 +262,7 @@

Method Details

{ # Response message for listing data segments. "dataSegments": [ # The list of data segments. - { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. + { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -302,7 +302,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. +{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -324,7 +324,7 @@

Method Details

Returns: An object of the form: - { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. + { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.curators.curatedPackages.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.curators.curatedPackages.html index b4691b8bc6..55959fdfe3 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1alpha.curators.curatedPackages.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.curators.curatedPackages.html @@ -126,6 +126,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -292,6 +293,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -451,6 +453,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -623,6 +626,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -789,6 +793,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -960,6 +965,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -1138,6 +1144,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -1298,6 +1305,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. diff --git a/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.curatedPackages.html b/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.curatedPackages.html index 009bfe47ab..ea3ae536c9 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.curatedPackages.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.curatedPackages.html @@ -126,6 +126,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -292,6 +293,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -451,6 +453,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -623,6 +626,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -789,6 +793,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -960,6 +965,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -1138,6 +1144,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. @@ -1298,6 +1305,7 @@

Method Details

], }, "createTime": "A String", # Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + "curationFeeVisibility": "A String", # Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee). "description": "A String", # Optional. A description of the curated package, provided by the curator. "displayName": "A String", # Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. "feeCpm": { # Represents an amount of money with its currency type. # Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. diff --git a/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.dataSegments.html b/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.dataSegments.html index 0a3195ea64..98c16f1e5a 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.dataSegments.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.dataSegments.html @@ -119,7 +119,7 @@

Method Details

Returns: An object of the form: - { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. + { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -147,7 +147,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. +{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -168,7 +168,7 @@

Method Details

Returns: An object of the form: - { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. + { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -202,7 +202,7 @@

Method Details

Returns: An object of the form: - { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. + { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -230,7 +230,7 @@

Method Details

Returns: An object of the form: - { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. + { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -262,7 +262,7 @@

Method Details

{ # Response message for listing data segments. "dataSegments": [ # The list of data segments. - { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. + { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -302,7 +302,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. +{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -324,7 +324,7 @@

Method Details

Returns: An object of the form: - { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. + { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 -- "cpmFee": { # Represents an amount of money with its currency type. # Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json index 7811ad87f3..f937724e1f 100644 --- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json @@ -1806,7 +1806,7 @@ } } }, -"revision": "20260708", +"revision": "20260723", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { @@ -2263,6 +2263,20 @@ "readOnly": true, "type": "string" }, +"curationFeeVisibility": { +"description": "Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee).", +"enum": [ +"CURATION_FEE_VISIBILITY_UNSPECIFIED", +"DISCLOSED", +"NON_DISCLOSED" +], +"enumDescriptions": [ +"The total curation fee visibility is unspecified.", +"The total curation fee is visible to all buyers. This is the default value if not set.", +"The total curation fee is not visible to all buyers." +], +"type": "string" +}, "description": { "description": "Optional. A description of the curated package, provided by the curator.", "type": "string" @@ -2317,7 +2331,7 @@ "type": "object" }, "DataSegment": { -"description": "Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.", +"description": "Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 --", "id": "DataSegment", "properties": { "cpmFee": { @@ -2344,12 +2358,14 @@ "enum": [ "STATE_UNSPECIFIED", "ACTIVE", -"INACTIVE" +"INACTIVE", +"SUSPENDED" ], "enumDescriptions": [ "Default value.", "The data segment is active.", -"The data segment is inactive." +"The data segment is inactive.", +"The data segment is suspended and cannot be activated." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json index f88e8114b6..4c9b862fb4 100644 --- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json @@ -517,7 +517,7 @@ } } }, -"revision": "20260708", +"revision": "20260723", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AccessControlSettings": { @@ -618,6 +618,20 @@ "readOnly": true, "type": "string" }, +"curationFeeVisibility": { +"description": "Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee).", +"enum": [ +"CURATION_FEE_VISIBILITY_UNSPECIFIED", +"DISCLOSED", +"NON_DISCLOSED" +], +"enumDescriptions": [ +"The total curation fee visibility is unspecified.", +"The total curation fee is visible to all buyers. This is the default value if not set.", +"The total curation fee is not visible to all buyers." +], +"type": "string" +}, "description": { "description": "Optional. A description of the curated package, provided by the curator.", "type": "string" @@ -672,7 +686,7 @@ "type": "object" }, "DataSegment": { -"description": "Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.", +"description": "Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 --", "id": "DataSegment", "properties": { "cpmFee": { @@ -699,12 +713,14 @@ "enum": [ "STATE_UNSPECIFIED", "ACTIVE", -"INACTIVE" +"INACTIVE", +"SUSPENDED" ], "enumDescriptions": [ "Default value.", "The data segment is active.", -"The data segment is inactive." +"The data segment is inactive.", +"The data segment is suspended and cannot be activated." ], "readOnly": true, "type": "string" From efd79793b9c01594edc2aeec539c1b97bb1a200b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:59 +0000 Subject: [PATCH 17/84] feat(batch): update the api #### batch:v1 The following keys were added: - schemas.NetworkInterface.properties.nicType.type (Total Keys: 1) --- .../dyn/batch_v1.projects.locations.jobs.html | 12 +++++++---- .../discovery_cache/documents/batch.v1.json | 20 +++++++++++++++++-- 2 files changed, 26 insertions(+), 6 deletions(-) diff --git a/docs/dyn/batch_v1.projects.locations.jobs.html b/docs/dyn/batch_v1.projects.locations.jobs.html index 0ad7bb5f82..4ab4ace307 100644 --- a/docs/dyn/batch_v1.projects.locations.jobs.html +++ b/docs/dyn/batch_v1.projects.locations.jobs.html @@ -205,7 +205,7 @@

Method Details

"a_key": "A String", }, "location": { # Location where compute resources should be allocated for the Job. - "allowedLocations": [ # A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. Mixing locations from different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains locations from two distinct regions: us-central1 and us-west1. This combination will trigger an error. + "allowedLocations": [ # A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, `["regions/us-central1"]` allow VMs in any zones in region `us-central1`, and `["zones/us-central1-a", "zones/us-central1-c"]` only allow VMs in zones `us-central1-a` and `us-central1-c`. However, `["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"]` causes an error because it contains multiple regions (`us-central1` and `us-west1`). The specified region or zones must be in the same region in which the job is created starting on the following dates: + For projects that have successfully submitted before July 31, 2026 at least one job that uses the `allowedLocations[]` field with any region or zones outside of the job's location, the changes are starting on _June 30, 2027_. + For all other projects, the changes are starting on _July 31, 2026_. For example, for job `projects/123/locations/us-central1/jobs/jobid`, the specified region or zones must be in `us-central1`. Using a different region (e.g. `regions/us-west1`) or a zone not in `us-central1` (e.g. `zones/us-west1-a`) causes an error. "A String", ], }, @@ -213,6 +213,7 @@

Method Details

"networkInterfaces": [ # Network configurations. { # A network interface. "network": "A String", # The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network} + "nicType": "A String", # Optional. The NIC type of the network interface. "noExternalIpAddress": True or False, # Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information. "subnetwork": "A String", # The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork} }, @@ -475,7 +476,7 @@

Method Details

"a_key": "A String", }, "location": { # Location where compute resources should be allocated for the Job. - "allowedLocations": [ # A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. Mixing locations from different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains locations from two distinct regions: us-central1 and us-west1. This combination will trigger an error. + "allowedLocations": [ # A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, `["regions/us-central1"]` allow VMs in any zones in region `us-central1`, and `["zones/us-central1-a", "zones/us-central1-c"]` only allow VMs in zones `us-central1-a` and `us-central1-c`. However, `["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"]` causes an error because it contains multiple regions (`us-central1` and `us-west1`). The specified region or zones must be in the same region in which the job is created starting on the following dates: + For projects that have successfully submitted before July 31, 2026 at least one job that uses the `allowedLocations[]` field with any region or zones outside of the job's location, the changes are starting on _June 30, 2027_. + For all other projects, the changes are starting on _July 31, 2026_. For example, for job `projects/123/locations/us-central1/jobs/jobid`, the specified region or zones must be in `us-central1`. Using a different region (e.g. `regions/us-west1`) or a zone not in `us-central1` (e.g. `zones/us-west1-a`) causes an error. "A String", ], }, @@ -483,6 +484,7 @@

Method Details

"networkInterfaces": [ # Network configurations. { # A network interface. "network": "A String", # The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network} + "nicType": "A String", # Optional. The NIC type of the network interface. "noExternalIpAddress": True or False, # Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information. "subnetwork": "A String", # The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork} }, @@ -787,7 +789,7 @@

Method Details

"a_key": "A String", }, "location": { # Location where compute resources should be allocated for the Job. - "allowedLocations": [ # A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. Mixing locations from different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains locations from two distinct regions: us-central1 and us-west1. This combination will trigger an error. + "allowedLocations": [ # A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, `["regions/us-central1"]` allow VMs in any zones in region `us-central1`, and `["zones/us-central1-a", "zones/us-central1-c"]` only allow VMs in zones `us-central1-a` and `us-central1-c`. However, `["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"]` causes an error because it contains multiple regions (`us-central1` and `us-west1`). The specified region or zones must be in the same region in which the job is created starting on the following dates: + For projects that have successfully submitted before July 31, 2026 at least one job that uses the `allowedLocations[]` field with any region or zones outside of the job's location, the changes are starting on _June 30, 2027_. + For all other projects, the changes are starting on _July 31, 2026_. For example, for job `projects/123/locations/us-central1/jobs/jobid`, the specified region or zones must be in `us-central1`. Using a different region (e.g. `regions/us-west1`) or a zone not in `us-central1` (e.g. `zones/us-west1-a`) causes an error. "A String", ], }, @@ -795,6 +797,7 @@

Method Details

"networkInterfaces": [ # Network configurations. { # A network interface. "network": "A String", # The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network} + "nicType": "A String", # Optional. The NIC type of the network interface. "noExternalIpAddress": True or False, # Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information. "subnetwork": "A String", # The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork} }, @@ -1068,7 +1071,7 @@

Method Details

"a_key": "A String", }, "location": { # Location where compute resources should be allocated for the Job. - "allowedLocations": [ # A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. Mixing locations from different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains locations from two distinct regions: us-central1 and us-west1. This combination will trigger an error. + "allowedLocations": [ # A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, `["regions/us-central1"]` allow VMs in any zones in region `us-central1`, and `["zones/us-central1-a", "zones/us-central1-c"]` only allow VMs in zones `us-central1-a` and `us-central1-c`. However, `["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"]` causes an error because it contains multiple regions (`us-central1` and `us-west1`). The specified region or zones must be in the same region in which the job is created starting on the following dates: + For projects that have successfully submitted before July 31, 2026 at least one job that uses the `allowedLocations[]` field with any region or zones outside of the job's location, the changes are starting on _June 30, 2027_. + For all other projects, the changes are starting on _July 31, 2026_. For example, for job `projects/123/locations/us-central1/jobs/jobid`, the specified region or zones must be in `us-central1`. Using a different region (e.g. `regions/us-west1`) or a zone not in `us-central1` (e.g. `zones/us-west1-a`) causes an error. "A String", ], }, @@ -1076,6 +1079,7 @@

Method Details

"networkInterfaces": [ # Network configurations. { # A network interface. "network": "A String", # The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network} + "nicType": "A String", # Optional. The NIC type of the network interface. "noExternalIpAddress": True or False, # Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information. "subnetwork": "A String", # The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork} }, diff --git a/googleapiclient/discovery_cache/documents/batch.v1.json b/googleapiclient/discovery_cache/documents/batch.v1.json index 17498083d8..1c08c72063 100644 --- a/googleapiclient/discovery_cache/documents/batch.v1.json +++ b/googleapiclient/discovery_cache/documents/batch.v1.json @@ -600,7 +600,7 @@ } } }, -"revision": "20260429", +"revision": "20260723", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -1712,7 +1712,7 @@ false "id": "LocationPolicy", "properties": { "allowedLocations": { -"description": "A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, [\"regions/us-central1\"] allow VMs in any zones in region us-central1. [\"zones/us-central1-a\", \"zones/us-central1-c\"] only allow VMs in zones us-central1-a and us-central1-c. Mixing locations from different regions would cause errors. For example, [\"regions/us-central1\", \"zones/us-central1-a\", \"zones/us-central1-b\", \"zones/us-west1-a\"] contains locations from two distinct regions: us-central1 and us-west1. This combination will trigger an error.", +"description": "A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, `[\"regions/us-central1\"]` allow VMs in any zones in region `us-central1`, and `[\"zones/us-central1-a\", \"zones/us-central1-c\"]` only allow VMs in zones `us-central1-a` and `us-central1-c`. However, `[\"regions/us-central1\", \"zones/us-central1-a\", \"zones/us-central1-b\", \"zones/us-west1-a\"]` causes an error because it contains multiple regions (`us-central1` and `us-west1`). The specified region or zones must be in the same region in which the job is created starting on the following dates: + For projects that have successfully submitted before July 31, 2026 at least one job that uses the `allowedLocations[]` field with any region or zones outside of the job's location, the changes are starting on _June 30, 2027_. + For all other projects, the changes are starting on _July 31, 2026_. For example, for job `projects/123/locations/us-central1/jobs/jobid`, the specified region or zones must be in `us-central1`. Using a different region (e.g. `regions/us-west1`) or a zone not in `us-central1` (e.g. `zones/us-west1-a`) causes an error.", "items": { "type": "string" }, @@ -1842,6 +1842,22 @@ false "description": "The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}", "type": "string" }, +"nicType": { +"description": "Optional. The NIC type of the network interface.", +"enum": [ +"NIC_TYPE_UNSPECIFIED", +"GVNIC", +"IRDMA", +"MRDMA" +], +"enumDescriptions": [ +"No type specified.", +"GVNIC", +"IRDMA", +"MRDMA" +], +"type": "string" +}, "noExternalIpAddress": { "description": "Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.", "type": "boolean" From beba5f83dd0bb62744c3634165a6b843a56b64fe Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:59 +0000 Subject: [PATCH 18/84] feat(beyondcorp): update the api #### beyondcorp:v1 The following keys were added: - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders.properties.dispatchInfo.$ref (Total Keys: 1) - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDispatchInfo (Total Keys: 3) #### beyondcorp:v1alpha The following keys were added: - schemas.GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription.properties.signupSource.type (Total Keys: 1) - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeaders.properties.dispatchInfo.$ref (Total Keys: 1) - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedDispatchInfo (Total Keys: 3) --- ...cations.securityGateways.applications.html | 12 +++++++ ...1.projects.locations.securityGateways.html | 12 +++++++ ...organizations.locations.subscriptions.html | 6 ++++ ...cations.securityGateways.applications.html | 12 +++++++ ...a.projects.locations.securityGateways.html | 12 +++++++ .../documents/beyondcorp.v1.json | 29 +++++++++++++++- .../documents/beyondcorp.v1alpha.json | 33 ++++++++++++++++++- 7 files changed, 114 insertions(+), 2 deletions(-) diff --git a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html index 04e9efce71..7a50a2c222 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html @@ -160,6 +160,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, @@ -300,6 +303,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, @@ -427,6 +433,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, @@ -515,6 +524,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, diff --git a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html index e9f5ffb13b..019b77cd81 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html @@ -152,6 +152,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, @@ -286,6 +289,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, @@ -408,6 +414,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, @@ -489,6 +498,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, diff --git a/docs/dyn/beyondcorp_v1alpha.organizations.locations.subscriptions.html b/docs/dyn/beyondcorp_v1alpha.organizations.locations.subscriptions.html index 0ede83edbb..416138af17 100644 --- a/docs/dyn/beyondcorp_v1alpha.organizations.locations.subscriptions.html +++ b/docs/dyn/beyondcorp_v1alpha.organizations.locations.subscriptions.html @@ -141,6 +141,7 @@

Method Details

"endTime": "A String", # Optional. End time of the subscription. "name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription. "seatCount": "A String", # Optional. Number of seats in the subscription. + "signupSource": "A String", # Optional. Input only. The source from which the subscription was initiated, for example "admin-console-browser-overview" or "admin-console-security-insights". "sku": "A String", # Required. SKU of subscription. "startTime": "A String", # Optional. Start time of the subscription. "state": "A String", # Output only. The current state of the subscription. @@ -164,6 +165,7 @@

Method Details

"endTime": "A String", # Optional. End time of the subscription. "name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription. "seatCount": "A String", # Optional. Number of seats in the subscription. + "signupSource": "A String", # Optional. Input only. The source from which the subscription was initiated, for example "admin-console-browser-overview" or "admin-console-security-insights". "sku": "A String", # Required. SKU of subscription. "startTime": "A String", # Optional. Start time of the subscription. "state": "A String", # Output only. The current state of the subscription. @@ -194,6 +196,7 @@

Method Details

"endTime": "A String", # Optional. End time of the subscription. "name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription. "seatCount": "A String", # Optional. Number of seats in the subscription. + "signupSource": "A String", # Optional. Input only. The source from which the subscription was initiated, for example "admin-console-browser-overview" or "admin-console-security-insights". "sku": "A String", # Required. SKU of subscription. "startTime": "A String", # Optional. Start time of the subscription. "state": "A String", # Output only. The current state of the subscription. @@ -229,6 +232,7 @@

Method Details

"endTime": "A String", # Optional. End time of the subscription. "name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription. "seatCount": "A String", # Optional. Number of seats in the subscription. + "signupSource": "A String", # Optional. Input only. The source from which the subscription was initiated, for example "admin-console-browser-overview" or "admin-console-security-insights". "sku": "A String", # Required. SKU of subscription. "startTime": "A String", # Optional. Start time of the subscription. "state": "A String", # Output only. The current state of the subscription. @@ -270,6 +274,7 @@

Method Details

"endTime": "A String", # Optional. End time of the subscription. "name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription. "seatCount": "A String", # Optional. Number of seats in the subscription. + "signupSource": "A String", # Optional. Input only. The source from which the subscription was initiated, for example "admin-console-browser-overview" or "admin-console-security-insights". "sku": "A String", # Required. SKU of subscription. "startTime": "A String", # Optional. Start time of the subscription. "state": "A String", # Output only. The current state of the subscription. @@ -295,6 +300,7 @@

Method Details

"endTime": "A String", # Optional. End time of the subscription. "name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription. "seatCount": "A String", # Optional. Number of seats in the subscription. + "signupSource": "A String", # Optional. Input only. The source from which the subscription was initiated, for example "admin-console-browser-overview" or "admin-console-security-insights". "sku": "A String", # Required. SKU of subscription. "startTime": "A String", # Optional. Start time of the subscription. "state": "A String", # Output only. The current state of the subscription. diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html index 74ae0bde2a..0a7665ee37 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html @@ -160,6 +160,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, @@ -300,6 +303,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, @@ -427,6 +433,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, @@ -515,6 +524,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html index 002e7bdef6..1df92638f0 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html @@ -152,6 +152,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, @@ -286,6 +289,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, @@ -408,6 +414,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, @@ -489,6 +498,9 @@

Method Details

"deviceInfo": { # The delegated device information configuration. # Optional. The device information configuration. "outputType": "A String", # Optional. The output type details for the delegated device. }, + "dispatchInfo": { # The delegated dispatch information configuration. # Optional. The dispatch information configuration. + "outputType": "A String", # Optional. The output type details for the delegated dispatch information. + }, "groupInfo": { # The delegated group configuration details. # Optional. Group details. "outputType": "A String", # Optional. The output type of the delegated group information. }, diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json index 92e8251763..605fab5b75 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json @@ -1909,7 +1909,7 @@ } } }, -"revision": "20260429", +"revision": "20260722", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -3253,6 +3253,10 @@ "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo", "description": "Optional. The device information configuration." }, +"dispatchInfo": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDispatchInfo", +"description": "Optional. The dispatch information configuration." +}, "groupInfo": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo", "description": "Optional. Group details." @@ -3303,6 +3307,29 @@ }, "type": "object" }, +"GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDispatchInfo": { +"description": "The delegated dispatch information configuration.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDispatchInfo", +"properties": { +"outputType": { +"description": "Optional. The output type details for the delegated dispatch information.", +"enum": [ +"OUTPUT_TYPE_UNSPECIFIED", +"PROTOBUF", +"JSON", +"NONE" +], +"enumDescriptions": [ +"The unspecified output type.", +"Protobuf output type.", +"JSON output type.", +"Explicitly disable header output." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo": { "description": "The delegated group configuration details.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo", diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json index e23b7593b4..6b26585988 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json @@ -3332,7 +3332,7 @@ } } }, -"revision": "20260429", +"revision": "20260722", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -5184,6 +5184,10 @@ "format": "int64", "type": "string" }, +"signupSource": { +"description": "Optional. Input only. The source from which the subscription was initiated, for example \"admin-console-browser-overview\" or \"admin-console-security-insights\".", +"type": "string" +}, "sku": { "description": "Required. SKU of subscription.", "enum": [ @@ -5409,6 +5413,10 @@ "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedDeviceInfo", "description": "Optional. The device information configuration." }, +"dispatchInfo": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedDispatchInfo", +"description": "Optional. The dispatch information configuration." +}, "groupInfo": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedGroupInfo", "description": "Optional. Group details." @@ -5459,6 +5467,29 @@ }, "type": "object" }, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedDispatchInfo": { +"description": "The delegated dispatch information configuration.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedDispatchInfo", +"properties": { +"outputType": { +"description": "Optional. The output type details for the delegated dispatch information.", +"enum": [ +"OUTPUT_TYPE_UNSPECIFIED", +"PROTOBUF", +"JSON", +"NONE" +], +"enumDescriptions": [ +"The unspecified output type.", +"Protobuf output type.", +"JSON output type.", +"Explicitly disable header output." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedGroupInfo": { "description": "The delegated group configuration details.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedGroupInfo", From 13048021f112356ee9826a5894d1e93d9c08ee69 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:59 +0000 Subject: [PATCH 19/84] feat(biglake): update the api #### biglake:v1 The following keys were added: - endpoints (Total Keys: 1) --- .../discovery_cache/documents/biglake.v1.json | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/biglake.v1.json b/googleapiclient/discovery_cache/documents/biglake.v1.json index d9584aba6f..c1f744fae2 100644 --- a/googleapiclient/discovery_cache/documents/biglake.v1.json +++ b/googleapiclient/discovery_cache/documents/biglake.v1.json @@ -18,6 +18,13 @@ "description": "The Lakehouse API (formerly BigLake API) provides access to a serverless, fully managed, and highly available metastore that provides a single source of truth for your data lakehouse. It lets multiple engines\u2014including Apache Spark, Google Managed Spark, Apache Flink, Trino and BigQuery\u2014share tables and metadata for key open formats (Apache Iceberg, Apache Hive), and query the same copy of data. Plus, through the Lakehouse runtime catalog federation seamlessly unite your lakehouse ecosystem, letting Iceberg compatible engines on Google Cloud (BigQuery, Google Managed Spark) discover and analyze enterprise data across Snowflake, Databricks, and AWS Glue.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/products/lakehouse", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://biglake.us-central1.rep.googleapis.com/", +"location": "us-central1" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -902,7 +909,7 @@ } } }, -"revision": "20260625", +"revision": "20260724", "rootUrl": "https://biglake.googleapis.com/", "schemas": { "AuditConfig": { From 40a58566cfe411bea5fd1dc46e6d758d75ba0254 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:59 +0000 Subject: [PATCH 20/84] feat(bigquery): update the api #### bigquery:v2 The following keys were added: - schemas.Argument.properties.tableType.$ref (Total Keys: 1) - schemas.JobStatistics.properties.globalQueryRemoteRegions (Total Keys: 3) - schemas.JobStatistics.properties.parentGlobalQueryJob (Total Keys: 2) - schemas.JobStatistics2.properties.objectStorageStats (Total Keys: 3) - schemas.JobStatistics5.properties.remoteDestinationRegion (Total Keys: 2) - schemas.ObjectStorageStats (Total Keys: 7) --- docs/dyn/bigquery_v2.jobs.html | 92 +++++++++++++++++-- docs/dyn/bigquery_v2.routines.html | 48 ++++++++++ .../documents/bigquery.v2.json | 77 +++++++++++++++- 3 files changed, 206 insertions(+), 11 deletions(-) diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 4243d79d83..2f7241fe7a 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -624,7 +624,7 @@

Method Details

"writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, - "reservation": "A String", # Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. + "reservation": "A String", # Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`, which requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`. }, "etag": "A String", # Output only. A hash of this resource. "id": "A String", # Output only. Opaque ID field of the job. @@ -644,6 +644,7 @@

Method Details

"copy": { # Statistics for a copy job. # Output only. Statistics for a copy job. "copiedLogicalBytes": "A String", # Output only. Number of logical bytes copied to the destination table. "copiedRows": "A String", # Output only. Number of rows copied to the destination table. + "remoteDestinationRegion": "A String", # Output only. Destination region for a cross-region copy job. Not set for in-region copy jobs. }, "creationTime": "A String", # Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. "dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs. @@ -669,6 +670,9 @@

Method Details

], }, "finalExecutionDurationMs": "A String", # Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job. + "globalQueryRemoteRegions": [ # Output only. Regions where the global query accesses data. + "A String", + ], "load": { # Statistics for a load job. # Output only. Statistics for a load job. "badRecords": "A String", # Output only. The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. "inputFileBytes": "A String", # Output only. Number of bytes of source data in a load job. @@ -688,6 +692,11 @@

Method Details

], }, "numChildJobs": "A String", # Output only. Number of child jobs executed. + "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. The global query that created this job. + "jobId": "A String", # Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. + "location": "A String", # Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations + "projectId": "A String", # Required. The ID of the project containing this job. + }, "parentJobId": "A String", # Output only. If this is a child job, specifies the job ID of the parent. "query": { # Statistics for a query job. # Output only. Statistics for a query job. "biEngineStatistics": { # Statistics for a BI Engine specific query. Populated as part of JobStatistics2 # Output only. BI Engine specific Statistics. @@ -1344,6 +1353,13 @@

Method Details

"modelTrainingCurrentIteration": 42, # Deprecated. "modelTrainingExpectedTotalIteration": "A String", # Deprecated. "numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. + "objectStorageStats": [ # Output only. Storage and caching statistics per cloud provider for queries over object storage. + { # Storage and caching statistics for object storage. + "cacheBytesRead": "A String", # Total bytes read from the GCP Lakehouse-internal cache, avoiding an object storage read. + "cloudProvider": "A String", # The cloud provider for this block of statistics. + "objectStorageBytesRead": "A String", # Total bytes read directly from the cloud provider's storage. + }, + ], "performanceInsights": { # Performance insights for the job. # Output only. Performance insights. "avgPreviousExecutionMs": "A String", # Output only. Average execution ms of previous runs. Indicates the job ran slow compared to previous executions. To find previous executions, use INFORMATION_SCHEMA tables and filter jobs with same query hash. "stagePerformanceChangeInsights": [ # Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression. @@ -2260,7 +2276,7 @@

Method Details

"writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, - "reservation": "A String", # Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. + "reservation": "A String", # Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`, which requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`. }, "etag": "A String", # Output only. A hash of this resource. "id": "A String", # Output only. Opaque ID field of the job. @@ -2280,6 +2296,7 @@

Method Details

"copy": { # Statistics for a copy job. # Output only. Statistics for a copy job. "copiedLogicalBytes": "A String", # Output only. Number of logical bytes copied to the destination table. "copiedRows": "A String", # Output only. Number of rows copied to the destination table. + "remoteDestinationRegion": "A String", # Output only. Destination region for a cross-region copy job. Not set for in-region copy jobs. }, "creationTime": "A String", # Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. "dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs. @@ -2305,6 +2322,9 @@

Method Details

], }, "finalExecutionDurationMs": "A String", # Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job. + "globalQueryRemoteRegions": [ # Output only. Regions where the global query accesses data. + "A String", + ], "load": { # Statistics for a load job. # Output only. Statistics for a load job. "badRecords": "A String", # Output only. The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. "inputFileBytes": "A String", # Output only. Number of bytes of source data in a load job. @@ -2324,6 +2344,11 @@

Method Details

], }, "numChildJobs": "A String", # Output only. Number of child jobs executed. + "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. The global query that created this job. + "jobId": "A String", # Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. + "location": "A String", # Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations + "projectId": "A String", # Required. The ID of the project containing this job. + }, "parentJobId": "A String", # Output only. If this is a child job, specifies the job ID of the parent. "query": { # Statistics for a query job. # Output only. Statistics for a query job. "biEngineStatistics": { # Statistics for a BI Engine specific query. Populated as part of JobStatistics2 # Output only. BI Engine specific Statistics. @@ -2980,6 +3005,13 @@

Method Details

"modelTrainingCurrentIteration": 42, # Deprecated. "modelTrainingExpectedTotalIteration": "A String", # Deprecated. "numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. + "objectStorageStats": [ # Output only. Storage and caching statistics per cloud provider for queries over object storage. + { # Storage and caching statistics for object storage. + "cacheBytesRead": "A String", # Total bytes read from the GCP Lakehouse-internal cache, avoiding an object storage read. + "cloudProvider": "A String", # The cloud provider for this block of statistics. + "objectStorageBytesRead": "A String", # Total bytes read directly from the cloud provider's storage. + }, + ], "performanceInsights": { # Performance insights for the job. # Output only. Performance insights. "avgPreviousExecutionMs": "A String", # Output only. Average execution ms of previous runs. Indicates the job ran slow compared to previous executions. To find previous executions, use INFORMATION_SCHEMA tables and filter jobs with same query hash. "stagePerformanceChangeInsights": [ # Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression. @@ -4004,7 +4036,7 @@

Method Details

"writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, - "reservation": "A String", # Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. + "reservation": "A String", # Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`, which requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`. }, "etag": "A String", # Output only. A hash of this resource. "id": "A String", # Output only. Opaque ID field of the job. @@ -4024,6 +4056,7 @@

Method Details

"copy": { # Statistics for a copy job. # Output only. Statistics for a copy job. "copiedLogicalBytes": "A String", # Output only. Number of logical bytes copied to the destination table. "copiedRows": "A String", # Output only. Number of rows copied to the destination table. + "remoteDestinationRegion": "A String", # Output only. Destination region for a cross-region copy job. Not set for in-region copy jobs. }, "creationTime": "A String", # Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. "dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs. @@ -4049,6 +4082,9 @@

Method Details

], }, "finalExecutionDurationMs": "A String", # Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job. + "globalQueryRemoteRegions": [ # Output only. Regions where the global query accesses data. + "A String", + ], "load": { # Statistics for a load job. # Output only. Statistics for a load job. "badRecords": "A String", # Output only. The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. "inputFileBytes": "A String", # Output only. Number of bytes of source data in a load job. @@ -4068,6 +4104,11 @@

Method Details

], }, "numChildJobs": "A String", # Output only. Number of child jobs executed. + "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. The global query that created this job. + "jobId": "A String", # Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. + "location": "A String", # Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations + "projectId": "A String", # Required. The ID of the project containing this job. + }, "parentJobId": "A String", # Output only. If this is a child job, specifies the job ID of the parent. "query": { # Statistics for a query job. # Output only. Statistics for a query job. "biEngineStatistics": { # Statistics for a BI Engine specific query. Populated as part of JobStatistics2 # Output only. BI Engine specific Statistics. @@ -4724,6 +4765,13 @@

Method Details

"modelTrainingCurrentIteration": 42, # Deprecated. "modelTrainingExpectedTotalIteration": "A String", # Deprecated. "numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. + "objectStorageStats": [ # Output only. Storage and caching statistics per cloud provider for queries over object storage. + { # Storage and caching statistics for object storage. + "cacheBytesRead": "A String", # Total bytes read from the GCP Lakehouse-internal cache, avoiding an object storage read. + "cloudProvider": "A String", # The cloud provider for this block of statistics. + "objectStorageBytesRead": "A String", # Total bytes read directly from the cloud provider's storage. + }, + ], "performanceInsights": { # Performance insights for the job. # Output only. Performance insights. "avgPreviousExecutionMs": "A String", # Output only. Average execution ms of previous runs. Indicates the job ran slow compared to previous executions. To find previous executions, use INFORMATION_SCHEMA tables and filter jobs with same query hash. "stagePerformanceChangeInsights": [ # Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression. @@ -5611,7 +5659,7 @@

Method Details

"writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, - "reservation": "A String", # Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. + "reservation": "A String", # Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`, which requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`. }, "etag": "A String", # Output only. A hash of this resource. "id": "A String", # Output only. Opaque ID field of the job. @@ -5631,6 +5679,7 @@

Method Details

"copy": { # Statistics for a copy job. # Output only. Statistics for a copy job. "copiedLogicalBytes": "A String", # Output only. Number of logical bytes copied to the destination table. "copiedRows": "A String", # Output only. Number of rows copied to the destination table. + "remoteDestinationRegion": "A String", # Output only. Destination region for a cross-region copy job. Not set for in-region copy jobs. }, "creationTime": "A String", # Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. "dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs. @@ -5656,6 +5705,9 @@

Method Details

], }, "finalExecutionDurationMs": "A String", # Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job. + "globalQueryRemoteRegions": [ # Output only. Regions where the global query accesses data. + "A String", + ], "load": { # Statistics for a load job. # Output only. Statistics for a load job. "badRecords": "A String", # Output only. The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. "inputFileBytes": "A String", # Output only. Number of bytes of source data in a load job. @@ -5675,6 +5727,11 @@

Method Details

], }, "numChildJobs": "A String", # Output only. Number of child jobs executed. + "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. The global query that created this job. + "jobId": "A String", # Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. + "location": "A String", # Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations + "projectId": "A String", # Required. The ID of the project containing this job. + }, "parentJobId": "A String", # Output only. If this is a child job, specifies the job ID of the parent. "query": { # Statistics for a query job. # Output only. Statistics for a query job. "biEngineStatistics": { # Statistics for a BI Engine specific query. Populated as part of JobStatistics2 # Output only. BI Engine specific Statistics. @@ -6331,6 +6388,13 @@

Method Details

"modelTrainingCurrentIteration": 42, # Deprecated. "modelTrainingExpectedTotalIteration": "A String", # Deprecated. "numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. + "objectStorageStats": [ # Output only. Storage and caching statistics per cloud provider for queries over object storage. + { # Storage and caching statistics for object storage. + "cacheBytesRead": "A String", # Total bytes read from the GCP Lakehouse-internal cache, avoiding an object storage read. + "cloudProvider": "A String", # The cloud provider for this block of statistics. + "objectStorageBytesRead": "A String", # Total bytes read directly from the cloud provider's storage. + }, + ], "performanceInsights": { # Performance insights for the job. # Output only. Performance insights. "avgPreviousExecutionMs": "A String", # Output only. Average execution ms of previous runs. Indicates the job ran slow compared to previous executions. To find previous executions, use INFORMATION_SCHEMA tables and filter jobs with same query hash. "stagePerformanceChangeInsights": [ # Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression. @@ -7241,7 +7305,7 @@

Method Details

"writeDisposition": "A String", # Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. "writeIncrementalResults": True or False, # Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. }, - "reservation": "A String", # Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. + "reservation": "A String", # Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`, which requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`. }, "errorResult": { # Error details. # A result object that will be present only if the job has failed. "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. @@ -7263,6 +7327,7 @@

Method Details

"copy": { # Statistics for a copy job. # Output only. Statistics for a copy job. "copiedLogicalBytes": "A String", # Output only. Number of logical bytes copied to the destination table. "copiedRows": "A String", # Output only. Number of rows copied to the destination table. + "remoteDestinationRegion": "A String", # Output only. Destination region for a cross-region copy job. Not set for in-region copy jobs. }, "creationTime": "A String", # Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. "dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs. @@ -7288,6 +7353,9 @@

Method Details

], }, "finalExecutionDurationMs": "A String", # Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job. + "globalQueryRemoteRegions": [ # Output only. Regions where the global query accesses data. + "A String", + ], "load": { # Statistics for a load job. # Output only. Statistics for a load job. "badRecords": "A String", # Output only. The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. "inputFileBytes": "A String", # Output only. Number of bytes of source data in a load job. @@ -7307,6 +7375,11 @@

Method Details

], }, "numChildJobs": "A String", # Output only. Number of child jobs executed. + "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. The global query that created this job. + "jobId": "A String", # Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. + "location": "A String", # Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations + "projectId": "A String", # Required. The ID of the project containing this job. + }, "parentJobId": "A String", # Output only. If this is a child job, specifies the job ID of the parent. "query": { # Statistics for a query job. # Output only. Statistics for a query job. "biEngineStatistics": { # Statistics for a BI Engine specific query. Populated as part of JobStatistics2 # Output only. BI Engine specific Statistics. @@ -7963,6 +8036,13 @@

Method Details

"modelTrainingCurrentIteration": 42, # Deprecated. "modelTrainingExpectedTotalIteration": "A String", # Deprecated. "numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. + "objectStorageStats": [ # Output only. Storage and caching statistics per cloud provider for queries over object storage. + { # Storage and caching statistics for object storage. + "cacheBytesRead": "A String", # Total bytes read from the GCP Lakehouse-internal cache, avoiding an object storage read. + "cloudProvider": "A String", # The cloud provider for this block of statistics. + "objectStorageBytesRead": "A String", # Total bytes read directly from the cloud provider's storage. + }, + ], "performanceInsights": { # Performance insights for the job. # Output only. Performance insights. "avgPreviousExecutionMs": "A String", # Output only. Average execution ms of previous runs. Indicates the job ran slow compared to previous executions. To find previous executions, use INFORMATION_SCHEMA tables and filter jobs with same query hash. "stagePerformanceChangeInsights": [ # Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression. @@ -8440,7 +8520,7 @@

Method Details

], "queryResultsFormat": "A String", # Optional. The query results format. If the value is anything other than `STRUCT_ENCODING` or unspecified: * The schema of the results will be provided in `QueryResponse.results_schema` field. * The results of the first page will be provided in `QueryResponse.results` field. * The `QueryResponse.rows` will not be populated. * The `QueryResponse.schema` for `QueryResponse.rows` will also not be populated since it is the schema of the `QueryResponse.rows`. This feature is not yet available. "requestId": "A String", # Optional. A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of another request, all parameters in the request that may affect the result are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don't affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed. - "reservation": "A String", # Optional. The reservation that jobs.query request would use. User can specify a reservation to execute the job.query. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. + "reservation": "A String", # Optional. The reservation that jobs.query request would use. User can specify a reservation to execute the job.query. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`. This requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`. "timeoutMs": 42, # Optional. Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true. "useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query uses BigQuery's [GoogleSQL](https://docs.cloud.google.com/bigquery/docs/introduction-sql). When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. "useQueryCache": true, # Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true. diff --git a/docs/dyn/bigquery_v2.routines.html b/docs/dyn/bigquery_v2.routines.html index 6c3bec4d70..09e75527ce 100644 --- a/docs/dyn/bigquery_v2.routines.html +++ b/docs/dyn/bigquery_v2.routines.html @@ -162,6 +162,14 @@

Method Details

"isAggregate": True or False, # Optional. Whether the argument is an aggregate function parameter. Must be Unset for routine types other than AGGREGATE_FUNCTION. For AGGREGATE_FUNCTION, if set to false, it is equivalent to adding "NOT AGGREGATE" clause in DDL; Otherwise, it is equivalent to omitting "NOT AGGREGATE" clause in DDL. "mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only. "name": "A String", # Optional. The name of this argument. Can be absent for function return argument. + "tableType": { # A table type # Optional. Set if argument_kind == FIXED_TABLE. + "columns": [ # The columns in this table type + { # A field or a column. + "name": "A String", # Optional. The name of this field. Can be absent for struct fields. + "type": # Object with schema name: StandardSqlDataType # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field). + }, + ], + }, }, ], "buildStatus": { # The status of a routine build. # Output only. The build status of the routine. This field is only applicable to Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) @@ -349,6 +357,14 @@

Method Details

"isAggregate": True or False, # Optional. Whether the argument is an aggregate function parameter. Must be Unset for routine types other than AGGREGATE_FUNCTION. For AGGREGATE_FUNCTION, if set to false, it is equivalent to adding "NOT AGGREGATE" clause in DDL; Otherwise, it is equivalent to omitting "NOT AGGREGATE" clause in DDL. "mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only. "name": "A String", # Optional. The name of this argument. Can be absent for function return argument. + "tableType": { # A table type # Optional. Set if argument_kind == FIXED_TABLE. + "columns": [ # The columns in this table type + { # A field or a column. + "name": "A String", # Optional. The name of this field. Can be absent for struct fields. + "type": # Object with schema name: StandardSqlDataType # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field). + }, + ], + }, }, ], "buildStatus": { # The status of a routine build. # Output only. The build status of the routine. This field is only applicable to Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) @@ -477,6 +493,14 @@

Method Details

"isAggregate": True or False, # Optional. Whether the argument is an aggregate function parameter. Must be Unset for routine types other than AGGREGATE_FUNCTION. For AGGREGATE_FUNCTION, if set to false, it is equivalent to adding "NOT AGGREGATE" clause in DDL; Otherwise, it is equivalent to omitting "NOT AGGREGATE" clause in DDL. "mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only. "name": "A String", # Optional. The name of this argument. Can be absent for function return argument. + "tableType": { # A table type # Optional. Set if argument_kind == FIXED_TABLE. + "columns": [ # The columns in this table type + { # A field or a column. + "name": "A String", # Optional. The name of this field. Can be absent for struct fields. + "type": # Object with schema name: StandardSqlDataType # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field). + }, + ], + }, }, ], "buildStatus": { # The status of a routine build. # Output only. The build status of the routine. This field is only applicable to Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) @@ -620,6 +644,14 @@

Method Details

"isAggregate": True or False, # Optional. Whether the argument is an aggregate function parameter. Must be Unset for routine types other than AGGREGATE_FUNCTION. For AGGREGATE_FUNCTION, if set to false, it is equivalent to adding "NOT AGGREGATE" clause in DDL; Otherwise, it is equivalent to omitting "NOT AGGREGATE" clause in DDL. "mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only. "name": "A String", # Optional. The name of this argument. Can be absent for function return argument. + "tableType": { # A table type # Optional. Set if argument_kind == FIXED_TABLE. + "columns": [ # The columns in this table type + { # A field or a column. + "name": "A String", # Optional. The name of this field. Can be absent for struct fields. + "type": # Object with schema name: StandardSqlDataType # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field). + }, + ], + }, }, ], "buildStatus": { # The status of a routine build. # Output only. The build status of the routine. This field is only applicable to Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) @@ -883,6 +915,14 @@

Method Details

"isAggregate": True or False, # Optional. Whether the argument is an aggregate function parameter. Must be Unset for routine types other than AGGREGATE_FUNCTION. For AGGREGATE_FUNCTION, if set to false, it is equivalent to adding "NOT AGGREGATE" clause in DDL; Otherwise, it is equivalent to omitting "NOT AGGREGATE" clause in DDL. "mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only. "name": "A String", # Optional. The name of this argument. Can be absent for function return argument. + "tableType": { # A table type # Optional. Set if argument_kind == FIXED_TABLE. + "columns": [ # The columns in this table type + { # A field or a column. + "name": "A String", # Optional. The name of this field. Can be absent for struct fields. + "type": # Object with schema name: StandardSqlDataType # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field). + }, + ], + }, }, ], "buildStatus": { # The status of a routine build. # Output only. The build status of the routine. This field is only applicable to Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) @@ -1011,6 +1051,14 @@

Method Details

"isAggregate": True or False, # Optional. Whether the argument is an aggregate function parameter. Must be Unset for routine types other than AGGREGATE_FUNCTION. For AGGREGATE_FUNCTION, if set to false, it is equivalent to adding "NOT AGGREGATE" clause in DDL; Otherwise, it is equivalent to omitting "NOT AGGREGATE" clause in DDL. "mode": "A String", # Optional. Specifies whether the argument is input or output. Can be set for procedures only. "name": "A String", # Optional. The name of this argument. Can be absent for function return argument. + "tableType": { # A table type # Optional. Set if argument_kind == FIXED_TABLE. + "columns": [ # The columns in this table type + { # A field or a column. + "name": "A String", # Optional. The name of this field. Can be absent for struct fields. + "type": # Object with schema name: StandardSqlDataType # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field). + }, + ], + }, }, ], "buildStatus": { # The status of a routine build. # Output only. The build status of the routine. This field is only applicable to Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index 46f27a8844..6145706a9c 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -2390,7 +2390,7 @@ } } }, -"revision": "20260620", +"revision": "20260707", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2463,12 +2463,16 @@ "enum": [ "ARGUMENT_KIND_UNSPECIFIED", "FIXED_TYPE", -"ANY_TYPE" +"ANY_TYPE", +"FIXED_TABLE", +"ANY_TABLE" ], "enumDescriptions": [ "Default value.", "The argument is a variable with fully specified type, which can be a struct or an array, but not a table.", -"The argument is any type, including struct or array, but not a table." +"The argument is any type, including struct or array, but not a table.", +"The argument is a table with fully specified column names and types.", +"The argument is any table type." ], "type": "string" }, @@ -2499,6 +2503,10 @@ "name": { "description": "Optional. The name of this argument. Can be absent for function return argument.", "type": "string" +}, +"tableType": { +"$ref": "StandardSqlTableType", +"description": "Optional. Set if argument_kind == FIXED_TABLE." } }, "type": "object" @@ -5881,7 +5889,7 @@ "description": "[Pick one] Configures a query job." }, "reservation": { -"description": "Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`.", +"description": "Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`, which requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`.", "type": "string" } }, @@ -6583,6 +6591,14 @@ "readOnly": true, "type": "string" }, +"globalQueryRemoteRegions": { +"description": "Output only. Regions where the global query accesses data.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "load": { "$ref": "JobStatistics3", "description": "Output only. Statistics for a load job.", @@ -6594,6 +6610,11 @@ "readOnly": true, "type": "string" }, +"parentGlobalQueryJob": { +"$ref": "JobReference", +"description": "Output only. The global query that created this job.", +"readOnly": true +}, "parentJobId": { "description": "Output only. If this is a child job, specifies the job ID of the parent.", "readOnly": true, @@ -6832,6 +6853,14 @@ "readOnly": true, "type": "string" }, +"objectStorageStats": { +"description": "Output only. Storage and caching statistics per cloud provider for queries over object storage.", +"items": { +"$ref": "ObjectStorageStats" +}, +"readOnly": true, +"type": "array" +}, "performanceInsights": { "$ref": "PerformanceInsights", "description": "Output only. Performance insights.", @@ -7070,6 +7099,11 @@ "format": "int64", "readOnly": true, "type": "string" +}, +"remoteDestinationRegion": { +"description": "Output only. Destination region for a cross-region copy job. Not set for in-region copy jobs.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -7818,6 +7852,39 @@ }, "type": "object" }, +"ObjectStorageStats": { +"description": "Storage and caching statistics for object storage.", +"id": "ObjectStorageStats", +"properties": { +"cacheBytesRead": { +"description": "Total bytes read from the GCP Lakehouse-internal cache, avoiding an object storage read.", +"format": "int64", +"type": "string" +}, +"cloudProvider": { +"description": "The cloud provider for this block of statistics.", +"enum": [ +"CLOUD_PROVIDER_UNSPECIFIED", +"GCP", +"AWS", +"AZURE" +], +"enumDescriptions": [ +"Unspecified cloud provider.", +"Google Cloud Platform.", +"Amazon Web Services.", +"Microsoft Azure." +], +"type": "string" +}, +"objectStorageBytesRead": { +"description": "Total bytes read directly from the cloud provider's storage.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "ParquetOptions": { "description": "Parquet Options for load and make external tables.", "id": "ParquetOptions", @@ -8364,7 +8431,7 @@ "type": "string" }, "reservation": { -"description": "Optional. The reservation that jobs.query request would use. User can specify a reservation to execute the job.query. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`.", +"description": "Optional. The reservation that jobs.query request would use. User can specify a reservation to execute the job.query. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`. This requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`.", "type": "string" }, "timeoutMs": { From 9f545f80407f5ff2d5123e343cb88696fd141bde Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:59 +0000 Subject: [PATCH 21/84] feat(bigqueryreservation): update the api #### bigqueryreservation:v1 The following keys were added: - schemas.Reservation.properties.reservationGroupPath (Total Keys: 3) --- ...on_v1.projects.locations.reservations.html | 21 +++++++++++++++++++ .../documents/bigqueryreservation.v1.json | 10 ++++++++- 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html index c938890cb7..13dd099e74 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html @@ -159,6 +159,9 @@

Method Details

"softFailoverStartTime": "A String", # Output only. The time at which a soft failover for the reservation and its associated datasets was initiated. After this field is set, all subsequent changes to the reservation will be rejected unless a hard failover overrides this operation. This field will be cleared once the failover is complete. }, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} + "reservationGroupPath": [ # Output only. The reservation group path of the reservation from root to leaf. The order of elements matters: the first element is the top level group and the last element is the direct parent reservation group. For example, if a reservation is under group-1 -> group-2 -> group-3, then the reservation group path is ["group-1", "group-2", "group-3"]. + "A String", + ], "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. 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. @@ -210,6 +213,9 @@

Method Details

"softFailoverStartTime": "A String", # Output only. The time at which a soft failover for the reservation and its associated datasets was initiated. After this field is set, all subsequent changes to the reservation will be rejected unless a hard failover overrides this operation. This field will be cleared once the failover is complete. }, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} + "reservationGroupPath": [ # Output only. The reservation group path of the reservation from root to leaf. The order of elements matters: the first element is the top level group and the last element is the direct parent reservation group. For example, if a reservation is under group-1 -> group-2 -> group-3, then the reservation group path is ["group-1", "group-2", "group-3"]. + "A String", + ], "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. 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. @@ -292,6 +298,9 @@

Method Details

"softFailoverStartTime": "A String", # Output only. The time at which a soft failover for the reservation and its associated datasets was initiated. After this field is set, all subsequent changes to the reservation will be rejected unless a hard failover overrides this operation. This field will be cleared once the failover is complete. }, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} + "reservationGroupPath": [ # Output only. The reservation group path of the reservation from root to leaf. The order of elements matters: the first element is the top level group and the last element is the direct parent reservation group. For example, if a reservation is under group-1 -> group-2 -> group-3, then the reservation group path is ["group-1", "group-2", "group-3"]. + "A String", + ], "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. 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. @@ -349,6 +358,9 @@

Method Details

"softFailoverStartTime": "A String", # Output only. The time at which a soft failover for the reservation and its associated datasets was initiated. After this field is set, all subsequent changes to the reservation will be rejected unless a hard failover overrides this operation. This field will be cleared once the failover is complete. }, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} + "reservationGroupPath": [ # Output only. The reservation group path of the reservation from root to leaf. The order of elements matters: the first element is the top level group and the last element is the direct parent reservation group. For example, if a reservation is under group-1 -> group-2 -> group-3, then the reservation group path is ["group-1", "group-2", "group-3"]. + "A String", + ], "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. 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. @@ -459,6 +471,9 @@

Method Details

"softFailoverStartTime": "A String", # Output only. The time at which a soft failover for the reservation and its associated datasets was initiated. After this field is set, all subsequent changes to the reservation will be rejected unless a hard failover overrides this operation. This field will be cleared once the failover is complete. }, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} + "reservationGroupPath": [ # Output only. The reservation group path of the reservation from root to leaf. The order of elements matters: the first element is the top level group and the last element is the direct parent reservation group. For example, if a reservation is under group-1 -> group-2 -> group-3, then the reservation group path is ["group-1", "group-2", "group-3"]. + "A String", + ], "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. 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. @@ -527,6 +542,9 @@

Method Details

"softFailoverStartTime": "A String", # Output only. The time at which a soft failover for the reservation and its associated datasets was initiated. After this field is set, all subsequent changes to the reservation will be rejected unless a hard failover overrides this operation. This field will be cleared once the failover is complete. }, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} + "reservationGroupPath": [ # Output only. The reservation group path of the reservation from root to leaf. The order of elements matters: the first element is the top level group and the last element is the direct parent reservation group. For example, if a reservation is under group-1 -> group-2 -> group-3, then the reservation group path is ["group-1", "group-2", "group-3"]. + "A String", + ], "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. 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. @@ -578,6 +596,9 @@

Method Details

"softFailoverStartTime": "A String", # Output only. The time at which a soft failover for the reservation and its associated datasets was initiated. After this field is set, all subsequent changes to the reservation will be rejected unless a hard failover overrides this operation. This field will be cleared once the failover is complete. }, "reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group} + "reservationGroupPath": [ # Output only. The reservation group path of the reservation from root to leaf. The order of elements matters: the first element is the top level group and the last element is the direct parent reservation group. For example, if a reservation is under group-1 -> group-2 -> group-3, then the reservation group path is ["group-1", "group-2", "group-3"]. + "A String", + ], "scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. 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. diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index a72008f574..4691ca3135 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -1317,7 +1317,7 @@ } } }, -"revision": "20260629", +"revision": "20260717", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -1959,6 +1959,14 @@ false "description": "Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group}", "type": "string" }, +"reservationGroupPath": { +"description": "Output only. The reservation group path of the reservation from root to leaf. The order of elements matters: the first element is the top level group and the last element is the direct parent reservation group. For example, if a reservation is under group-1 -> group-2 -> group-3, then the reservation group path is [\"group-1\", \"group-2\", \"group-3\"].", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "scalingMode": { "description": "Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.", "enum": [ From 376a8c93ebf0694a1cca32757a7a12221296b7cc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:57:59 +0000 Subject: [PATCH 22/84] feat(bigtableadmin): update the api #### bigtableadmin:v2 The following keys were added: - resources.projects.resources.instances.resources.clusters.methods.updateMemoryLayer (Total Keys: 15) - resources.projects.resources.instances.resources.materializedViews.methods.create.parameters.ignoreWarnings (Total Keys: 2) - schemas.ColumnFamilyStats.properties.logicalDataHddBytes (Total Keys: 3) - schemas.ColumnFamilyStats.properties.logicalDataSsdBytes (Total Keys: 3) - schemas.CreateMaterializedViewRequest.properties.ignoreWarnings.type (Total Keys: 1) --- ...eadmin_v2.projects.instances.clusters.html | 51 +++++++++++++++ ....projects.instances.materializedViews.html | 5 +- ...bleadmin_v2.projects.instances.tables.html | 16 +++++ .../documents/bigtableadmin.v2.json | 62 ++++++++++++++++++- 4 files changed, 131 insertions(+), 3 deletions(-) diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html index 11fa1a9e63..839e631e83 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html @@ -116,6 +116,9 @@

Instance Methods

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

Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

+

+ updateMemoryLayer(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the memory layer of a cluster. To enable the memory layer, set the memory_config. To disable the memory layer, unset the memory_config.

Method Details

close() @@ -453,4 +456,52 @@

Method Details

}
+
+ updateMemoryLayer(name, body=None, updateMask=None, x__xgafv=None) +
Updates the memory layer of a cluster. To enable the memory layer, set the memory_config. To disable the memory layer, unset the memory_config.
+
+Args:
+  name: string, Identifier. Name of the memory layer. This is always: "projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer". (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The memory layer of a cluster. A memory layer serves reads from memory without hitting the backing persistent data store.
+  "etag": "A String", # Optional. The etag for this memory layer. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.
+  "memoryConfig": { # Configuration of a memory layer. # The configuration of this memory layer. Set an empty `memory_config` to enable the memory layer. Unset this to disable the memory layer.
+    "storageSizeGib": 42, # Output only. Reporting the current size of the memory layer in GiB.
+  },
+  "name": "A String", # Identifier. Name of the memory layer. This is always: "projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer".
+  "state": "A String", # Output only. The current state of the memory layer.
+}
+
+  updateMask: string, Optional. The list of fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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/bigtableadmin_v2.projects.instances.materializedViews.html b/docs/dyn/bigtableadmin_v2.projects.instances.materializedViews.html index 1fa2da154b..af0a136abf 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.materializedViews.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.materializedViews.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body=None, materializedViewId=None, x__xgafv=None)

+ create(parent, body=None, ignoreWarnings=None, materializedViewId=None, x__xgafv=None)

Creates a materialized view within an instance.

delete(name, etag=None, x__xgafv=None)

@@ -111,7 +111,7 @@

Method Details

- create(parent, body=None, materializedViewId=None, x__xgafv=None) + create(parent, body=None, ignoreWarnings=None, materializedViewId=None, x__xgafv=None)
Creates a materialized view within an instance.
 
 Args:
@@ -131,6 +131,7 @@ 

Method Details

"query": "A String", # Required. Immutable. The materialized view's select query. Views: `SCHEMA_VIEW`, `FULL`. } + ignoreWarnings: boolean, Optional. If true, ignore optional safety checks when creating the materialized view. materializedViewId: string, Required. The ID to use for the materialized view, which will become the final component of the materialized view's resource name. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index aadf3474d9..43b47369b8 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -234,6 +234,8 @@

Method Details

"averageCellsPerColumn": 3.14, # How many cells are present per column qualifier in this column family, averaged over all rows containing any column in the column family. e.g. For column family "family" in a table with 3 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (3 cells / 1 column in "family") * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (8 cells / 2 columns in "family") * A row with 3 cells in "other:col" (0 columns in "family", "family" not present) would report (3 + 8 + 0)/(1 + 2 + 0) = 3.66 in this field. "averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). + "logicalDataHddBytes": "A String", # Output only. The logical data bytes of the column family stored on HDD. + "logicalDataSsdBytes": "A String", # Output only. The logical data bytes of the column family stored on SSD. }, "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate @@ -455,6 +457,8 @@

Method Details

"averageCellsPerColumn": 3.14, # How many cells are present per column qualifier in this column family, averaged over all rows containing any column in the column family. e.g. For column family "family" in a table with 3 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (3 cells / 1 column in "family") * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (8 cells / 2 columns in "family") * A row with 3 cells in "other:col" (0 columns in "family", "family" not present) would report (3 + 8 + 0)/(1 + 2 + 0) = 3.66 in this field. "averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). + "logicalDataHddBytes": "A String", # Output only. The logical data bytes of the column family stored on HDD. + "logicalDataSsdBytes": "A String", # Output only. The logical data bytes of the column family stored on SSD. }, "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate @@ -759,6 +763,8 @@

Method Details

"averageCellsPerColumn": 3.14, # How many cells are present per column qualifier in this column family, averaged over all rows containing any column in the column family. e.g. For column family "family" in a table with 3 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (3 cells / 1 column in "family") * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (8 cells / 2 columns in "family") * A row with 3 cells in "other:col" (0 columns in "family", "family" not present) would report (3 + 8 + 0)/(1 + 2 + 0) = 3.66 in this field. "averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). + "logicalDataHddBytes": "A String", # Output only. The logical data bytes of the column family stored on HDD. + "logicalDataSsdBytes": "A String", # Output only. The logical data bytes of the column family stored on SSD. }, "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate @@ -1055,6 +1061,8 @@

Method Details

"averageCellsPerColumn": 3.14, # How many cells are present per column qualifier in this column family, averaged over all rows containing any column in the column family. e.g. For column family "family" in a table with 3 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (3 cells / 1 column in "family") * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (8 cells / 2 columns in "family") * A row with 3 cells in "other:col" (0 columns in "family", "family" not present) would report (3 + 8 + 0)/(1 + 2 + 0) = 3.66 in this field. "averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). + "logicalDataHddBytes": "A String", # Output only. The logical data bytes of the column family stored on HDD. + "logicalDataSsdBytes": "A String", # Output only. The logical data bytes of the column family stored on SSD. }, "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate @@ -1264,6 +1272,8 @@

Method Details

"averageCellsPerColumn": 3.14, # How many cells are present per column qualifier in this column family, averaged over all rows containing any column in the column family. e.g. For column family "family" in a table with 3 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (3 cells / 1 column in "family") * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (8 cells / 2 columns in "family") * A row with 3 cells in "other:col" (0 columns in "family", "family" not present) would report (3 + 8 + 0)/(1 + 2 + 0) = 3.66 in this field. "averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). + "logicalDataHddBytes": "A String", # Output only. The logical data bytes of the column family stored on HDD. + "logicalDataSsdBytes": "A String", # Output only. The logical data bytes of the column family stored on SSD. }, "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate @@ -1401,6 +1411,8 @@

Method Details

"averageCellsPerColumn": 3.14, # How many cells are present per column qualifier in this column family, averaged over all rows containing any column in the column family. e.g. For column family "family" in a table with 3 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (3 cells / 1 column in "family") * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (8 cells / 2 columns in "family") * A row with 3 cells in "other:col" (0 columns in "family", "family" not present) would report (3 + 8 + 0)/(1 + 2 + 0) = 3.66 in this field. "averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). + "logicalDataHddBytes": "A String", # Output only. The logical data bytes of the column family stored on HDD. + "logicalDataSsdBytes": "A String", # Output only. The logical data bytes of the column family stored on SSD. }, "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate @@ -1581,6 +1593,8 @@

Method Details

"averageCellsPerColumn": 3.14, # How many cells are present per column qualifier in this column family, averaged over all rows containing any column in the column family. e.g. For column family "family" in a table with 3 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (3 cells / 1 column in "family") * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (8 cells / 2 columns in "family") * A row with 3 cells in "other:col" (0 columns in "family", "family" not present) would report (3 + 8 + 0)/(1 + 2 + 0) = 3.66 in this field. "averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). + "logicalDataHddBytes": "A String", # Output only. The logical data bytes of the column family stored on HDD. + "logicalDataSsdBytes": "A String", # Output only. The logical data bytes of the column family stored on SSD. }, "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate @@ -1802,6 +1816,8 @@

Method Details

"averageCellsPerColumn": 3.14, # How many cells are present per column qualifier in this column family, averaged over all rows containing any column in the column family. e.g. For column family "family" in a table with 3 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (3 cells / 1 column in "family") * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (8 cells / 2 columns in "family") * A row with 3 cells in "other:col" (0 columns in "family", "family" not present) would report (3 + 8 + 0)/(1 + 2 + 0) = 3.66 in this field. "averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). + "logicalDataHddBytes": "A String", # Output only. The logical data bytes of the column family stored on HDD. + "logicalDataSsdBytes": "A String", # Output only. The logical data bytes of the column family stored on SSD. }, "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index cf79b42204..7bfe4ddd02 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -972,6 +972,45 @@ "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"updateMemoryLayer": { +"description": "Updates the memory layer of a cluster. To enable the memory layer, set the memory_config. To disable the memory layer, unset the memory_config.", +"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/memoryLayer", +"httpMethod": "PATCH", +"id": "bigtableadmin.projects.instances.clusters.updateMemoryLayer", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the memory layer. This is always: \"projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer\".", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+/memoryLayer$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v2/{+name}", +"request": { +"$ref": "MemoryLayer" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigtable.admin", +"https://www.googleapis.com/auth/bigtable.admin.cluster", +"https://www.googleapis.com/auth/bigtable.admin.instance", +"https://www.googleapis.com/auth/cloud-bigtable.admin", +"https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -1691,6 +1730,11 @@ "parent" ], "parameters": { +"ignoreWarnings": { +"description": "Optional. If true, ignore optional safety checks when creating the materialized view.", +"location": "query", +"type": "boolean" +}, "materializedViewId": { "description": "Required. The ID to use for the materialized view, which will become the final component of the materialized view's resource name.", "location": "query", @@ -3194,7 +3238,7 @@ } } }, -"revision": "20260708", +"revision": "20260725", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -3733,6 +3777,18 @@ "description": "How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out).", "format": "int64", "type": "string" +}, +"logicalDataHddBytes": { +"description": "Output only. The logical data bytes of the column family stored on HDD.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"logicalDataSsdBytes": { +"description": "Output only. The logical data bytes of the column family stored on SSD.", +"format": "int64", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -4036,6 +4092,10 @@ "description": "Request message for BigtableInstanceAdmin.CreateMaterializedView.", "id": "CreateMaterializedViewRequest", "properties": { +"ignoreWarnings": { +"description": "Optional. If true, ignore optional safety checks when creating the materialized view.", +"type": "boolean" +}, "materializedView": { "$ref": "MaterializedView", "description": "Required. The materialized view to create." From e0a9fe4164c51a74a635ef0407489ed1603c2406 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:00 +0000 Subject: [PATCH 23/84] feat(ces): update the api #### ces:v1 The following keys were added: - schemas.ConversationTurn.properties.userIntendedText.type (Total Keys: 1) - schemas.DataStoreToolModalityConfig.properties.snippetsConfig.$ref (Total Keys: 1) - schemas.DataStoreToolSnippetsConfig (Total Keys: 3) - schemas.Deployment.properties.modality.type (Total Keys: 1) - schemas.Deployment.properties.modelSettings.$ref (Total Keys: 1) - schemas.ImportAppRequestImportOptions.properties.validateOnly.type (Total Keys: 1) - schemas.SessionConfig.properties.excludeDiagnosticInfo.type (Total Keys: 1) - schemas.SynthesizeSpeechConfig.properties.consentAudioGcsUri (Total Keys: 2) - schemas.SynthesizeSpeechConfig.properties.voiceSampleGcsUri.deprecated (Total Keys: 1) #### ces:v1beta The following keys were deleted: - schemas.EvaluationConfig.properties.inputAudioConfig.deprecated (Total Keys: 1) - schemas.EvaluationConfig.properties.outputAudioConfig.deprecated (Total Keys: 1) The following keys were added: - schemas.ConversationTurn.properties.userIntendedText.type (Total Keys: 1) - schemas.DataStoreToolModalityConfig.properties.snippetsConfig.$ref (Total Keys: 1) - schemas.DataStoreToolSnippetsConfig (Total Keys: 3) - schemas.Deployment.properties.modality.type (Total Keys: 1) - schemas.Deployment.properties.modelSettings.$ref (Total Keys: 1) - schemas.EvaluationResult.properties.outcomeMetadata (Total Keys: 2) - schemas.EvaluationResult.properties.rootSpan (Total Keys: 2) - schemas.ImportAppRequestImportOptions.properties.validateOnly.type (Total Keys: 1) - schemas.SessionConfig.properties.excludeDiagnosticInfo.type (Total Keys: 1) - schemas.SynthesizeSpeechConfig.properties.consentAudioGcsUri (Total Keys: 2) - schemas.SynthesizeSpeechConfig.properties.voiceSampleGcsUri.deprecated (Total Keys: 1) --- ...projects.locations.apps.conversations.html | 2 + ...1.projects.locations.apps.deployments.html | 34 ++- ...ts.locations.apps.deployments.message.html | 4 +- docs/dyn/ces_v1.projects.locations.apps.html | 20 +- ...es_v1.projects.locations.apps.message.html | 4 +- ...s_v1.projects.locations.apps.sessions.html | 2 + .../ces_v1.projects.locations.apps.tools.html | 18 ++ ...s_v1.projects.locations.apps.toolsets.html | 3 + ...s_v1.projects.locations.apps.versions.html | 28 ++- ...jects.locations.apps.versions.message.html | 4 +- ...projects.locations.apps.conversations.html | 2 + ...a.projects.locations.apps.deployments.html | 34 ++- ...ts.locations.apps.deployments.message.html | 4 +- ...a.projects.locations.apps.evaluations.html | 204 +++++++++++++++--- ...ts.locations.apps.evaluations.results.html | 34 ++- .../ces_v1beta.projects.locations.apps.html | 25 ++- ...1beta.projects.locations.apps.message.html | 4 +- ...ocations.apps.scheduledEvaluationRuns.html | 12 +- ...beta.projects.locations.apps.sessions.html | 2 + ..._v1beta.projects.locations.apps.tools.html | 18 ++ ...beta.projects.locations.apps.toolsets.html | 3 + ...beta.projects.locations.apps.versions.html | 28 ++- ...jects.locations.apps.versions.message.html | 4 +- .../discovery_cache/documents/ces.v1.json | 73 ++++++- .../discovery_cache/documents/ces.v1beta.json | 99 +++++++-- 25 files changed, 563 insertions(+), 102 deletions(-) diff --git a/docs/dyn/ces_v1.projects.locations.apps.conversations.html b/docs/dyn/ces_v1.projects.locations.apps.conversations.html index 044b38ae92..d32e15a3e0 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.conversations.html +++ b/docs/dyn/ces_v1.projects.locations.apps.conversations.html @@ -330,6 +330,7 @@

Method Details

"name": "A String", # Output only. The name of the span. "startTime": "A String", # Output only. The start time of the span. }, + "userIntendedText": "A String", # Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled. }, ], }
@@ -510,6 +511,7 @@

Method Details

"name": "A String", # Output only. The name of the span. "startTime": "A String", # Output only. The start time of the span. }, + "userIntendedText": "A String", # Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled. }, ], }, diff --git a/docs/dyn/ces_v1.projects.locations.apps.deployments.html b/docs/dyn/ces_v1.projects.locations.apps.deployments.html index ca69ea6abc..07a845680b 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.deployments.html +++ b/docs/dyn/ces_v1.projects.locations.apps.deployments.html @@ -176,6 +176,11 @@

Method Details

"authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. }, + "modality": "A String", # Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. + "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. + "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 resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. @@ -255,6 +260,11 @@

Method Details

"authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. }, + "modality": "A String", # Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. + "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. + "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 resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. @@ -359,6 +369,11 @@

Method Details

"authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. }, + "modality": "A String", # Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. + "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. + "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 resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. @@ -377,7 +392,7 @@

Method Details

Gets the extended agent card for the authenticated agent.
 
 Args:
-  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  tenant: string, Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -535,7 +550,7 @@ 

Method Details

{ # 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. + "tenant": "A String", # Optional. An opaque string used for routing requests to a specific agent or tenant when multiple agents are served behind a single A2A endpoint. When set, clients MUST include this value in the `tenant` field of all request messages sent to this interface. The server is responsible for interpreting the value and routing requests accordingly; the protocol does not define its format or semantics. "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" }, ], @@ -620,6 +635,11 @@

Method Details

"authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. }, + "modality": "A String", # Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. + "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. + "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 resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. @@ -717,6 +737,11 @@

Method Details

"authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. }, + "modality": "A String", # Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. + "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. + "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 resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. @@ -796,6 +821,11 @@

Method Details

"authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. }, + "modality": "A String", # Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. + "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. + "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 resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. diff --git a/docs/dyn/ces_v1.projects.locations.apps.deployments.message.html b/docs/dyn/ces_v1.projects.locations.apps.deployments.message.html index 5a98faefce..bccb81fe5a 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.deployments.message.html +++ b/docs/dyn/ces_v1.projects.locations.apps.deployments.message.html @@ -91,7 +91,7 @@

Method Details

Sends a message to an agent.
 
 Args:
-  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  tenant: string, Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -109,7 +109,7 @@ 

Method Details

}, "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration. "taskId": "A String", # The ID of the task this configuration is associated with. - "tenant": "A String", # Optional. Tenant ID. + "tenant": "A String", # Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. "token": "A String", # A token unique for this task or session. "url": "A String", # Required. The URL where the notification should be sent. }, diff --git a/docs/dyn/ces_v1.projects.locations.apps.html b/docs/dyn/ces_v1.projects.locations.apps.html index 73882f3e94..5bc022f427 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.html +++ b/docs/dyn/ces_v1.projects.locations.apps.html @@ -195,11 +195,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -671,11 +672,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -925,7 +927,7 @@

Method Details

Gets the extended agent card for the authenticated agent.
 
 Args:
-  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  tenant: string, Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1083,7 +1085,7 @@ 

Method Details

{ # 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. + "tenant": "A String", # Optional. An opaque string used for routing requests to a specific agent or tenant when multiple agents are served behind a single A2A endpoint. When set, clients MUST include this value in the `tenant` field of all request messages sent to this interface. The server is responsible for interpreting the value and routing requests accordingly; the protocol does not define its format or semantics. "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" }, ], @@ -1108,6 +1110,7 @@

Method Details

"ignoreAppLock": True or False, # Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock. "importOptions": { # Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data. # Optional. Options governing the import process for the app. "conflictResolutionStrategy": "A String", # Optional. The strategy to use when resolving conflicts during import. + "validateOnly": True or False, # Optional. Flag for dry-running the import process. If set to true, the import process will only perform validations and will not make any changes to the existing app or create a new one. }, } @@ -1175,11 +1178,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -1468,11 +1472,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -1740,11 +1745,12 @@

Method Details

"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. 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. + "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. }, }, }, diff --git a/docs/dyn/ces_v1.projects.locations.apps.message.html b/docs/dyn/ces_v1.projects.locations.apps.message.html index 2020f5e79d..56584c2348 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.message.html +++ b/docs/dyn/ces_v1.projects.locations.apps.message.html @@ -91,7 +91,7 @@

Method Details

Sends a message to an agent.
 
 Args:
-  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  tenant: string, Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -109,7 +109,7 @@ 

Method Details

}, "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration. "taskId": "A String", # The ID of the task this configuration is associated with. - "tenant": "A String", # Optional. Tenant ID. + "tenant": "A String", # Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. "token": "A String", # A token unique for this task or session. "url": "A String", # Required. The URL where the notification should be sent. }, diff --git a/docs/dyn/ces_v1.projects.locations.apps.sessions.html b/docs/dyn/ces_v1.projects.locations.apps.sessions.html index 5d9dbd1fe7..c842fa79a7 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.sessions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.sessions.html @@ -135,6 +135,7 @@

Method Details

"deployment": "A String", # Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "enableTextStreaming": True or False, # Optional. Whether to enable streaming text outputs from the model. By default, text outputs from the model are collected before sending to the client. NOTE: This is only supported for text (non-voice) sessions via StreamRunSession or BidiRunSession. "entryAgent": "A String", # Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "excludeDiagnosticInfo": True or False, # Optional. Whether to exclude diagnostic info from the session output. "historicalContexts": [ # Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state. { # A message within a conversation. "chunks": [ # Optional. Content of the message as a series of chunks. @@ -410,6 +411,7 @@

Method Details

"deployment": "A String", # Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "enableTextStreaming": True or False, # Optional. Whether to enable streaming text outputs from the model. By default, text outputs from the model are collected before sending to the client. NOTE: This is only supported for text (non-voice) sessions via StreamRunSession or BidiRunSession. "entryAgent": "A String", # Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "excludeDiagnosticInfo": True or False, # Optional. Whether to exclude diagnostic info from the session output. "historicalContexts": [ # Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state. { # A message within a conversation. "chunks": [ # Optional. Content of the message as a series of chunks. diff --git a/docs/dyn/ces_v1.projects.locations.apps.tools.html b/docs/dyn/ces_v1.projects.locations.apps.tools.html index fde8204b47..f5fa06b8d3 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1.projects.locations.apps.tools.html @@ -297,6 +297,9 @@

Method Details

}, "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. + }, "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. @@ -812,6 +815,9 @@

Method Details

}, "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. + }, "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. @@ -1353,6 +1359,9 @@

Method Details

}, "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. + }, "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. @@ -1881,6 +1890,9 @@

Method Details

}, "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. + }, "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. @@ -2413,6 +2425,9 @@

Method Details

}, "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. + }, "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. @@ -2928,6 +2943,9 @@

Method Details

}, "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. + }, "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. diff --git a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html index f49f77da43..a7b92678fb 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html @@ -1676,6 +1676,9 @@

Method Details

}, "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. + }, "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. diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.html b/docs/dyn/ces_v1.projects.locations.apps.versions.html index 8ac6f35ee2..89b2bdea5e 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.versions.html @@ -259,11 +259,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -865,6 +866,9 @@

Method Details

}, "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. + }, "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. @@ -1546,11 +1550,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -2152,6 +2157,9 @@

Method Details

}, "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. + }, "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. @@ -2858,11 +2866,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -3464,6 +3473,9 @@

Method Details

}, "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. + }, "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. @@ -4001,7 +4013,7 @@

Method Details

Gets the extended agent card for the authenticated agent.
 
 Args:
-  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  tenant: string, Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -4159,7 +4171,7 @@ 

Method Details

{ # 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. + "tenant": "A String", # Optional. An opaque string used for routing requests to a specific agent or tenant when multiple agents are served behind a single A2A endpoint. When set, clients MUST include this value in the `tenant` field of all request messages sent to this interface. The server is responsible for interpreting the value and routing requests accordingly; the protocol does not define its format or semantics. "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" }, ], @@ -4328,11 +4340,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -4934,6 +4947,9 @@

Method Details

}, "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. + }, "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. diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.message.html b/docs/dyn/ces_v1.projects.locations.apps.versions.message.html index 67aa7b60c8..30943114d4 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.versions.message.html +++ b/docs/dyn/ces_v1.projects.locations.apps.versions.message.html @@ -91,7 +91,7 @@

Method Details

Sends a message to an agent.
 
 Args:
-  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  tenant: string, Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -109,7 +109,7 @@ 

Method Details

}, "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration. "taskId": "A String", # The ID of the task this configuration is associated with. - "tenant": "A String", # Optional. Tenant ID. + "tenant": "A String", # Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. "token": "A String", # A token unique for this task or session. "url": "A String", # Required. The URL where the notification should be sent. }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html index e835ae9a52..c99313e292 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html @@ -376,6 +376,7 @@

Method Details

"name": "A String", # Output only. The name of the span. "startTime": "A String", # Output only. The start time of the span. }, + "userIntendedText": "A String", # Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled. }, ], }
@@ -556,6 +557,7 @@

Method Details

"name": "A String", # Output only. The name of the span. "startTime": "A String", # Output only. The start time of the span. }, + "userIntendedText": "A String", # Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled. }, ], }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html index 8e5ee443f6..78db90ce04 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html @@ -176,6 +176,11 @@

Method Details

"authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. }, + "modality": "A String", # Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. + "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. + "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 resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. @@ -255,6 +260,11 @@

Method Details

"authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. }, + "modality": "A String", # Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. + "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. + "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 resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. @@ -359,6 +369,11 @@

Method Details

"authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. }, + "modality": "A String", # Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. + "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. + "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 resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. @@ -377,7 +392,7 @@

Method Details

Gets the extended agent card for the authenticated agent.
 
 Args:
-  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  tenant: string, Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -535,7 +550,7 @@ 

Method Details

{ # 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. + "tenant": "A String", # Optional. An opaque string used for routing requests to a specific agent or tenant when multiple agents are served behind a single A2A endpoint. When set, clients MUST include this value in the `tenant` field of all request messages sent to this interface. The server is responsible for interpreting the value and routing requests accordingly; the protocol does not define its format or semantics. "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" }, ], @@ -620,6 +635,11 @@

Method Details

"authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. }, + "modality": "A String", # Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. + "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. + "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 resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. @@ -717,6 +737,11 @@

Method Details

"authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. }, + "modality": "A String", # Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. + "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. + "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 resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. @@ -796,6 +821,11 @@

Method Details

"authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. }, + "modality": "A String", # Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. + "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. + "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 resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.deployments.message.html b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.message.html index 9d1d391a86..d39c02399a 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.deployments.message.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.message.html @@ -91,7 +91,7 @@

Method Details

Sends a message to an agent.
 
 Args:
-  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  tenant: string, Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -109,7 +109,7 @@ 

Method Details

}, "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration. "taskId": "A String", # The ID of the task this configuration is associated with. - "tenant": "A String", # Optional. Tenant ID. + "tenant": "A String", # Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. "token": "A String", # A token unique for this task or session. "url": "A String", # Required. The URL where the notification should be sent. }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html index b911119215..9b809b4a38 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html @@ -765,6 +765,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -776,6 +777,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -1010,8 +1023,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }, @@ -1354,6 +1367,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -1365,6 +1379,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -1599,8 +1625,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }, @@ -2373,6 +2399,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -2384,6 +2411,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -2618,8 +2657,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }, @@ -2962,6 +3001,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -2973,6 +3013,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -3207,8 +3259,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }, @@ -4057,6 +4109,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -4068,6 +4121,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -4302,8 +4367,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }, @@ -4646,6 +4711,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -4657,6 +4723,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -4891,8 +4969,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }, @@ -5680,6 +5758,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -5691,6 +5770,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -5925,8 +6016,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }, @@ -6269,6 +6360,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -6280,6 +6372,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -6514,8 +6618,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }, @@ -7306,6 +7410,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -7317,6 +7422,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -7551,8 +7668,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }, @@ -7895,6 +8012,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -7906,6 +8024,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -8140,8 +8270,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }, @@ -8914,6 +9044,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -8925,6 +9056,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -9159,8 +9302,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }, @@ -9503,6 +9646,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -9514,6 +9658,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -9748,8 +9904,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }, 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 733a5a3813..f6fd426ffc 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html @@ -519,6 +519,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -530,6 +531,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -764,8 +777,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }
@@ -1129,6 +1142,7 @@

Method Details

"goldenRunMethod": "A String", # Output only. The method used to run the golden evaluation. "initiatedBy": "A String", # Output only. The user who initiated the evaluation run that resulted in this result. "name": "A String", # Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` + "outcomeMetadata": "A String", # Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE. "persona": { # A persona represents an end user in an evaluation. # Output only. The persona used to generate the conversation for the evaluation result. "description": "A String", # Optional. The description of the persona. "displayName": "A String", # Required. The display name of the persona. Unique within an app. @@ -1140,6 +1154,18 @@

Method Details

"voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A" }, }, + "rootSpan": { # A span is a unit of work or a single operation during the request processing. # Output only. The root span of the evaluation execution, which includes information about each step of the evaluation. + "attributes": { # Output only. Key-value attributes associated with the span. + "a_key": "", # Properties of the object. + }, + "childSpans": [ # Output only. The child spans that are nested under this span. + # Object with schema name: Span + ], + "duration": "A String", # Output only. The duration of the span. + "endTime": "A String", # Output only. The end time of the span. + "name": "A String", # Output only. The name of the span. + "startTime": "A String", # Output only. The start time of the span. + }, "scenarioResult": { # The outcome of a scenario evaluation. # Output only. The outcome of a scenario evaluation. "allExpectationsSatisfied": True or False, # Output only. Whether all expectations were satisfied for this turn. "conversation": "A String", # Output only. The conversation that was generated in the scenario. @@ -1374,8 +1400,8 @@

Method Details

], "userGoalSatisfactionResult": { # The result of a user goal satisfaction check for a conversation. # Output only. The result of the user goal satisfaction check. "explanation": "A String", # Output only. The explanation for the user task satisfaction score. - "label": "A String", # Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified - "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1. + "label": "A String", # Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified + "score": 42, # Output only. The user task satisfaction score. Can be -1, 0, 1, 2. }, }, }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.html b/docs/dyn/ces_v1beta.projects.locations.apps.html index e1b058547c..bb65a3034e 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.html @@ -232,11 +232,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -1098,6 +1099,9 @@

Method Details

}, "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. + }, "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. @@ -1706,11 +1710,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -2004,7 +2009,7 @@

Method Details

Gets the extended agent card for the authenticated agent.
 
 Args:
-  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  tenant: string, Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -2162,7 +2167,7 @@ 

Method Details

{ # 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. + "tenant": "A String", # Optional. An opaque string used for routing requests to a specific agent or tenant when multiple agents are served behind a single A2A endpoint. When set, clients MUST include this value in the `tenant` field of all request messages sent to this interface. The server is responsible for interpreting the value and routing requests accordingly; the protocol does not define its format or semantics. "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" }, ], @@ -2187,6 +2192,7 @@

Method Details

"ignoreAppLock": True or False, # Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock. "importOptions": { # Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data. # Optional. Options governing the import process for the app. "conflictResolutionStrategy": "A String", # Optional. The strategy to use when resolving conflicts during import. + "validateOnly": True or False, # Optional. Flag for dry-running the import process. If set to true, the import process will only perform validations and will not make any changes to the existing app or create a new one. }, } @@ -2305,11 +2311,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -2642,11 +2649,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -2958,11 +2966,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -3362,7 +3371,7 @@

Method Details

{ # Request message for EvaluationService.RunEvaluation. "app": "A String", # Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}` - "appVersion": "A String", # Optional. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` + "appVersion": "A String", # Optional. The app version to evaluate. At most one of `app_version` or `deployment` can be set. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "config": { # EvaluationConfig configures settings for running the evaluation. # Optional. The configuration to use for the run. "evaluationChannel": "A String", # Optional. The channel to evaluate. "inputAudioConfig": { # InputAudioConfig configures how the CES agent should interpret the incoming audio data. # Optional. Configuration for processing the input audio. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.message.html b/docs/dyn/ces_v1beta.projects.locations.apps.message.html index c0742277a5..1f59aa7ff0 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.message.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.message.html @@ -91,7 +91,7 @@

Method Details

Sends a message to an agent.
 
 Args:
-  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  tenant: string, Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -109,7 +109,7 @@ 

Method Details

}, "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration. "taskId": "A String", # The ID of the task this configuration is associated with. - "tenant": "A String", # Optional. Tenant ID. + "tenant": "A String", # Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. "token": "A String", # A token unique for this task or session. "url": "A String", # Required. The URL where the notification should be sent. }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.scheduledEvaluationRuns.html b/docs/dyn/ces_v1beta.projects.locations.apps.scheduledEvaluationRuns.html index 0e62c4bb0a..a60926eca4 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.scheduledEvaluationRuns.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.scheduledEvaluationRuns.html @@ -123,7 +123,7 @@

Method Details

"nextScheduledExecutionTime": "A String", # Output only. The next time this is scheduled to execute "request": { # Request message for EvaluationService.RunEvaluation. # Required. The RunEvaluationRequest to schedule "app": "A String", # Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}` - "appVersion": "A String", # Optional. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` + "appVersion": "A String", # Optional. The app version to evaluate. At most one of `app_version` or `deployment` can be set. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "config": { # EvaluationConfig configures settings for running the evaluation. # Optional. The configuration to use for the run. "evaluationChannel": "A String", # Optional. The channel to evaluate. "inputAudioConfig": { # InputAudioConfig configures how the CES agent should interpret the incoming audio data. # Optional. Configuration for processing the input audio. @@ -200,7 +200,7 @@

Method Details

"nextScheduledExecutionTime": "A String", # Output only. The next time this is scheduled to execute "request": { # Request message for EvaluationService.RunEvaluation. # Required. The RunEvaluationRequest to schedule "app": "A String", # Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}` - "appVersion": "A String", # Optional. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` + "appVersion": "A String", # Optional. The app version to evaluate. At most one of `app_version` or `deployment` can be set. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "config": { # EvaluationConfig configures settings for running the evaluation. # Optional. The configuration to use for the run. "evaluationChannel": "A String", # Optional. The channel to evaluate. "inputAudioConfig": { # InputAudioConfig configures how the CES agent should interpret the incoming audio data. # Optional. Configuration for processing the input audio. @@ -302,7 +302,7 @@

Method Details

"nextScheduledExecutionTime": "A String", # Output only. The next time this is scheduled to execute "request": { # Request message for EvaluationService.RunEvaluation. # Required. The RunEvaluationRequest to schedule "app": "A String", # Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}` - "appVersion": "A String", # Optional. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` + "appVersion": "A String", # Optional. The app version to evaluate. At most one of `app_version` or `deployment` can be set. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "config": { # EvaluationConfig configures settings for running the evaluation. # Optional. The configuration to use for the run. "evaluationChannel": "A String", # Optional. The channel to evaluate. "inputAudioConfig": { # InputAudioConfig configures how the CES agent should interpret the incoming audio data. # Optional. Configuration for processing the input audio. @@ -392,7 +392,7 @@

Method Details

"nextScheduledExecutionTime": "A String", # Output only. The next time this is scheduled to execute "request": { # Request message for EvaluationService.RunEvaluation. # Required. The RunEvaluationRequest to schedule "app": "A String", # Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}` - "appVersion": "A String", # Optional. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` + "appVersion": "A String", # Optional. The app version to evaluate. At most one of `app_version` or `deployment` can be set. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "config": { # EvaluationConfig configures settings for running the evaluation. # Optional. The configuration to use for the run. "evaluationChannel": "A String", # Optional. The channel to evaluate. "inputAudioConfig": { # InputAudioConfig configures how the CES agent should interpret the incoming audio data. # Optional. Configuration for processing the input audio. @@ -486,7 +486,7 @@

Method Details

"nextScheduledExecutionTime": "A String", # Output only. The next time this is scheduled to execute "request": { # Request message for EvaluationService.RunEvaluation. # Required. The RunEvaluationRequest to schedule "app": "A String", # Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}` - "appVersion": "A String", # Optional. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` + "appVersion": "A String", # Optional. The app version to evaluate. At most one of `app_version` or `deployment` can be set. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "config": { # EvaluationConfig configures settings for running the evaluation. # Optional. The configuration to use for the run. "evaluationChannel": "A String", # Optional. The channel to evaluate. "inputAudioConfig": { # InputAudioConfig configures how the CES agent should interpret the incoming audio data. # Optional. Configuration for processing the input audio. @@ -563,7 +563,7 @@

Method Details

"nextScheduledExecutionTime": "A String", # Output only. The next time this is scheduled to execute "request": { # Request message for EvaluationService.RunEvaluation. # Required. The RunEvaluationRequest to schedule "app": "A String", # Required. The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}` - "appVersion": "A String", # Optional. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` + "appVersion": "A String", # Optional. The app version to evaluate. At most one of `app_version` or `deployment` can be set. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "config": { # EvaluationConfig configures settings for running the evaluation. # Optional. The configuration to use for the run. "evaluationChannel": "A String", # Optional. The channel to evaluate. "inputAudioConfig": { # InputAudioConfig configures how the CES agent should interpret the incoming audio data. # Optional. Configuration for processing the input audio. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html index 1db1fcf8e9..7e21b7d638 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html @@ -135,6 +135,7 @@

Method Details

"deployment": "A String", # Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "enableTextStreaming": True or False, # Optional. Whether to enable streaming text outputs from the model. By default, text outputs from the model are collected before sending to the client. NOTE: This is only supported for text (non-voice) sessions via StreamRunSession or BidiRunSession. "entryAgent": "A String", # Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "excludeDiagnosticInfo": True or False, # Optional. Whether to exclude diagnostic info from the session output. "historicalContexts": [ # Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state. { # A message within a conversation. "chunks": [ # Optional. Content of the message as a series of chunks. @@ -410,6 +411,7 @@

Method Details

"deployment": "A String", # Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "enableTextStreaming": True or False, # Optional. Whether to enable streaming text outputs from the model. By default, text outputs from the model are collected before sending to the client. NOTE: This is only supported for text (non-voice) sessions via StreamRunSession or BidiRunSession. "entryAgent": "A String", # Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "excludeDiagnosticInfo": True or False, # Optional. Whether to exclude diagnostic info from the session output. "historicalContexts": [ # Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state. { # A message within a conversation. "chunks": [ # Optional. Content of the message as a series of chunks. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html index f330574dbc..10814ed94e 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html @@ -297,6 +297,9 @@

Method Details

}, "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. + }, "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. @@ -812,6 +815,9 @@

Method Details

}, "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. + }, "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. @@ -1353,6 +1359,9 @@

Method Details

}, "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. + }, "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. @@ -1881,6 +1890,9 @@

Method Details

}, "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. + }, "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. @@ -2413,6 +2425,9 @@

Method Details

}, "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. + }, "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. @@ -2928,6 +2943,9 @@

Method Details

}, "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. + }, "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. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html index 9e78b66089..b997c61d74 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html @@ -1676,6 +1676,9 @@

Method Details

}, "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. + }, "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. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html index 07fd96ee32..55bb07d957 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html @@ -259,11 +259,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -909,6 +910,9 @@

Method Details

}, "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. + }, "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. @@ -1590,11 +1594,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -2240,6 +2245,9 @@

Method Details

}, "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. + }, "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. @@ -2946,11 +2954,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -3596,6 +3605,9 @@

Method Details

}, "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. + }, "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. @@ -4133,7 +4145,7 @@

Method Details

Gets the extended agent card for the authenticated agent.
 
 Args:
-  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  tenant: string, Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -4291,7 +4303,7 @@ 

Method Details

{ # 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. + "tenant": "A String", # Optional. An opaque string used for routing requests to a specific agent or tenant when multiple agents are served behind a single A2A endpoint. When set, clients MUST include this value in the `tenant` field of all request messages sent to this interface. The server is responsible for interpreting the value and routing requests accordingly; the protocol does not define its format or semantics. "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" }, ], @@ -4460,11 +4472,12 @@

Method Details

"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. 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. + "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. }, }, }, @@ -5110,6 +5123,9 @@

Method Details

}, "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. + }, "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. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.message.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.message.html index d66bbec946..9c0007933f 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.message.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.message.html @@ -91,7 +91,7 @@

Method Details

Sends a message to an agent.
 
 Args:
-  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  tenant: string, Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -109,7 +109,7 @@ 

Method Details

}, "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration. "taskId": "A String", # The ID of the task this configuration is associated with. - "tenant": "A String", # Optional. Tenant ID. + "tenant": "A String", # Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set. "token": "A String", # A token unique for this task or session. "url": "A String", # Required. The URL where the notification should be sent. }, diff --git a/googleapiclient/discovery_cache/documents/ces.v1.json b/googleapiclient/discovery_cache/documents/ces.v1.json index f60e33c191..2769525bb3 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1.json +++ b/googleapiclient/discovery_cache/documents/ces.v1.json @@ -361,7 +361,7 @@ ], "parameters": { "tenant": { -"description": "Optional. Tenant ID, provided as a path parameter.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true, @@ -1087,7 +1087,7 @@ ], "parameters": { "tenant": { -"description": "Optional. Tenant ID, provided as a path parameter.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "required": true, @@ -1194,7 +1194,7 @@ ], "parameters": { "tenant": { -"description": "Optional. Tenant ID, provided as a path parameter.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "required": true, @@ -1588,7 +1588,7 @@ ], "parameters": { "tenant": { -"description": "Optional. Tenant ID, provided as a path parameter.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true, @@ -2196,7 +2196,7 @@ ], "parameters": { "tenant": { -"description": "Optional. Tenant ID, provided as a path parameter.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "required": true, @@ -2302,7 +2302,7 @@ ], "parameters": { "tenant": { -"description": "Optional. Tenant ID, provided as a path parameter.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "required": true, @@ -2464,7 +2464,7 @@ } } }, -"revision": "20260708", +"revision": "20260730", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -4042,6 +4042,10 @@ "rootSpan": { "$ref": "Span", "description": "Optional. The root span of the action processing." +}, +"userIntendedText": { +"description": "Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled.", +"type": "string" } }, "type": "object" @@ -4413,6 +4417,10 @@ "$ref": "DataStoreToolRewriterConfig", "description": "Optional. The rewriter config." }, +"snippetsConfig": { +"$ref": "DataStoreToolSnippetsConfig", +"description": "Optional. The snippets configuration." +}, "summarizationConfig": { "$ref": "DataStoreToolSummarizationConfig", "description": "Optional. The summarization config." @@ -4439,6 +4447,17 @@ }, "type": "object" }, +"DataStoreToolSnippetsConfig": { +"description": "Snippets configuration.", +"id": "DataStoreToolSnippetsConfig", +"properties": { +"enableSnippets": { +"description": "Optional. Whether snippets are enabled.", +"type": "boolean" +} +}, +"type": "object" +}, "DataStoreToolSummarizationConfig": { "description": "Summarization configuration.", "id": "DataStoreToolSummarizationConfig", @@ -4493,6 +4512,26 @@ "$ref": "InstagramCredentials", "description": "Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile." }, +"modality": { +"description": "Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field.", +"enum": [ +"MODALITY_UNSPECIFIED", +"MODALITY_TEXT", +"MODALITY_VOICE", +"MODALITY_VIDEO" +], +"enumDescriptions": [ +"Unknown modality.", +"Text modality.", +"Voice modality.", +"Video modality." +], +"type": "string" +}, +"modelSettings": { +"$ref": "ModelSettings", +"description": "Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field." +}, "name": { "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" @@ -5542,6 +5581,10 @@ "Overwrite existing data with imported data. If an app with the same `app_id` already exists, its content will be overwritten with the imported app. - Existing resources (Agents, Tools, Examples, Guardrails, Toolsets) in the app will be deleted. - Imported resources will be created as new resources." ], "type": "string" +}, +"validateOnly": { +"description": "Optional. Flag for dry-running the import process. If set to true, the import process will only perform validations and will not make any changes to the existing app or create a new one.", +"type": "boolean" } }, "type": "object" @@ -5830,7 +5873,7 @@ "type": "string" }, "tenant": { -"description": "Tenant ID to be used in the request when calling the agent.", +"description": "Optional. An opaque string used for routing requests to a specific agent or tenant when multiple agents are served behind a single A2A endpoint. When set, clients MUST include this value in the `tenant` field of all request messages sent to this interface. The server is responsible for interpreting the value and routing requests accordingly; the protocol does not define its format or semantics.", "type": "string" }, "url": { @@ -6460,7 +6503,7 @@ "type": "string" }, "tenant": { -"description": "Optional. Tenant ID.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "type": "string" }, "token": { @@ -7674,6 +7717,10 @@ "description": "Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, +"excludeDiagnosticInfo": { +"description": "Optional. Whether to exclude diagnostic info from the session output.", +"type": "boolean" +}, "historicalContexts": { "description": "Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.", "items": { @@ -7942,6 +7989,11 @@ "description": "Configuration for how the agent response should be synthesized.", "id": "SynthesizeSpeechConfig", "properties": { +"consentAudioGcsUri": { +"deprecated": true, +"description": "Optional. Deprecated: Use `custom_voice_samples` in AudioProcessingConfig instead. The Cloud Storage URI to the consent audio for voice cloning.", +"type": "string" +}, "instruction": { "description": "Optional. The instruction used to synthesize speech when using a generative model.", "type": "string" @@ -7960,7 +8012,8 @@ "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. 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.", +"deprecated": true, +"description": "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.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/ces.v1beta.json b/googleapiclient/discovery_cache/documents/ces.v1beta.json index dce9578d67..26081474ad 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1beta.json +++ b/googleapiclient/discovery_cache/documents/ces.v1beta.json @@ -451,7 +451,7 @@ ], "parameters": { "tenant": { -"description": "Optional. Tenant ID, provided as a path parameter.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true, @@ -1293,7 +1293,7 @@ ], "parameters": { "tenant": { -"description": "Optional. Tenant ID, provided as a path parameter.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "required": true, @@ -1400,7 +1400,7 @@ ], "parameters": { "tenant": { -"description": "Optional. Tenant ID, provided as a path parameter.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "required": true, @@ -2699,7 +2699,7 @@ ], "parameters": { "tenant": { -"description": "Optional. Tenant ID, provided as a path parameter.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", "required": true, @@ -3484,7 +3484,7 @@ ], "parameters": { "tenant": { -"description": "Optional. Tenant ID, provided as a path parameter.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "required": true, @@ -3590,7 +3590,7 @@ ], "parameters": { "tenant": { -"description": "Optional. Tenant ID, provided as a path parameter.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", "required": true, @@ -3752,7 +3752,7 @@ } } }, -"revision": "20260708", +"revision": "20260730", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -5590,6 +5590,10 @@ "rootSpan": { "$ref": "Span", "description": "Optional. The root span of the action processing." +}, +"userIntendedText": { +"description": "Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled.", +"type": "string" } }, "type": "object" @@ -5961,6 +5965,10 @@ "$ref": "DataStoreToolRewriterConfig", "description": "Optional. The rewriter config." }, +"snippetsConfig": { +"$ref": "DataStoreToolSnippetsConfig", +"description": "Optional. The snippets configuration." +}, "summarizationConfig": { "$ref": "DataStoreToolSummarizationConfig", "description": "Optional. The summarization config." @@ -5987,6 +5995,17 @@ }, "type": "object" }, +"DataStoreToolSnippetsConfig": { +"description": "Snippets configuration.", +"id": "DataStoreToolSnippetsConfig", +"properties": { +"enableSnippets": { +"description": "Optional. Whether snippets are enabled.", +"type": "boolean" +} +}, +"type": "object" +}, "DataStoreToolSummarizationConfig": { "description": "Summarization configuration.", "id": "DataStoreToolSummarizationConfig", @@ -6047,6 +6066,26 @@ "$ref": "InstagramCredentials", "description": "Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile." }, +"modality": { +"description": "Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field.", +"enum": [ +"MODALITY_UNSPECIFIED", +"MODALITY_TEXT", +"MODALITY_VOICE", +"MODALITY_VIDEO" +], +"enumDescriptions": [ +"Unknown modality.", +"Text modality.", +"Voice modality.", +"Video modality." +], +"type": "string" +}, +"modelSettings": { +"$ref": "ModelSettings", +"description": "Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field." +}, "name": { "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" @@ -6347,12 +6386,10 @@ }, "inputAudioConfig": { "$ref": "InputAudioConfig", -"deprecated": true, "description": "Optional. Configuration for processing the input audio." }, "outputAudioConfig": { "$ref": "OutputAudioConfig", -"deprecated": true, "description": "Optional. Configuration for generating the output audio." }, "toolCallBehaviour": { @@ -7087,11 +7124,29 @@ "description": "Identifier. The unique identifier of the evaluation result. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`", "type": "string" }, +"outcomeMetadata": { +"description": "Output only. The outcome metadata of the evaluation. Only populated if execution_state is COMPLETE.", +"enum": [ +"OUTCOME_METADATA_UNSPECIFIED", +"GRACEFUL_HANDOFF" +], +"enumDescriptions": [ +"Unspecified outcome metadata.", +"The evaluation resulted in a graceful handoff to a human representative." +], +"readOnly": true, +"type": "string" +}, "persona": { "$ref": "EvaluationPersona", "description": "Output only. The persona used to generate the conversation for the evaluation result.", "readOnly": true }, +"rootSpan": { +"$ref": "Span", +"description": "Output only. The root span of the evaluation execution, which includes information about each step of the evaluation.", +"readOnly": true +}, "scenarioResult": { "$ref": "EvaluationResultScenarioResult", "description": "Output only. The outcome of a scenario evaluation.", @@ -7743,12 +7798,12 @@ "type": "string" }, "label": { -"description": "Output only. The label associated with each score. Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified", +"description": "Output only. The label associated with each score. Score 2: Graceful Handoff Score 1: User Task Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified", "readOnly": true, "type": "string" }, "score": { -"description": "Output only. The user task satisfaction score. Can be -1, 0, 1.", +"description": "Output only. The user task satisfaction score. Can be -1, 0, 1, 2.", "format": "int32", "readOnly": true, "type": "integer" @@ -9571,6 +9626,10 @@ "Overwrite existing data with imported data. If an app with the same `app_id` already exists, its content will be overwritten with the imported app. - Existing resources (Agents, Tools, Examples, Guardrails, Toolsets) in the app will be deleted. - Imported resources will be created as new resources." ], "type": "string" +}, +"validateOnly": { +"description": "Optional. Flag for dry-running the import process. If set to true, the import process will only perform validations and will not make any changes to the existing app or create a new one.", +"type": "boolean" } }, "type": "object" @@ -10153,7 +10212,7 @@ "type": "string" }, "tenant": { -"description": "Tenant ID to be used in the request when calling the agent.", +"description": "Optional. An opaque string used for routing requests to a specific agent or tenant when multiple agents are served behind a single A2A endpoint. When set, clients MUST include this value in the `tenant` field of all request messages sent to this interface. The server is responsible for interpreting the value and routing requests accordingly; the protocol does not define its format or semantics.", "type": "string" }, "url": { @@ -10783,7 +10842,7 @@ "type": "string" }, "tenant": { -"description": "Optional. Tenant ID.", +"description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.", "type": "string" }, "token": { @@ -12015,7 +12074,7 @@ "type": "string" }, "appVersion": { -"description": "Optional. The app version to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", +"description": "Optional. The app version to evaluate. At most one of `app_version` or `deployment` can be set. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`", "type": "string" }, "config": { @@ -12463,6 +12522,10 @@ "description": "Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, +"excludeDiagnosticInfo": { +"description": "Optional. Whether to exclude diagnostic info from the session output.", +"type": "boolean" +}, "historicalContexts": { "description": "Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.", "items": { @@ -12731,6 +12794,11 @@ "description": "Configuration for how the agent response should be synthesized.", "id": "SynthesizeSpeechConfig", "properties": { +"consentAudioGcsUri": { +"deprecated": true, +"description": "Optional. Deprecated: Use `custom_voice_samples` in AudioProcessingConfig instead. The Cloud Storage URI to the consent audio for voice cloning.", +"type": "string" +}, "instruction": { "description": "Optional. The instruction used to synthesize speech when using a generative model.", "type": "string" @@ -12749,7 +12817,8 @@ "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. 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.", +"deprecated": true, +"description": "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.", "type": "string" } }, From 11a8454e0ead7a3353f643270c5328612017ed31 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:00 +0000 Subject: [PATCH 24/84] feat(chat): update the api #### chat:v1 The following keys were added: - resources.spaces.resources.messages.methods.get.parameters.markupSyntax (Total Keys: 2) - resources.spaces.resources.messages.methods.list.parameters.markupSyntax (Total Keys: 2) - resources.spaces.resources.messages.methods.search (Total Keys: 12) - schemas.Message.properties.markupSyntax.type (Total Keys: 1) - schemas.SearchMessageResult (Total Keys: 5) - schemas.SearchMessagesRequest (Total Keys: 9) - schemas.SearchMessagesResponse (Total Keys: 5) - schemas.SearchSpaceResult (Total Keys: 4) - schemas.SearchSpacesResponse.properties.results (Total Keys: 3) The following keys were changed: - resources.spaces.resources.spaceEvents.methods.get.scopes (Total Keys: 1) - resources.spaces.resources.spaceEvents.methods.list.scopes (Total Keys: 1) - resources.users.resources.availability.methods.get.scopes (Total Keys: 1) - resources.users.resources.availability.methods.markAsActive.scopes (Total Keys: 1) - resources.users.resources.availability.methods.markAsAway.scopes (Total Keys: 1) - resources.users.resources.availability.methods.markAsDoNotDisturb.scopes (Total Keys: 1) - resources.users.resources.availability.methods.patch.scopes (Total Keys: 1) --- docs/dyn/chat_v1.spaces.html | 105 +- docs/dyn/chat_v1.spaces.messages.html | 3124 ++++++++++++++++- docs/dyn/chat_v1.spaces.spaceEvents.html | 12 + .../discovery_cache/documents/chat.v1.json | 230 +- 4 files changed, 3449 insertions(+), 22 deletions(-) diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index 57f72b6925..3a453b7f2d 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -124,7 +124,7 @@

Instance Methods

Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces` App authentication has the following limitations: - To update either `space.predefined_permission_settings` or `space.permission_settings`, the app must be the space creator. - Updating the `space.access_settings.audience` is not supported for app authentication.

search(orderBy=None, pageSize=None, pageToken=None, query=None, useAdminAccess=None, x__xgafv=None)

-

Returns a list of spaces in a Google Workspace organization. For an example, see [Search for and manage spaces](https://developers.google.com/workspace/chat/search-manage-admin). When `use_admin_access` is set to `false`, the results are limited to spaces where the calling user is a joined member. To search with administrator privileges, set `use_admin_access` to `true`. Setting `use_admin_access` to `false` is available under Developer Preview. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - [User authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces`

+

Returns a list of spaces in a Google Workspace organization. For an example, see [Search for and manage spaces](https://developers.google.com/workspace/chat/search-manage-admin). When `use_admin_access` is set to `false`, the results are limited to spaces where the calling user is a joined member. To search with administrator privileges, set `use_admin_access` to `true`. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - [User authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces`

search_next()

Retrieves the next page of results.

@@ -1173,14 +1173,14 @@

Method Details

search(orderBy=None, pageSize=None, pageToken=None, query=None, useAdminAccess=None, x__xgafv=None) -
Returns a list of spaces in a Google Workspace organization. For an example, see [Search for and manage spaces](https://developers.google.com/workspace/chat/search-manage-admin). When `use_admin_access` is set to `false`, the results are limited to spaces where the calling user is a joined member. To search with administrator privileges, set `use_admin_access` to `true`. Setting `use_admin_access` to `false` is available under Developer Preview. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - [User authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces`
+  
Returns a list of spaces in a Google Workspace organization. For an example, see [Search for and manage spaces](https://developers.google.com/workspace/chat/search-manage-admin). When `use_admin_access` is set to `false`, the results are limited to spaces where the calling user is a joined member. To search with administrator privileges, set `use_admin_access` to `true`. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - [User authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces`
 
 Args:
   orderBy: string, Optional. How the list of spaces is ordered. Supported attributes to order by are: - `membership_count.joined_direct_human_user_count` — Denotes the count of human users that have directly joined a space. - `last_active_time` — Denotes the time when last eligible item is added to any topic of this space. - `create_time` — Denotes the time of the space creation. When `useAdminAccess` is `false`, only `create_time` and `relevance` are supported for ordering. Only `DESC` is supported for these fields in non-admin searches. Valid ordering operation values are: - `ASC` for ascending. Default value. - `DESC` for descending. The supported syntax are when `useAdminAccess` is set to `true`: - `membership_count.joined_direct_human_user_count DESC` - `membership_count.joined_direct_human_user_count ASC` - `last_active_time DESC` - `last_active_time ASC` - `create_time DESC` - `create_time ASC` When `useAdminAccess` is set to `false`: - `create_time DESC` - `relevance DESC`
   pageSize: integer, The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.
   pageToken: string, A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
-  query: string, Required. A search query. You can search by using the following parameters when `useAdminAccess` is set to `true`: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` When `useAdminAccess` is set to `false`: - `display_name` - `external_user_allowed` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required when `useAdminAccess` is set to `true`, and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. When `useAdminAccess` is set to `false`, `display_name` is required to retrieve meaningful results. Otherwise, the default behavior is to return an empty response. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required when `useAdminAccess` is set to `true`, and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid example is `space_type = "SPACE" OR display_name:"Hello"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"`. The following example queries are valid when `useAdminAccess` is set to `true`: ``` customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF") ``` The following example queries are valid when `useAdminAccess` is set to `false`: ``` display_name:"Hello World" (display_name:"Hello" OR display_name:"Fun") (external_user_allowed = "true") // Returns an empty response. (external_user_allowed = "true" AND display_name:"Hello") ```
-  useAdminAccess: boolean, When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Setting `use_admin_access` to `false` is available under Developer Preview. [Developer Preview](https://developers.google.com/workspace/preview).
+  query: string, Required. A search query. You can search by using the following parameters when `useAdminAccess` is set to `true`: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` When `useAdminAccess` is set to `false`: - `display_name` - `external_user_allowed` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required when `useAdminAccess` is set to `true`, and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. When `useAdminAccess` is set to `false`, `display_name` is required to retrieve meaningful results. Otherwise, the default behavior is to return an empty response. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid example is `space_type = "SPACE" OR display_name:"Hello"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"`. The following example queries are valid when `useAdminAccess` is set to `true`: ``` customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF") ``` The following example queries are valid when `useAdminAccess` is set to `false`: ``` display_name:"Hello World" AND space_type = "SPACE" (display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE" (external_user_allowed = "true" AND space_type = "SPACE") // Returns an empty response. (external_user_allowed = "true" AND display_name:"Hello" AND space_type = "SPACE") ```
+  useAdminAccess: boolean, When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1191,6 +1191,103 @@ 

Method Details

{ # Response with a list of spaces corresponding to the search spaces request. "nextPageToken": "A String", # A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages. + "results": [ # Output only. The list of search results that matched the query. + { # A single result item from a space search. + "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. # Output only. The matched 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. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, + "accessState": "A String", # Output only. Indicates the access state of the space. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + }, + "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. + "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. + "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. + "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + "importModeExpireTime": "A String", # Output only. The time when the space will be automatically deleted by the system if it remains in import mode. Each space created in import mode must exit this mode before this expire time using `spaces.completeImport`. This field is only populated for spaces that were created with import mode. + "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space. + "membershipCount": { # Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. + "joinedDirectHumanUserCount": 42, # Output only. Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. + "joinedGroupCount": 42, # Output only. Count of all groups that have directly joined the space. + }, + "name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. + "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. + }, + "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. + }, + "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. + }, + "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. + }, + "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. + }, + "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. + }, + "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. + }, + "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. + "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. + "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. + }, + }, + "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. + "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. + }, + "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. + "spaceThreadingState": "A String", # Output only. The threading state in the Chat space. + "spaceType": "A String", # Optional. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage. + "spaceUri": "A String", # Output only. The URI for a user to access the space. + "threaded": True or False, # Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space. + "type": "A String", # Output only. Deprecated: Use `space_type` instead. The type of a space. + }, + }, + ], "spaces": [ # Deprecated: Please use the new `results` field instead. A page of the requested spaces. This field will be populated only when `useAdminAccess` is set to `true` and deprecated in favor of the new `results` field. { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "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`. diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index dfe3d56bb1..a4b4d59099 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -94,10 +94,10 @@

Instance Methods

delete(name, force=None, x__xgafv=None)

Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only delete messages created by the calling Chat app.

- get(name, x__xgafv=None)

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

Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot`: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash commands](https://developers.google.com/workspace/chat/slash-commands) that invoke the Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly` with [administrator approval](https://support.google.com/a?p=chat-app-auth). When using this authentication scope, this method returns details about a public message in a space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space.

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

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

Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the authorization scope: - `https://www.googleapis.com/auth/chat.app.messages.readonly`. When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)

list_next()

@@ -105,6 +105,12 @@

Instance Methods

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

Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app.

+

+ search(parent, body=None, x__xgafv=None)

+

Searches for messages in Google Chat that the calling user has access to. Returns a list of messages matching the search criteria. To search across all spaces the user has access to, set `parent` to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. The returned messages have their `name` field populated with the full resource name, which includes the specific `space` in which the message resides. This API doesn't return all message types. The types of messages listed below aren't included in the response. Use ListMessages to list all messages. - Private Messages that are visible to the authenticated user. - Messages posted by Chat apps in spaces or group chats. - Messages in a Chat app DM. - Messages from blocked users. - Messages in spaces that the caller has muted. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages`

+

+ search_next()

+

Retrieves the next page of results.

update(name, allowMissing=None, body=None, updateMask=None, x__xgafv=None)

Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app.

@@ -2944,6 +2950,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -6006,6 +6013,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -6247,11 +6255,16 @@

Method Details

- get(name, x__xgafv=None) + get(name, markupSyntax=None, x__xgafv=None)
Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot`: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash commands](https://developers.google.com/workspace/chat/slash-commands) that invoke the Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly` with [administrator approval](https://support.google.com/a?p=chat-app-auth). When using this authentication scope, this method returns details about a public message in a space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space.
 
 Args:
   name: string, Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message). (required)
+  markupSyntax: string, Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.
+    Allowed values
+      MARKUP_SYNTAX_UNSPECIFIED - Represents the unspecified value.
+      MARKUP_SYNTAX_CHAT - Uses Google Chat's markup syntax. See https://developers.google.com/workspace/chat/format-messages#format-texts for more information.
+      MARKUP_SYNTAX_MARKDOWN - Uses Markdown syntax. This syntax is based on the [CommonMark](https://commonmark.org/help/) specification, with additional extensions. See https://developers.google.com/workspace/chat/format-messages#format-texts for more information.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -9081,6 +9094,7 @@ 

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -9303,12 +9317,17 @@

Method Details

- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) + list(parent, filter=None, markupSyntax=None, orderBy=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)
Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the authorization scope: - `https://www.googleapis.com/auth/chat.app.messages.readonly`. When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
 
 Args:
   parent: string, Required. The resource name of the space to list messages from. Format: `spaces/{space}` (required)
   filter: string, Optional. A query filter. You can filter messages by date (`create_time`) and thread (`thread.name`). To filter messages by the date they were created, specify the `create_time` with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and double quotation marks. For example, `"2023-04-21T11:30:00-04:00"`. You can use the greater than operator `>` to list messages that were created after a timestamp, or the less than operator `<` to list messages that were created before a timestamp. To filter messages within a time interval, use the `AND` operator between two timestamps. To filter by thread, specify the `thread.name`, formatted as `spaces/{space}/threads/{thread}`. You can only specify one `thread.name` per query. To filter by both thread and date, use the `AND` operator in your query. For example, the following queries are valid: ``` create_time > "2012-04-21T11:30:00-04:00" create_time > "2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > "2012-04-21T11:30:00+00:00" AND create_time < "2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.
+  markupSyntax: string, Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.
+    Allowed values
+      MARKUP_SYNTAX_UNSPECIFIED - Represents the unspecified value.
+      MARKUP_SYNTAX_CHAT - Uses Google Chat's markup syntax. See https://developers.google.com/workspace/chat/format-messages#format-texts for more information.
+      MARKUP_SYNTAX_MARKDOWN - Uses Markdown syntax. This syntax is based on the [CommonMark](https://commonmark.org/help/) specification, with additional extensions. See https://developers.google.com/workspace/chat/format-messages#format-texts for more information.
   orderBy: string, Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: - `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.
   pageSize: integer, Optional. The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.
   pageToken: string, Optional. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
@@ -12144,6 +12163,7 @@ 

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -15212,6 +15232,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -18263,6 +18284,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -18484,6 +18506,3098 @@

Method Details

}
+
+ search(parent, body=None, x__xgafv=None) +
Searches for messages in Google Chat that the calling user has access to. Returns a list of messages matching the search criteria. To search across all spaces the user has access to, set `parent` to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. The returned messages have their `name` field populated with the full resource name, which includes the specific `space` in which the message resides. This API doesn't return all message types. The types of messages listed below aren't included in the response. Use ListMessages to list all messages. - Private Messages that are visible to the authenticated user. - Messages posted by Chat apps in spaces or group chats. - Messages in a Chat app DM. - Messages from blocked users. - Messages in spaces that the caller has muted. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages`
+
+Args:
+  parent: string, Required. The resource name of the space to search within. To search across all spaces the user has access to, set this field to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. To limit the search to one or more spaces, use `space.name` or `space.display_name` in the `filter`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for searching messages.
+  "filter": "A String", # Required. A search query. The query can specify one or more search keywords, which are used to filter the results, You can also filter the results using the following message fields: - `create_time`: Accepts a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `<` and `>=`. - `sender.name`: The resource name of the sender (`users/{user}`). Only supports `=`. You can use the e-mail as an alias for `{user}`. For example, `users/example@gmail.com`, where `example@gmail.com` is the e-mail of the Google Chat user. - `space.name`: The resource name of the space where the message is posted. (`spaces/{space}`). Only supports `=`. If this filter is not set, the search is performed across all direct messages and spaces the user has access to as a space member. - `space.display_name`: Supports the operator `:` (has) and filters spaces based on a partial match of their display name. Results are limited to the top five space matches. For example, `space.display_name:Project` searches for messages in the top five spaces that contain the word "Project" in their display names. - `attachment`: Supports the operator `:*` (has any) to check for the presence of attachments. If `attachment:*` is specified, only messages that have at least one attachment are returned. - `annotations.user_mentions.user.name`: The resource name of the mentioned user (`users/{user}`). Only supports `:` (has). For example: `annotations.user_mentions.user.name:"users/1234567890"` returns only messages that contain a mention to the specified user. Alternatively, the alias `me` can be used to filter for messages that mention the caller user, for example: `annotations.user_mentions.user.name:users/me`. You can also use the e-mail as an alias for `{user}`, for example, `users/example@gmail.com`. For advanced filtering, the following functions are also available: - `has_link()`: Returns only messages that have at least one hyperlink in the message text. - `is_unread()`: Filters out messages that have been read by the calling user. Using the `space.display_name` filter requires that the calling credentials include one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` Using the `is_unread()` filter requires that the calling credentials include one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate` Across different fields, only `AND` operators are supported. A valid example is `sender.name = "users/1234567890" AND is_unread()`. The word `AND` is optional and is implied if omitted. For example, `sender.name = "users/1234567890" is_unread()` is valid and is equivalent to the previous example. An invalid example is `sender.name = "users/1234567890" OR is_unread()` because `OR` is not supported between different fields. Among the same field: - `create_time` supports only `AND`, and can only be used to represent an interval, such as `create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00"`. - `sender.name` supports only the `OR` operator, for example: `sender.name = "users/1234567890" OR sender.name = "users/0987654321"`. - `space.name` supports only the `OR` operator, for example: `space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI"`. - `space.display_name` supports the operators `AND` and `OR`, but not a mix of both. For example: `space.display_name:Project AND space.display_name:Tasks` returns messages that are in spaces with display names containing both `Project` and `Tasks`, whereas `space.display_name:Project OR space.display_name:Tasks` returns messages that are in spaces with display names containing either `Project` or `Tasks` or both. - `annotations.user_mentions.user.name` supports the operators `AND` and `OR`, but not a mix of both. For example: `annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321"` returns only messages that mentions both users, whereas `annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321"` returns messages that mention either user or both. Parentheses are required to disambiguate operator precedence when combining `AND` and `OR` operators in the same query. For example: `(sender.name="users/me" OR sender.name="users/123456") AND is_unread()`. Otherwise, parentheses are optional. The following example queries are valid: ``` "Pending reports" AND create_time >= "2023-01-01T00:00:00Z" sender.name = "users/example@gmail.com" annotations.user_mentions.user.name:"users/0987654321" attachment:* AND space.name = "spaces/ABCDEFGH" tasks AND is_unread() AND sender.name = "users/1234567890" "things to do" "urgent" (sender.name = "users/1234567890") AND (create_time < "2023-05-01T00:00:00Z") tasks AND space.name = "spaces/ABCDEFGH" AND has_link() "project one" is_unread() space.display_name:Project tasks ``` The maximum query length is 1,000 characters. Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.
+  "markupSyntax": "A String", # Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.
+  "orderBy": "A String", # Optional. How the results list is ordered. Supported attributes to order by are: - `create_time`: Sorts the results by the time of the message creation. Default value. - `relevance`: Sorts the results by relevance. [Developer Preview](https://developers.google.com/workspace/preview). The default ordering is `create_time desc`. Only a single order per query (`create_time` or `relevance`) is supported. Only descending order (`desc`) is supported, and it must be specified after the order attribute.
+  "pageSize": 42, # Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 25 are returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100.
+  "pageToken": "A String", # Optional. A token, received from the previous search messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
+  "view": "A String", # Optional. Specifies what kind of search results view to return. The default is `SEARCH_MESSAGES_VIEW_BASIC`.
+}
+
+  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 searching messages.
+  "nextPageToken": "A String", # A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.
+  "results": [ # The list of search results that matched the query.
+    { # A single result item from a message search.
+      "message": { # A message in a Google Chat space. # The matched message.
+        "accessoryWidgets": [ # Optional. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
+          { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets).
+            "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons.
+              "buttons": [ # An array of buttons.
+                { # A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). To make an image a clickable button, specify an `Image` (not an `ImageComponent`) and set an `onClick` action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                  "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat".
+                  "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Optional. The color of the button. If set, the button `type` is set to `FILLED` and the color of `text` and `icon` fields are set to a contrasting color for readability. For example, if the button color is set to blue, any text or icons in the button are set to white. To set the button color, specify a value for the `red`, `green`, and `blue` fields. The value must be a float number between 0 and 1 based on the RGB color value, where `0` (0/255) represents the absence of color and `1` (255/255) represents the maximum intensity of the color. For example, the following sets the color to red at its maximum intensity: ``` "color": { "red": 1, "green": 0, "blue": 0, } ``` The `alpha` field is unavailable for button color. If specified, this field is ignored.
+                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+                  },
+                  "disabled": True or False, # If `true`, the button is displayed in an inactive state and doesn't respond to user actions.
+                  "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed inside the button. If both `icon` and `text` are set, then the icon appears before the text.
+                    "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                    "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                    "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                    "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                    "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                      "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                      "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                      "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                      "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                    },
+                  },
+                  "onClick": { # Represents how to respond when users click an interactive element on a card, such as a button. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function.
+                    "action": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # If specified, an action is triggered by this `onClick`.
+                      "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                      "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                      "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                      "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                      "parameters": [ # List of action parameters.
+                        { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          "key": "A String", # The name of the parameter for the action script.
+                          "value": "A String", # The value of the parameter.
+                        },
+                      ],
+                      "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                      "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                        "A String",
+                      ],
+                    },
+                    "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                      "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ```
+                        { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                          "actionLabel": "A String", # The label that displays as the action menu item.
+                          "onClick": # Object with schema name: GoogleAppsCardV1OnClick # The `onClick` action for this action item.
+                        },
+                      ],
+                      "displayStyle": "A String", # In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                      "expressionData": [ # The expression data for the card. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                        { # Represents the data that is used to evaluate an expression. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                          "conditions": [ # The list of conditions that are determined by the expression evaluation result.
+                            { # Represents a condition that can be used to trigger an action. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                              "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                              "expressionDataCondition": { # Represents a condition that is evaluated using CEL. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # The condition that is determined by the expression data.
+                                "conditionType": "A String", # The type of the condition.
+                              },
+                            },
+                          ],
+                          "eventActions": [ # The list of actions that the ExpressionData can be used.
+                            { # Represents an actionthat can be performed on an ui element. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                              "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                              "commonWidgetAction": { # Represents an action that is not specific to a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # Common widget action.
+                                "updateVisibilityAction": { # Represents an action that updates the visibility of a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # The action to update the visibility of a widget.
+                                  "visibility": "A String", # The new visibility.
+                                },
+                              },
+                              "postEventTriggers": [ # The list of triggers that will be triggered after the EventAction is executed.
+                                { # Represents a trigger. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                  "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                                },
+                              ],
+                            },
+                          ],
+                          "expression": "A String", # The uncompiled expression.
+                          "id": "A String", # The unique identifier of the ExpressionData.
+                        },
+                      ],
+                      "fixedFooter": { # A persistent (sticky) footer that that appears at the bottom of the card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). For an example in Google Chat apps, see [Add a persistent footer](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                        "primaryButton": # Object with schema name: GoogleAppsCardV1Button # The primary button of the fixed footer. The button must be a text button with text and color set.
+                        "secondaryButton": # Object with schema name: GoogleAppsCardV1Button # The secondary button of the fixed footer. The button must be a text button with text and color set. If `secondaryButton` is set, you must also set `primaryButton`.
+                      },
+                      "header": { # Represents a card header. For an example in Google Chat apps, see [Add a header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
+                        "imageAltText": "A String", # The alternative text of this image that's used for accessibility.
+                        "imageType": "A String", # The shape used to crop the image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                        "imageUrl": "A String", # The HTTPS URL of the image in the card header.
+                        "subtitle": "A String", # The subtitle of the card header. If specified, appears on its own line below the `title`.
+                        "title": "A String", # Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.
+                      },
+                      "name": "A String", # Name of the card. Used as a card identifier in card navigation. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                      "peekCardHeader": { # Represents a card header. For an example in Google Chat apps, see [Add a header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                        "imageAltText": "A String", # The alternative text of this image that's used for accessibility.
+                        "imageType": "A String", # The shape used to crop the image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                        "imageUrl": "A String", # The HTTPS URL of the image in the card header.
+                        "subtitle": "A String", # The subtitle of the card header. If specified, appears on its own line below the `title`.
+                        "title": "A String", # Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.
+                      },
+                      "sectionDividerStyle": "A String", # The divider style between the header, sections and footer.
+                      "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
+                        { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          "collapseControl": { # Represent an expand and collapse control. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used.
+                            "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.
+                            "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.
+                            "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button.
+                          },
+                          "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`.
+                          "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+                          "id": "A String", # A unique ID assigned to the section that's used to identify the section to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                          "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`.
+                          "widgets": [ # All the widgets in the section. Must contain at least one widget.
+                            { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types.
+                              "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ```
+                              "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ```
+                                "carouselCards": [ # A list of cards included in the carousel.
+                                  { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified.
+                                      { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                        "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget.
+                                        "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget.
+                                          "altText": "A String", # The alternative text of this image that's used for accessibility.
+                                          "imageUrl": "A String", # The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```
+                                          "onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
+                                        },
+                                        "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget.
+                                          "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                          "text": "A String", # The text that's shown in the widget.
+                                          "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                        },
+                                      },
+                                    ],
+                                    "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified.
+                                      { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                        "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget.
+                                        "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget.
+                                          "altText": "A String", # The alternative text of this image that's used for accessibility.
+                                          "imageUrl": "A String", # The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```
+                                          "onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
+                                        },
+                                        "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget.
+                                          "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                          "text": "A String", # The text that's shown in the widget.
+                                          "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                        },
+                                      },
+                                    ],
+                                  },
+                                ],
+                              },
+                              "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ```
+                                "chips": [ # An array of chips.
+                                  { # A text, icon, or text and icon chip that users can click. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat".
+                                    "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`.
+                                    "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead.
+                                    "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text.
+                                      "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                      "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                      "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                      "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                      "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                        "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                        "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                        "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                        "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                      },
+                                    },
+                                    "label": "A String", # The text displayed inside the chip.
+                                    "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.
+                                  },
+                                ],
+                                "layout": "A String", # Specified chip list layout.
+                              },
+                              "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ```
+                                "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog.
+                                  { # A column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)
+                                    "horizontalAlignment": "A String", # Specifies whether widgets align to the left, right, or center of a column.
+                                    "horizontalSizeStyle": "A String", # Specifies how a column fills the width of the card.
+                                    "verticalAlignment": "A String", # Specifies whether widgets align to the top, bottom, or center of a column.
+                                    "widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified.
+                                      { # The supported widgets that you can include in a column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)
+                                        "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget.
+                                        "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # ChipList widget.
+                                          "chips": [ # An array of chips.
+                                            { # A text, icon, or text and icon chip that users can click. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                              "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat".
+                                              "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`.
+                                              "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead.
+                                              "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text.
+                                                "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                                "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                                "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                                "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                                "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                                  "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                                  "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                                  "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                                  "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                                },
+                                              },
+                                              "label": "A String", # The text displayed inside the chip.
+                                              "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.
+                                            },
+                                          ],
+                                          "layout": "A String", # Specified chip list layout.
+                                        },
+                                        "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget.
+                                          "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                            "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                              "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                                "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                              },
+                                            },
+                                            "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                              "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                              "type": "A String", # The type of data source.
+                                            },
+                                          },
+                                          "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`.
+                                          "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                          "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface.
+                                            "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                            "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                            "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                            "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                            "parameters": [ # List of action parameters.
+                                              { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                                "key": "A String", # The name of the parameter for the action script.
+                                                "value": "A String", # The value of the parameter.
+                                              },
+                                            ],
+                                            "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                            "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                              "A String",
+                                            ],
+                                          },
+                                          "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.
+                                          "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time.
+                                          "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).
+                                        },
+                                        "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget.
+                                          "bottomLabel": "A String", # The text that appears below `text`. Always wraps.
+                                          "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                            "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                            "text": "A String", # The text that's shown in the widget.
+                                            "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                          },
+                                          "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action.
+                                          "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                            "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                            "text": "A String", # The text that's shown in the widget.
+                                            "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                          },
+                                          "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons.
+                                            "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                            "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                            "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                            "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                            "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                              "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                              "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                              "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                              "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                            },
+                                          },
+                                          "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Deprecated in favor of `startIcon`.
+                                            "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                            "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                            "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                            "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                            "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                              "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                              "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                              "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                              "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                            },
+                                          },
+                                          "onClick": # Object with schema name: GoogleAppsCardV1OnClick # This action is triggered when users click `topLabel` or `bottomLabel`.
+                                          "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text.
+                                            "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                            "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                            "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                            "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                            "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                              "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                              "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                              "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                              "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                            },
+                                          },
+                                          "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                          "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action.
+                                            "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                            "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                            "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The action to perform when the switch state is changed, such as what function to run.
+                                              "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                              "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                              "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                              "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                              "parameters": [ # List of action parameters.
+                                                { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                                  "key": "A String", # The name of the parameter for the action script.
+                                                  "value": "A String", # The value of the parameter.
+                                                },
+                                              ],
+                                              "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                              "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                                "A String",
+                                              ],
+                                            },
+                                            "selected": True or False, # When `true`, the switch is selected.
+                                            "value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                          },
+                                          "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+                                          "topLabel": "A String", # The text that appears above `text`. Always truncates.
+                                          "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                            "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                            "text": "A String", # The text that's shown in the widget.
+                                            "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                          },
+                                          "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`.
+                                        },
+                                        "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget.
+                                          "altText": "A String", # The alternative text of this image that's used for accessibility.
+                                          "imageUrl": "A String", # The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```
+                                          "onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
+                                        },
+                                        "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
+                                          "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+                                            { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+                                              "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
+                                              "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
+                                                "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
+                                                "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
+                                                  "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                                    "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                                      "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                                    },
+                                                  },
+                                                  "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                                    "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                                    "type": "A String", # The type of data source.
+                                                  },
+                                                },
+                                              },
+                                              "remoteDataSource": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The data is from a remote data provider.
+                                                "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                                "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                                "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                                "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                                "parameters": [ # List of action parameters.
+                                                  { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                                    "key": "A String", # The name of the parameter for the action script.
+                                                    "value": "A String", # The value of the parameter.
+                                                  },
+                                                ],
+                                                "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                                "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                                  "A String",
+                                                ],
+                                              },
+                                            },
+                                          ],
+                                          "externalDataSource": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An external data source, such as a relational database.
+                                            "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                            "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                            "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                            "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                            "parameters": [ # List of action parameters.
+                                              { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                                "key": "A String", # The name of the parameter for the action script.
+                                                "value": "A String", # The value of the parameter.
+                                              },
+                                            ],
+                                            "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                            "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                              "A String",
+                                            ],
+                                          },
+                                          "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                          "items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
+                                            { # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                              "bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
+                                              "selected": True or False, # Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.
+                                              "startIconUri": "A String",
+                                              "text": "A String", # The text that identifies or describes the item to users.
+                                              "value": "A String", # The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                            },
+                                          ],
+                                          "label": "A String", # The text that appears above the selection input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be "Urgency" or "Select urgency".
+                                          "multiSelectMaxSelectedItems": 42, # For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.
+                                          "multiSelectMinQueryLength": 42, # For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items. If unset, the multiselect menu uses the following default values: * If the menu uses a static array of `SelectionInput` items, defaults to 0 characters and immediately populates items from the array. * If the menu uses a dynamic data source (`multi_select_data_source`), defaults to 3 characters before querying the data source to return suggested items.
+                                          "name": "A String", # Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                          "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                            "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                            "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                            "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                            "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                            "parameters": [ # List of action parameters.
+                                              { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                                "key": "A String", # The name of the parameter for the action script.
+                                                "value": "A String", # The value of the parameter.
+                                              },
+                                            ],
+                                            "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                            "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                              "A String",
+                                            ],
+                                          },
+                                          "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace.
+                                            "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
+                                            "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
+                                              "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                                "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                                  "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                                },
+                                              },
+                                              "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                                "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                                "type": "A String", # The type of data source.
+                                              },
+                                            },
+                                          },
+                                          "type": "A String", # The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.
+                                        },
+                                        "textInput": { # A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextInput widget.
+                                          "autoCompleteAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Optional. Specify what action to take when the text input field provides suggestions to users who interact with it. If unspecified, the suggestions are set by `initialSuggestions` and are processed by the client. If specified, the app takes the action specified here, such as running a custom function. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                                            "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                            "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                            "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                            "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                            "parameters": [ # List of action parameters.
+                                              { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                                "key": "A String", # The name of the parameter for the action script.
+                                                "value": "A String", # The value of the parameter.
+                                              },
+                                            ],
+                                            "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                            "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                              "A String",
+                                            ],
+                                          },
+                                          "hintText": "A String", # Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible. Required if `label` is unspecified. Otherwise, optional.
+                                          "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                            "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                              "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                                "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                              },
+                                            },
+                                            "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                              "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                              "type": "A String", # The type of data source.
+                                            },
+                                          },
+                                          "initialSuggestions": { # Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show just `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                            "items": [ # A list of suggestions used for autocomplete recommendations in text input fields.
+                                              { # One suggested value that users can enter in a text input field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                                "text": "A String", # The value of a suggested input to a text input field. This is equivalent to what users enter themselves.
+                                              },
+                                            ],
+                                          },
+                                          "label": "A String", # The text that appears above the text input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write `surname` instead of `name`. Required if `hintText` is unspecified. Otherwise, optional.
+                                          "name": "A String", # The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                          "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text. Examples of actions to take include running a custom function or opening a [dialog](https://developers.google.com/workspace/chat/dialogs) in Google Chat.
+                                            "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                            "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                            "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                            "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                            "parameters": [ # List of action parameters.
+                                              { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                                "key": "A String", # The name of the parameter for the action script.
+                                                "value": "A String", # The value of the parameter.
+                                              },
+                                            ],
+                                            "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                            "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                              "A String",
+                                            ],
+                                          },
+                                          "placeholderText": "A String", # Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                          "type": "A String", # How a text input field appears in the user interface. For example, whether the field is single or multi-line.
+                                          "validation": { # Represents the necessary data for validating the widget it's attached to. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                            "characterLimit": 42, # Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                            "inputType": "A String", # Specify the type of the input widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                          },
+                                          "value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                        },
+                                        "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget.
+                                          "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                          "text": "A String", # The text that's shown in the widget.
+                                          "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                        },
+                                      },
+                                    ],
+                                  },
+                                ],
+                              },
+                              "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a widget that lets users input a date, time, or date and time. For example, the following JSON creates a date time picker to schedule an appointment: ``` "dateTimePicker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DATE_AND_TIME", "valueMsEpoch": 796435200000 } ```
+                                "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                  "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                    "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                      "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                    },
+                                  },
+                                  "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                    "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                    "type": "A String", # The type of data source.
+                                  },
+                                },
+                                "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`.
+                                "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface.
+                                  "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                  "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                  "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                  "parameters": [ # List of action parameters.
+                                    { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "key": "A String", # The name of the parameter for the action script.
+                                      "value": "A String", # The value of the parameter.
+                                    },
+                                  ],
+                                  "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                  "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "A String",
+                                  ],
+                                },
+                                "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.
+                                "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time.
+                                "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).
+                              },
+                              "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ```
+                                "bottomLabel": "A String", # The text that appears below `text`. Always wraps.
+                                "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                  "text": "A String", # The text that's shown in the widget.
+                                  "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                },
+                                "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action.
+                                "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                  "text": "A String", # The text that's shown in the widget.
+                                  "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                },
+                                "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons.
+                                  "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                  "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                  "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                  "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                  "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                    "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                    "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                    "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                  },
+                                },
+                                "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Deprecated in favor of `startIcon`.
+                                  "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                  "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                  "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                  "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                  "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                    "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                    "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                    "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                  },
+                                },
+                                "onClick": # Object with schema name: GoogleAppsCardV1OnClick # This action is triggered when users click `topLabel` or `bottomLabel`.
+                                "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text.
+                                  "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                  "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                  "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                  "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                  "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                    "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                    "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                    "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                  },
+                                },
+                                "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action.
+                                  "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                  "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                  "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The action to perform when the switch state is changed, such as what function to run.
+                                    "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                    "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                    "parameters": [ # List of action parameters.
+                                      { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "key": "A String", # The name of the parameter for the action script.
+                                        "value": "A String", # The value of the parameter.
+                                      },
+                                    ],
+                                    "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                    "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "A String",
+                                    ],
+                                  },
+                                  "selected": True or False, # When `true`, the switch is selected.
+                                  "value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                },
+                                "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+                                "topLabel": "A String", # The text that appears above `text`. Always truncates.
+                                "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                  "text": "A String", # The text that's shown in the widget.
+                                  "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                },
+                                "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`.
+                              },
+                              "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ```
+                              },
+                              "eventActions": [ # Specifies the event actions that can be performed on the widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                { # Represents an actionthat can be performed on an ui element. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                  "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                                  "commonWidgetAction": { # Represents an action that is not specific to a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # Common widget action.
+                                    "updateVisibilityAction": { # Represents an action that updates the visibility of a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # The action to update the visibility of a widget.
+                                      "visibility": "A String", # The new visibility.
+                                    },
+                                  },
+                                  "postEventTriggers": [ # The list of triggers that will be triggered after the EventAction is executed.
+                                    { # Represents a trigger. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                      "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                                    },
+                                  ],
+                                },
+                              ],
+                              "grid": { # Displays a grid with a collection of items. Items can only include text or images. For responsive columns, or to include more than text or images, use `Columns`. For an example in Google Chat apps, see [Display a Grid with a collection of items](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items). A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A fine collection of items", "columnCount": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" } } } ``` # Displays a grid with a collection of items. A grid supports any number of columns and items. The number of rows is determined by the upper bounds of the number items divided by the number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A fine collection of items", "columnCount": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" } } } ```
+                                "borderStyle": { # The style options for the border of a card or widget, including the border type and color. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The border style to apply to each grid item.
+                                  "cornerRadius": 42, # The corner radius for the border.
+                                  "strokeColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The colors to use when the type is `BORDER_TYPE_STROKE`. To set the stroke color, specify a value for the `red`, `green`, and `blue` fields. The value must be a float number between 0 and 1 based on the RGB color value, where `0` (0/255) represents the absence of color and `1` (255/255) represents the maximum intensity of the color. For example, the following sets the color to red at its maximum intensity: ``` "color": { "red": 1, "green": 0, "blue": 0, } ``` The `alpha` field is unavailable for stroke color. If specified, this field is ignored.
+                                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+                                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+                                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+                                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+                                  },
+                                  "type": "A String", # The border type.
+                                },
+                                "columnCount": 42, # The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion).
+                                "items": [ # The items to display in the grid.
+                                  { # Represents an item in a grid layout. Items can contain text, an image, or both text and an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "id": "A String", # A user-specified identifier for this grid item. This identifier is returned in the parent grid's `onClick` callback parameters.
+                                    "image": { # Represents an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The image that displays in the grid item.
+                                      "altText": "A String", # The accessibility label for the image.
+                                      "borderStyle": { # The style options for the border of a card or widget, including the border type and color. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The border style to apply to the image.
+                                        "cornerRadius": 42, # The corner radius for the border.
+                                        "strokeColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The colors to use when the type is `BORDER_TYPE_STROKE`. To set the stroke color, specify a value for the `red`, `green`, and `blue` fields. The value must be a float number between 0 and 1 based on the RGB color value, where `0` (0/255) represents the absence of color and `1` (255/255) represents the maximum intensity of the color. For example, the following sets the color to red at its maximum intensity: ``` "color": { "red": 1, "green": 0, "blue": 0, } ``` The `alpha` field is unavailable for stroke color. If specified, this field is ignored.
+                                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+                                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+                                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+                                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+                                        },
+                                        "type": "A String", # The border type.
+                                      },
+                                      "cropStyle": { # Represents the crop style applied to an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 } ``` # The crop style to apply to the image.
+                                        "aspectRatio": 3.14, # The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 } ```
+                                        "type": "A String", # The crop type.
+                                      },
+                                      "imageUri": "A String", # The image URL.
+                                    },
+                                    "layout": "A String", # The layout to use for the grid item.
+                                    "subtitle": "A String", # The grid item's subtitle.
+                                    "title": "A String", # The grid item's title.
+                                  },
+                                ],
+                                "onClick": # Object with schema name: GoogleAppsCardV1OnClick # This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.
+                                "title": "A String", # The text that displays in the grid header.
+                              },
+                              "horizontalAlignment": "A String", # Specifies whether widgets align to the left, right, or center of a column.
+                              "id": "A String", # A unique ID assigned to the widget that's used to identify the widget to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                              "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays an image. For example, the following JSON creates an image with alternative text: ``` "image": { "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "altText": "Chat app avatar" } ```
+                                "altText": "A String", # The alternative text of this image that's used for accessibility.
+                                "imageUrl": "A String", # The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```
+                                "onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
+                              },
+                              "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
+                                "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+                                  { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+                                    "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
+                                    "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
+                                      "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
+                                      "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
+                                        "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                          "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                            "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                          },
+                                        },
+                                        "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                          "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                          "type": "A String", # The type of data source.
+                                        },
+                                      },
+                                    },
+                                    "remoteDataSource": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The data is from a remote data provider.
+                                      "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                      "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                      "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                      "parameters": [ # List of action parameters.
+                                        { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                          "key": "A String", # The name of the parameter for the action script.
+                                          "value": "A String", # The value of the parameter.
+                                        },
+                                      ],
+                                      "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                      "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "A String",
+                                      ],
+                                    },
+                                  },
+                                ],
+                                "externalDataSource": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An external data source, such as a relational database.
+                                  "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                  "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                  "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                  "parameters": [ # List of action parameters.
+                                    { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "key": "A String", # The name of the parameter for the action script.
+                                      "value": "A String", # The value of the parameter.
+                                    },
+                                  ],
+                                  "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                  "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "A String",
+                                  ],
+                                },
+                                "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                "items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
+                                  { # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
+                                    "selected": True or False, # Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.
+                                    "startIconUri": "A String",
+                                    "text": "A String", # The text that identifies or describes the item to users.
+                                    "value": "A String", # The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                  },
+                                ],
+                                "label": "A String", # The text that appears above the selection input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be "Urgency" or "Select urgency".
+                                "multiSelectMaxSelectedItems": 42, # For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.
+                                "multiSelectMinQueryLength": 42, # For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items. If unset, the multiselect menu uses the following default values: * If the menu uses a static array of `SelectionInput` items, defaults to 0 characters and immediately populates items from the array. * If the menu uses a dynamic data source (`multi_select_data_source`), defaults to 3 characters before querying the data source to return suggested items.
+                                "name": "A String", # Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                  "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                  "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                  "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                  "parameters": [ # List of action parameters.
+                                    { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "key": "A String", # The name of the parameter for the action script.
+                                      "value": "A String", # The value of the parameter.
+                                    },
+                                  ],
+                                  "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                  "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "A String",
+                                  ],
+                                },
+                                "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace.
+                                  "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
+                                  "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
+                                    "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                      "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                        "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                      },
+                                    },
+                                    "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                      "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                      "type": "A String", # The type of data source.
+                                    },
+                                  },
+                                },
+                                "type": "A String", # The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.
+                              },
+                              "textInput": { # A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text box that users can type into. For example, the following JSON creates a text input for an email address: ``` "textInput": { "name": "mailing_address", "label": "Mailing Address" } ``` As another example, the following JSON creates a text input for a programming language with static suggestions: ``` "textInput": { "name": "preferred_programing_language", "label": "Preferred Language", "initialSuggestions": { "items": [ { "text": "C++" }, { "text": "Java" }, { "text": "JavaScript" }, { "text": "Python" } ] } } ```
+                                "autoCompleteAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Optional. Specify what action to take when the text input field provides suggestions to users who interact with it. If unspecified, the suggestions are set by `initialSuggestions` and are processed by the client. If specified, the app takes the action specified here, such as running a custom function. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                                  "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                  "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                  "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                  "parameters": [ # List of action parameters.
+                                    { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "key": "A String", # The name of the parameter for the action script.
+                                      "value": "A String", # The value of the parameter.
+                                    },
+                                  ],
+                                  "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                  "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "A String",
+                                  ],
+                                },
+                                "hintText": "A String", # Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible. Required if `label` is unspecified. Otherwise, optional.
+                                "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                  "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                    "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                      "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                    },
+                                  },
+                                  "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                    "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                    "type": "A String", # The type of data source.
+                                  },
+                                },
+                                "initialSuggestions": { # Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show just `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                  "items": [ # A list of suggestions used for autocomplete recommendations in text input fields.
+                                    { # One suggested value that users can enter in a text input field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "text": "A String", # The value of a suggested input to a text input field. This is equivalent to what users enter themselves.
+                                    },
+                                  ],
+                                },
+                                "label": "A String", # The text that appears above the text input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write `surname` instead of `name`. Required if `hintText` is unspecified. Otherwise, optional.
+                                "name": "A String", # The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text. Examples of actions to take include running a custom function or opening a [dialog](https://developers.google.com/workspace/chat/dialogs) in Google Chat.
+                                  "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                  "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                  "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                  "parameters": [ # List of action parameters.
+                                    { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "key": "A String", # The name of the parameter for the action script.
+                                      "value": "A String", # The value of the parameter.
+                                    },
+                                  ],
+                                  "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                  "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "A String",
+                                  ],
+                                },
+                                "placeholderText": "A String", # Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                "type": "A String", # How a text input field appears in the user interface. For example, whether the field is single or multi-line.
+                                "validation": { # Represents the necessary data for validating the widget it's attached to. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                  "characterLimit": 42, # Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                  "inputType": "A String", # Specify the type of the input widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                },
+                                "value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                              },
+                              "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ```
+                                "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                "text": "A String", # The text that's shown in the widget.
+                                "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                              },
+                              "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                            },
+                          ],
+                        },
+                      ],
+                    },
+                    "openDynamicLinkAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An add-on triggers this action when the action needs to open a link. This differs from the `open_link` above in that this needs to talk to server to get the link. Thus some preparation work is required for web client to do before the open link action response comes back. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                      "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                      "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                      "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                      "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                      "parameters": [ # List of action parameters.
+                        { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          "key": "A String", # The name of the parameter for the action script.
+                          "value": "A String", # The value of the parameter.
+                        },
+                      ],
+                      "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                      "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                        "A String",
+                      ],
+                    },
+                    "openLink": { # Represents an `onClick` event that opens a hyperlink. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # If specified, this `onClick` triggers an open link action.
+                      "onClose": "A String", # Whether the client forgets about a link after opening it, or observes it until the window closes. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                      "openAs": "A String", # How to open a link. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                      "url": "A String", # The URL to open. HTTP URLs are converted to HTTPS.
+                    },
+                    "overflowMenu": { # A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # If specified, this `onClick` opens an overflow menu.
+                      "items": [ # Required. The list of menu options.
+                        { # An option that users can invoke in an overflow menu. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          "disabled": True or False, # Whether the menu option is disabled. Defaults to false.
+                          "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled.
+                          "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text.
+                            "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                            "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                            "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                            "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                            "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                              "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                              "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                              "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                              "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                            },
+                          },
+                          "text": "A String", # Required. The text that identifies or describes the item to users.
+                        },
+                      ],
+                    },
+                  },
+                  "text": "A String", # The text displayed inside the button.
+                  "type": "A String", # Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored.
+                },
+              ],
+            },
+          },
+        ],
+        "actionResponse": { # Parameters that a Chat app can use to configure how its response is posted. # Input only. Parameters that a Chat app can use to configure how its response is posted.
+          "dialogAction": { # Contains a [dialog](https://developers.google.com/workspace/chat/dialogs) and request status code. # Input only. A response to an interaction event related to a [dialog](https://developers.google.com/workspace/chat/dialogs). Must be accompanied by `ResponseType.Dialog`.
+            "actionStatus": { # Represents the status for a request to either invoke or submit a [dialog](https://developers.google.com/workspace/chat/dialogs). # Input only. Status for a request to either invoke or submit a [dialog](https://developers.google.com/workspace/chat/dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success.
+              "statusCode": "A String", # The status code.
+              "userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent.
+            },
+            "dialog": { # Wrapper around the card body of the dialog. # Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request.
+              "body": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`.
+                "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ```
+                  { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                    "actionLabel": "A String", # The label that displays as the action menu item.
+                    "onClick": # Object with schema name: GoogleAppsCardV1OnClick # The `onClick` action for this action item.
+                  },
+                ],
+                "displayStyle": "A String", # In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                "expressionData": [ # The expression data for the card. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                  { # Represents the data that is used to evaluate an expression. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                    "conditions": [ # The list of conditions that are determined by the expression evaluation result.
+                      { # Represents a condition that can be used to trigger an action. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                        "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                        "expressionDataCondition": { # Represents a condition that is evaluated using CEL. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # The condition that is determined by the expression data.
+                          "conditionType": "A String", # The type of the condition.
+                        },
+                      },
+                    ],
+                    "eventActions": [ # The list of actions that the ExpressionData can be used.
+                      { # Represents an actionthat can be performed on an ui element. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                        "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                        "commonWidgetAction": { # Represents an action that is not specific to a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # Common widget action.
+                          "updateVisibilityAction": { # Represents an action that updates the visibility of a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # The action to update the visibility of a widget.
+                            "visibility": "A String", # The new visibility.
+                          },
+                        },
+                        "postEventTriggers": [ # The list of triggers that will be triggered after the EventAction is executed.
+                          { # Represents a trigger. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                            "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                          },
+                        ],
+                      },
+                    ],
+                    "expression": "A String", # The uncompiled expression.
+                    "id": "A String", # The unique identifier of the ExpressionData.
+                  },
+                ],
+                "fixedFooter": { # A persistent (sticky) footer that that appears at the bottom of the card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). For an example in Google Chat apps, see [Add a persistent footer](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                  "primaryButton": # Object with schema name: GoogleAppsCardV1Button # The primary button of the fixed footer. The button must be a text button with text and color set.
+                  "secondaryButton": # Object with schema name: GoogleAppsCardV1Button # The secondary button of the fixed footer. The button must be a text button with text and color set. If `secondaryButton` is set, you must also set `primaryButton`.
+                },
+                "header": { # Represents a card header. For an example in Google Chat apps, see [Add a header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
+                  "imageAltText": "A String", # The alternative text of this image that's used for accessibility.
+                  "imageType": "A String", # The shape used to crop the image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                  "imageUrl": "A String", # The HTTPS URL of the image in the card header.
+                  "subtitle": "A String", # The subtitle of the card header. If specified, appears on its own line below the `title`.
+                  "title": "A String", # Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.
+                },
+                "name": "A String", # Name of the card. Used as a card identifier in card navigation. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                "peekCardHeader": { # Represents a card header. For an example in Google Chat apps, see [Add a header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                  "imageAltText": "A String", # The alternative text of this image that's used for accessibility.
+                  "imageType": "A String", # The shape used to crop the image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                  "imageUrl": "A String", # The HTTPS URL of the image in the card header.
+                  "subtitle": "A String", # The subtitle of the card header. If specified, appears on its own line below the `title`.
+                  "title": "A String", # Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.
+                },
+                "sectionDividerStyle": "A String", # The divider style between the header, sections and footer.
+                "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
+                  { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                    "collapseControl": { # Represent an expand and collapse control. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used.
+                      "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.
+                      "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.
+                      "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button.
+                    },
+                    "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`.
+                    "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+                    "id": "A String", # A unique ID assigned to the section that's used to identify the section to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                    "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`.
+                    "widgets": [ # All the widgets in the section. Must contain at least one widget.
+                      { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types.
+                        "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ```
+                        "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ```
+                          "carouselCards": [ # A list of cards included in the carousel.
+                            { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat):
+                              "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified.
+                                { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget.
+                                  "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget.
+                                    "altText": "A String", # The alternative text of this image that's used for accessibility.
+                                    "imageUrl": "A String", # The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```
+                                    "onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
+                                  },
+                                  "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget.
+                                    "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                    "text": "A String", # The text that's shown in the widget.
+                                    "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  },
+                                },
+                              ],
+                              "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified.
+                                { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget.
+                                  "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget.
+                                    "altText": "A String", # The alternative text of this image that's used for accessibility.
+                                    "imageUrl": "A String", # The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```
+                                    "onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
+                                  },
+                                  "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget.
+                                    "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                    "text": "A String", # The text that's shown in the widget.
+                                    "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  },
+                                },
+                              ],
+                            },
+                          ],
+                        },
+                        "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ```
+                          "chips": [ # An array of chips.
+                            { # A text, icon, or text and icon chip that users can click. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat".
+                              "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`.
+                              "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead.
+                              "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text.
+                                "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                  "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                  "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                  "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                },
+                              },
+                              "label": "A String", # The text displayed inside the chip.
+                              "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.
+                            },
+                          ],
+                          "layout": "A String", # Specified chip list layout.
+                        },
+                        "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ```
+                          "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog.
+                            { # A column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)
+                              "horizontalAlignment": "A String", # Specifies whether widgets align to the left, right, or center of a column.
+                              "horizontalSizeStyle": "A String", # Specifies how a column fills the width of the card.
+                              "verticalAlignment": "A String", # Specifies whether widgets align to the top, bottom, or center of a column.
+                              "widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified.
+                                { # The supported widgets that you can include in a column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)
+                                  "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget.
+                                  "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # ChipList widget.
+                                    "chips": [ # An array of chips.
+                                      { # A text, icon, or text and icon chip that users can click. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat".
+                                        "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`.
+                                        "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead.
+                                        "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text.
+                                          "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                          "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                          "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                          "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                          "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                            "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                            "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                            "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                            "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                          },
+                                        },
+                                        "label": "A String", # The text displayed inside the chip.
+                                        "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.
+                                      },
+                                    ],
+                                    "layout": "A String", # Specified chip list layout.
+                                  },
+                                  "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget.
+                                    "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                      "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                        "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                          "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                        },
+                                      },
+                                      "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                        "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                        "type": "A String", # The type of data source.
+                                      },
+                                    },
+                                    "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`.
+                                    "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                    "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface.
+                                      "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                      "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                      "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                      "parameters": [ # List of action parameters.
+                                        { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                          "key": "A String", # The name of the parameter for the action script.
+                                          "value": "A String", # The value of the parameter.
+                                        },
+                                      ],
+                                      "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                      "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "A String",
+                                      ],
+                                    },
+                                    "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.
+                                    "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time.
+                                    "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).
+                                  },
+                                  "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget.
+                                    "bottomLabel": "A String", # The text that appears below `text`. Always wraps.
+                                    "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                      "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                      "text": "A String", # The text that's shown in the widget.
+                                      "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    },
+                                    "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action.
+                                    "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                      "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                      "text": "A String", # The text that's shown in the widget.
+                                      "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    },
+                                    "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons.
+                                      "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                      "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                      "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                      "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                      "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                        "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                        "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                        "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                        "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                      },
+                                    },
+                                    "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Deprecated in favor of `startIcon`.
+                                      "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                      "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                      "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                      "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                      "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                        "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                        "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                        "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                        "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                      },
+                                    },
+                                    "onClick": # Object with schema name: GoogleAppsCardV1OnClick # This action is triggered when users click `topLabel` or `bottomLabel`.
+                                    "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text.
+                                      "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                      "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                      "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                      "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                      "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                        "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                        "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                        "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                        "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                      },
+                                    },
+                                    "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action.
+                                      "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                      "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The action to perform when the switch state is changed, such as what function to run.
+                                        "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                        "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                        "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                        "parameters": [ # List of action parameters.
+                                          { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                            "key": "A String", # The name of the parameter for the action script.
+                                            "value": "A String", # The value of the parameter.
+                                          },
+                                        ],
+                                        "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                        "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                          "A String",
+                                        ],
+                                      },
+                                      "selected": True or False, # When `true`, the switch is selected.
+                                      "value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                    },
+                                    "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+                                    "topLabel": "A String", # The text that appears above `text`. Always truncates.
+                                    "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                      "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                      "text": "A String", # The text that's shown in the widget.
+                                      "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    },
+                                    "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`.
+                                  },
+                                  "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget.
+                                    "altText": "A String", # The alternative text of this image that's used for accessibility.
+                                    "imageUrl": "A String", # The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```
+                                    "onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
+                                  },
+                                  "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
+                                    "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+                                      { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+                                        "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
+                                        "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
+                                          "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
+                                          "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
+                                            "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                              "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                                "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                              },
+                                            },
+                                            "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                              "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                              "type": "A String", # The type of data source.
+                                            },
+                                          },
+                                        },
+                                        "remoteDataSource": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The data is from a remote data provider.
+                                          "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                          "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                          "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                          "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                          "parameters": [ # List of action parameters.
+                                            { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                              "key": "A String", # The name of the parameter for the action script.
+                                              "value": "A String", # The value of the parameter.
+                                            },
+                                          ],
+                                          "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                          "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                            "A String",
+                                          ],
+                                        },
+                                      },
+                                    ],
+                                    "externalDataSource": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An external data source, such as a relational database.
+                                      "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                      "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                      "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                      "parameters": [ # List of action parameters.
+                                        { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                          "key": "A String", # The name of the parameter for the action script.
+                                          "value": "A String", # The value of the parameter.
+                                        },
+                                      ],
+                                      "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                      "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "A String",
+                                      ],
+                                    },
+                                    "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                    "items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
+                                      { # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
+                                        "selected": True or False, # Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.
+                                        "startIconUri": "A String",
+                                        "text": "A String", # The text that identifies or describes the item to users.
+                                        "value": "A String", # The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                      },
+                                    ],
+                                    "label": "A String", # The text that appears above the selection input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be "Urgency" or "Select urgency".
+                                    "multiSelectMaxSelectedItems": 42, # For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.
+                                    "multiSelectMinQueryLength": 42, # For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items. If unset, the multiselect menu uses the following default values: * If the menu uses a static array of `SelectionInput` items, defaults to 0 characters and immediately populates items from the array. * If the menu uses a dynamic data source (`multi_select_data_source`), defaults to 3 characters before querying the data source to return suggested items.
+                                    "name": "A String", # Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                    "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                      "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                      "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                      "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                      "parameters": [ # List of action parameters.
+                                        { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                          "key": "A String", # The name of the parameter for the action script.
+                                          "value": "A String", # The value of the parameter.
+                                        },
+                                      ],
+                                      "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                      "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "A String",
+                                      ],
+                                    },
+                                    "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace.
+                                      "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
+                                      "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
+                                        "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                          "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                            "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                          },
+                                        },
+                                        "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                          "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                          "type": "A String", # The type of data source.
+                                        },
+                                      },
+                                    },
+                                    "type": "A String", # The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.
+                                  },
+                                  "textInput": { # A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextInput widget.
+                                    "autoCompleteAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Optional. Specify what action to take when the text input field provides suggestions to users who interact with it. If unspecified, the suggestions are set by `initialSuggestions` and are processed by the client. If specified, the app takes the action specified here, such as running a custom function. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                                      "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                      "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                      "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                      "parameters": [ # List of action parameters.
+                                        { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                          "key": "A String", # The name of the parameter for the action script.
+                                          "value": "A String", # The value of the parameter.
+                                        },
+                                      ],
+                                      "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                      "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "A String",
+                                      ],
+                                    },
+                                    "hintText": "A String", # Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible. Required if `label` is unspecified. Otherwise, optional.
+                                    "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                      "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                        "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                          "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                        },
+                                      },
+                                      "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                        "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                        "type": "A String", # The type of data source.
+                                      },
+                                    },
+                                    "initialSuggestions": { # Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show just `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "items": [ # A list of suggestions used for autocomplete recommendations in text input fields.
+                                        { # One suggested value that users can enter in a text input field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                          "text": "A String", # The value of a suggested input to a text input field. This is equivalent to what users enter themselves.
+                                        },
+                                      ],
+                                    },
+                                    "label": "A String", # The text that appears above the text input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write `surname` instead of `name`. Required if `hintText` is unspecified. Otherwise, optional.
+                                    "name": "A String", # The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                    "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text. Examples of actions to take include running a custom function or opening a [dialog](https://developers.google.com/workspace/chat/dialogs) in Google Chat.
+                                      "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                      "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                      "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                      "parameters": [ # List of action parameters.
+                                        { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                          "key": "A String", # The name of the parameter for the action script.
+                                          "value": "A String", # The value of the parameter.
+                                        },
+                                      ],
+                                      "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                      "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "A String",
+                                      ],
+                                    },
+                                    "placeholderText": "A String", # Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "type": "A String", # How a text input field appears in the user interface. For example, whether the field is single or multi-line.
+                                    "validation": { # Represents the necessary data for validating the widget it's attached to. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "characterLimit": 42, # Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "inputType": "A String", # Specify the type of the input widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    },
+                                    "value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                  },
+                                  "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget.
+                                    "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                    "text": "A String", # The text that's shown in the widget.
+                                    "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  },
+                                },
+                              ],
+                            },
+                          ],
+                        },
+                        "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a widget that lets users input a date, time, or date and time. For example, the following JSON creates a date time picker to schedule an appointment: ``` "dateTimePicker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DATE_AND_TIME", "valueMsEpoch": 796435200000 } ```
+                          "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                            "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                              "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                              },
+                            },
+                            "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                              "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                              "type": "A String", # The type of data source.
+                            },
+                          },
+                          "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`.
+                          "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                          "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface.
+                            "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                            "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                            "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                            "parameters": [ # List of action parameters.
+                              { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                "key": "A String", # The name of the parameter for the action script.
+                                "value": "A String", # The value of the parameter.
+                              },
+                            ],
+                            "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                            "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "A String",
+                            ],
+                          },
+                          "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.
+                          "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time.
+                          "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).
+                        },
+                        "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ```
+                          "bottomLabel": "A String", # The text that appears below `text`. Always wraps.
+                          "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                            "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                            "text": "A String", # The text that's shown in the widget.
+                            "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                          },
+                          "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action.
+                          "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                            "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                            "text": "A String", # The text that's shown in the widget.
+                            "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                          },
+                          "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons.
+                            "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                            "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                            "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                            "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                            "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                              "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                              "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                              "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                              "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                            },
+                          },
+                          "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Deprecated in favor of `startIcon`.
+                            "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                            "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                            "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                            "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                            "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                              "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                              "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                              "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                              "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                            },
+                          },
+                          "onClick": # Object with schema name: GoogleAppsCardV1OnClick # This action is triggered when users click `topLabel` or `bottomLabel`.
+                          "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text.
+                            "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                            "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                            "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                            "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                            "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                              "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                              "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                              "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                              "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                            },
+                          },
+                          "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat):
+                          "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action.
+                            "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                            "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The action to perform when the switch state is changed, such as what function to run.
+                              "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                              "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                              "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                              "parameters": [ # List of action parameters.
+                                { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                  "key": "A String", # The name of the parameter for the action script.
+                                  "value": "A String", # The value of the parameter.
+                                },
+                              ],
+                              "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                              "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                "A String",
+                              ],
+                            },
+                            "selected": True or False, # When `true`, the switch is selected.
+                            "value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                          },
+                          "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+                          "topLabel": "A String", # The text that appears above `text`. Always truncates.
+                          "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                            "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                            "text": "A String", # The text that's shown in the widget.
+                            "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                          },
+                          "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`.
+                        },
+                        "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ```
+                        },
+                        "eventActions": [ # Specifies the event actions that can be performed on the widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                          { # Represents an actionthat can be performed on an ui element. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                            "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                            "commonWidgetAction": { # Represents an action that is not specific to a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # Common widget action.
+                              "updateVisibilityAction": { # Represents an action that updates the visibility of a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # The action to update the visibility of a widget.
+                                "visibility": "A String", # The new visibility.
+                              },
+                            },
+                            "postEventTriggers": [ # The list of triggers that will be triggered after the EventAction is executed.
+                              { # Represents a trigger. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                              },
+                            ],
+                          },
+                        ],
+                        "grid": { # Displays a grid with a collection of items. Items can only include text or images. For responsive columns, or to include more than text or images, use `Columns`. For an example in Google Chat apps, see [Display a Grid with a collection of items](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items). A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A fine collection of items", "columnCount": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" } } } ``` # Displays a grid with a collection of items. A grid supports any number of columns and items. The number of rows is determined by the upper bounds of the number items divided by the number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A fine collection of items", "columnCount": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" } } } ```
+                          "borderStyle": { # The style options for the border of a card or widget, including the border type and color. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The border style to apply to each grid item.
+                            "cornerRadius": 42, # The corner radius for the border.
+                            "strokeColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The colors to use when the type is `BORDER_TYPE_STROKE`. To set the stroke color, specify a value for the `red`, `green`, and `blue` fields. The value must be a float number between 0 and 1 based on the RGB color value, where `0` (0/255) represents the absence of color and `1` (255/255) represents the maximum intensity of the color. For example, the following sets the color to red at its maximum intensity: ``` "color": { "red": 1, "green": 0, "blue": 0, } ``` The `alpha` field is unavailable for stroke color. If specified, this field is ignored.
+                              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+                              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+                              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+                              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+                            },
+                            "type": "A String", # The border type.
+                          },
+                          "columnCount": 42, # The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion).
+                          "items": [ # The items to display in the grid.
+                            { # Represents an item in a grid layout. Items can contain text, an image, or both text and an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "id": "A String", # A user-specified identifier for this grid item. This identifier is returned in the parent grid's `onClick` callback parameters.
+                              "image": { # Represents an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The image that displays in the grid item.
+                                "altText": "A String", # The accessibility label for the image.
+                                "borderStyle": { # The style options for the border of a card or widget, including the border type and color. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The border style to apply to the image.
+                                  "cornerRadius": 42, # The corner radius for the border.
+                                  "strokeColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The colors to use when the type is `BORDER_TYPE_STROKE`. To set the stroke color, specify a value for the `red`, `green`, and `blue` fields. The value must be a float number between 0 and 1 based on the RGB color value, where `0` (0/255) represents the absence of color and `1` (255/255) represents the maximum intensity of the color. For example, the following sets the color to red at its maximum intensity: ``` "color": { "red": 1, "green": 0, "blue": 0, } ``` The `alpha` field is unavailable for stroke color. If specified, this field is ignored.
+                                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+                                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+                                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+                                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+                                  },
+                                  "type": "A String", # The border type.
+                                },
+                                "cropStyle": { # Represents the crop style applied to an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 } ``` # The crop style to apply to the image.
+                                  "aspectRatio": 3.14, # The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 } ```
+                                  "type": "A String", # The crop type.
+                                },
+                                "imageUri": "A String", # The image URL.
+                              },
+                              "layout": "A String", # The layout to use for the grid item.
+                              "subtitle": "A String", # The grid item's subtitle.
+                              "title": "A String", # The grid item's title.
+                            },
+                          ],
+                          "onClick": # Object with schema name: GoogleAppsCardV1OnClick # This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.
+                          "title": "A String", # The text that displays in the grid header.
+                        },
+                        "horizontalAlignment": "A String", # Specifies whether widgets align to the left, right, or center of a column.
+                        "id": "A String", # A unique ID assigned to the widget that's used to identify the widget to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                        "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays an image. For example, the following JSON creates an image with alternative text: ``` "image": { "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "altText": "Chat app avatar" } ```
+                          "altText": "A String", # The alternative text of this image that's used for accessibility.
+                          "imageUrl": "A String", # The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```
+                          "onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
+                        },
+                        "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
+                          "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+                            { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+                              "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
+                              "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
+                                "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
+                                "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
+                                  "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                    "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                      "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                    },
+                                  },
+                                  "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                    "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                    "type": "A String", # The type of data source.
+                                  },
+                                },
+                              },
+                              "remoteDataSource": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The data is from a remote data provider.
+                                "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                "parameters": [ # List of action parameters.
+                                  { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "key": "A String", # The name of the parameter for the action script.
+                                    "value": "A String", # The value of the parameter.
+                                  },
+                                ],
+                                "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                  "A String",
+                                ],
+                              },
+                            },
+                          ],
+                          "externalDataSource": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An external data source, such as a relational database.
+                            "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                            "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                            "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                            "parameters": [ # List of action parameters.
+                              { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                "key": "A String", # The name of the parameter for the action script.
+                                "value": "A String", # The value of the parameter.
+                              },
+                            ],
+                            "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                            "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "A String",
+                            ],
+                          },
+                          "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                          "items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
+                            { # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
+                              "selected": True or False, # Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.
+                              "startIconUri": "A String",
+                              "text": "A String", # The text that identifies or describes the item to users.
+                              "value": "A String", # The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                            },
+                          ],
+                          "label": "A String", # The text that appears above the selection input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be "Urgency" or "Select urgency".
+                          "multiSelectMaxSelectedItems": 42, # For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.
+                          "multiSelectMinQueryLength": 42, # For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items. If unset, the multiselect menu uses the following default values: * If the menu uses a static array of `SelectionInput` items, defaults to 0 characters and immediately populates items from the array. * If the menu uses a dynamic data source (`multi_select_data_source`), defaults to 3 characters before querying the data source to return suggested items.
+                          "name": "A String", # Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                          "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                            "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                            "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                            "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                            "parameters": [ # List of action parameters.
+                              { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                "key": "A String", # The name of the parameter for the action script.
+                                "value": "A String", # The value of the parameter.
+                              },
+                            ],
+                            "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                            "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "A String",
+                            ],
+                          },
+                          "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace.
+                            "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
+                            "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
+                              "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                  "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                },
+                              },
+                              "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                "type": "A String", # The type of data source.
+                              },
+                            },
+                          },
+                          "type": "A String", # The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.
+                        },
+                        "textInput": { # A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text box that users can type into. For example, the following JSON creates a text input for an email address: ``` "textInput": { "name": "mailing_address", "label": "Mailing Address" } ``` As another example, the following JSON creates a text input for a programming language with static suggestions: ``` "textInput": { "name": "preferred_programing_language", "label": "Preferred Language", "initialSuggestions": { "items": [ { "text": "C++" }, { "text": "Java" }, { "text": "JavaScript" }, { "text": "Python" } ] } } ```
+                          "autoCompleteAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Optional. Specify what action to take when the text input field provides suggestions to users who interact with it. If unspecified, the suggestions are set by `initialSuggestions` and are processed by the client. If specified, the app takes the action specified here, such as running a custom function. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                            "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                            "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                            "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                            "parameters": [ # List of action parameters.
+                              { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                "key": "A String", # The name of the parameter for the action script.
+                                "value": "A String", # The value of the parameter.
+                              },
+                            ],
+                            "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                            "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "A String",
+                            ],
+                          },
+                          "hintText": "A String", # Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible. Required if `label` is unspecified. Otherwise, optional.
+                          "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                            "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                              "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                              },
+                            },
+                            "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                              "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                              "type": "A String", # The type of data source.
+                            },
+                          },
+                          "initialSuggestions": { # Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show just `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "items": [ # A list of suggestions used for autocomplete recommendations in text input fields.
+                              { # One suggested value that users can enter in a text input field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                "text": "A String", # The value of a suggested input to a text input field. This is equivalent to what users enter themselves.
+                              },
+                            ],
+                          },
+                          "label": "A String", # The text that appears above the text input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write `surname` instead of `name`. Required if `hintText` is unspecified. Otherwise, optional.
+                          "name": "A String", # The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                          "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text. Examples of actions to take include running a custom function or opening a [dialog](https://developers.google.com/workspace/chat/dialogs) in Google Chat.
+                            "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                            "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                            "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                            "parameters": [ # List of action parameters.
+                              { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                "key": "A String", # The name of the parameter for the action script.
+                                "value": "A String", # The value of the parameter.
+                              },
+                            ],
+                            "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                            "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "A String",
+                            ],
+                          },
+                          "placeholderText": "A String", # Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                          "type": "A String", # How a text input field appears in the user interface. For example, whether the field is single or multi-line.
+                          "validation": { # Represents the necessary data for validating the widget it's attached to. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "characterLimit": 42, # Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "inputType": "A String", # Specify the type of the input widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          },
+                          "value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                        },
+                        "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ```
+                          "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                          "text": "A String", # The text that's shown in the widget.
+                          "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                        },
+                        "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                      },
+                    ],
+                  },
+                ],
+              },
+            },
+          },
+          "type": "A String", # Input only. The type of Chat app response.
+          "updatedWidget": { # For `selectionInput` widgets, returns autocomplete suggestions for a multiselect menu. # Input only. The response of the updated widget.
+            "suggestions": { # List of widget autocomplete results. # List of widget autocomplete results
+              "items": [ # An array of the SelectionItem objects.
+                { # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                  "bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
+                  "selected": True or False, # Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.
+                  "startIconUri": "A String",
+                  "text": "A String", # The text that identifies or describes the item to users.
+                  "value": "A String", # The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                },
+              ],
+            },
+            "widget": "A String", # The ID of the updated widget. The ID must match the one for the widget that triggered the update request.
+          },
+          "url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
+        },
+        "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0.
+          { # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+            "customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
+              "customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
+                "emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
+                "name": "A String", # Identifier. The resource name of the custom emoji, assigned by the server. Format: `customEmojis/{customEmoji}`
+                "payload": { # Payload data for the custom emoji. # Optional. Input only. Payload data. Required when the custom emoji is created.
+                  "fileContent": "A String", # Required. Input only. The image used for the custom emoji. The payload must be under 256 KB and the dimension of the image must be square and between 64 and 500 pixels. The restrictions are subject to change.
+                  "filename": "A String", # Required. Input only. The image file name. Supported file extensions: `.png`, `.jpg`, `.gif`.
+                },
+                "temporaryImageUri": "A String", # Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.
+                "uid": "A String", # Output only. Unique key for the custom emoji resource.
+              },
+            },
+            "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+            "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0. # The metadata for a rich link.
+              "calendarEventLinkData": { # Data for Calendar event links. # Data for a Calendar event link.
+                "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+                "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+              },
+              "chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
+                "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
+                "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
+                "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}`
+              },
+              "driveLinkData": { # Data for Google Drive links. # Data for a drive link.
+                "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file.
+                  "driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
+                },
+                "mimeType": "A String", # The mime type of the linked Google Drive resource.
+              },
+              "meetSpaceLinkData": { # Data for Meet space links. # Data for a Meet space link.
+                "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+                "meetingCode": "A String", # Meeting code of the linked Meet space.
+                "type": "A String", # Indicates the type of the Meet space.
+              },
+              "richLinkType": "A String", # The rich link type.
+              "uri": "A String", # The URI of this link.
+            },
+            "slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command.
+              "bot": { # A user in Google Chat. When returned as an output from a request, if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output for a `User` resource only populates the user's `name` and `type`. # The Chat app whose command was invoked.
+                "displayName": "A String", # Output only. The user's display name.
+                "domainId": "A String", # Unique identifier of the user's Google Workspace domain.
+                "isAnonymous": True or False, # Output only. When `true`, the user is deleted or their profile is not visible.
+                "name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API.
+                "type": "A String", # User type.
+              },
+              "commandId": "A String", # The command ID of the invoked slash command.
+              "commandName": "A String", # The name of the invoked slash command.
+              "triggersDialog": True or False, # Indicates whether the slash command is for a dialog.
+              "type": "A String", # The type of slash command.
+            },
+            "startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.
+            "type": "A String", # The type of this annotation.
+            "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
+              "type": "A String", # The type of user mention.
+              "user": { # A user in Google Chat. When returned as an output from a request, if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output for a `User` resource only populates the user's `name` and `type`. # The user mentioned.
+                "displayName": "A String", # Output only. The user's display name.
+                "domainId": "A String", # Unique identifier of the user's Google Workspace domain.
+                "isAnonymous": True or False, # Output only. When `true`, the user is deleted or their profile is not visible.
+                "name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API.
+                "type": "A String", # User type.
+              },
+            },
+          },
+        ],
+        "argumentText": "A String", # Output only. Plain-text body of the message with all Chat app mentions stripped out.
+        "attachedGifs": [ # Output only. GIF images that are attached to the message.
+          { # A GIF image that's specified by a URL.
+            "uri": "A String", # Output only. The URL that hosts the GIF image.
+          },
+        ],
+        "attachment": [ # Optional. User-uploaded attachment.
+          { # An attachment in Google Chat.
+            "attachmentDataRef": { # A reference to the attachment data. # Optional. A reference to the attachment data. This field is used to create or update messages with attachments, or with the media API to download the attachment data.
+              "attachmentUploadToken": "A String", # Optional. Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments.
+              "resourceName": "A String", # Optional. The resource name of the attachment data. This field is used with the media API to download the attachment data.
+            },
+            "contentName": "A String", # Output only. The original file name for the content, not the full path.
+            "contentType": "A String", # Output only. The content type (MIME type) of the file.
+            "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps shouldn't use this URL to download attachment content.
+            "driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
+              "driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
+            },
+            "name": "A String", # Identifier. Resource name of the attachment. Format: `spaces/{space}/messages/{message}/attachments/{attachment}`.
+            "source": "A String", # Output only. The source of the attachment.
+            "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
+          },
+        ],
+        "cards": [ # Deprecated: Use `cards_v2` instead. Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. `cards` and `cards_v2` can have a maximum size of 32 KB.
+          { # A card is a UI element that can contain UI widgets such as text and images.
+            "cardActions": [ # The actions of this card.
+              { # A card action is the action associated with the card. For an invoice card, a typical action would be: delete invoice, email invoice or open the invoice in browser. Not supported by Google Chat apps.
+                "actionLabel": "A String", # The label used to be displayed in the action menu item.
+                "onClick": { # An `onclick` action (for example, open a link). # The onclick action for this action item.
+                  "action": { # A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form. # A form action is triggered by this `onclick` action if specified.
+                    "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.
+                    "parameters": [ # List of action parameters.
+                      { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters.
+                        "key": "A String", # The name of the parameter for the action script.
+                        "value": "A String", # The value of the parameter.
+                      },
+                    ],
+                  },
+                  "openLink": { # A link that opens a new window. # This `onclick` action triggers an open link action if specified.
+                    "url": "A String", # The URL to open.
+                  },
+                },
+              },
+            ],
+            "header": { # The header of the card. A header usually contains a title and an image.
+              "imageStyle": "A String", # The image's type (for example, square border or circular border).
+              "imageUrl": "A String", # The URL of the image in the card header.
+              "subtitle": "A String", # The subtitle of the card header.
+              "title": "A String", # The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each takes up one line. If only the title is specified, it takes up both lines.
+            },
+            "name": "A String", # Name of the card.
+            "sections": [ # Sections are separated by a line divider.
+              { # A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there's currently no need for layout properties (for example, float).
+                "header": "A String", # The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+                "widgets": [ # A section must contain at least one widget.
+                  { # A widget is a UI element that presents text and images.
+                    "buttons": [ # A list of buttons. Buttons is also `oneof data` and only one of these fields should be set.
+                      { # A button. Can be a text button or an image button.
+                        "imageButton": { # An image button with an `onclick` action. # A button with image and `onclick` action.
+                          "icon": "A String", # The icon specified by an `enum` that indices to an icon provided by Chat API.
+                          "iconUrl": "A String", # The icon specified by a URL.
+                          "name": "A String", # The name of this `image_button` that's used for accessibility. Default value is provided if this name isn't specified.
+                          "onClick": { # An `onclick` action (for example, open a link). # The `onclick` action.
+                            "action": { # A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form. # A form action is triggered by this `onclick` action if specified.
+                              "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.
+                              "parameters": [ # List of action parameters.
+                                { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters.
+                                  "key": "A String", # The name of the parameter for the action script.
+                                  "value": "A String", # The value of the parameter.
+                                },
+                              ],
+                            },
+                            "openLink": { # A link that opens a new window. # This `onclick` action triggers an open link action if specified.
+                              "url": "A String", # The URL to open.
+                            },
+                          },
+                        },
+                        "textButton": { # A button with text and `onclick` action. # A button with text and `onclick` action.
+                          "onClick": { # An `onclick` action (for example, open a link). # The `onclick` action of the button.
+                            "action": { # A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form. # A form action is triggered by this `onclick` action if specified.
+                              "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.
+                              "parameters": [ # List of action parameters.
+                                { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters.
+                                  "key": "A String", # The name of the parameter for the action script.
+                                  "value": "A String", # The value of the parameter.
+                                },
+                              ],
+                            },
+                            "openLink": { # A link that opens a new window. # This `onclick` action triggers an open link action if specified.
+                              "url": "A String", # The URL to open.
+                            },
+                          },
+                          "text": "A String", # The text of the button.
+                        },
+                      },
+                    ],
+                    "image": { # An image that's specified by a URL and can have an `onclick` action. # Display an image in this widget.
+                      "aspectRatio": 3.14, # The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image.
+                      "imageUrl": "A String", # The URL of the image.
+                      "onClick": { # An `onclick` action (for example, open a link). # The `onclick` action.
+                        "action": { # A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form. # A form action is triggered by this `onclick` action if specified.
+                          "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.
+                          "parameters": [ # List of action parameters.
+                            { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters.
+                              "key": "A String", # The name of the parameter for the action script.
+                              "value": "A String", # The value of the parameter.
+                            },
+                          ],
+                        },
+                        "openLink": { # A link that opens a new window. # This `onclick` action triggers an open link action if specified.
+                          "url": "A String", # The URL to open.
+                        },
+                      },
+                    },
+                    "keyValue": { # A UI element contains a key (label) and a value (content). This element can also contain some actions such as `onclick` button. # Display a key value item in this widget.
+                      "bottomLabel": "A String", # The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+                      "button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.
+                        "imageButton": { # An image button with an `onclick` action. # A button with image and `onclick` action.
+                          "icon": "A String", # The icon specified by an `enum` that indices to an icon provided by Chat API.
+                          "iconUrl": "A String", # The icon specified by a URL.
+                          "name": "A String", # The name of this `image_button` that's used for accessibility. Default value is provided if this name isn't specified.
+                          "onClick": { # An `onclick` action (for example, open a link). # The `onclick` action.
+                            "action": { # A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form. # A form action is triggered by this `onclick` action if specified.
+                              "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.
+                              "parameters": [ # List of action parameters.
+                                { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters.
+                                  "key": "A String", # The name of the parameter for the action script.
+                                  "value": "A String", # The value of the parameter.
+                                },
+                              ],
+                            },
+                            "openLink": { # A link that opens a new window. # This `onclick` action triggers an open link action if specified.
+                              "url": "A String", # The URL to open.
+                            },
+                          },
+                        },
+                        "textButton": { # A button with text and `onclick` action. # A button with text and `onclick` action.
+                          "onClick": { # An `onclick` action (for example, open a link). # The `onclick` action of the button.
+                            "action": { # A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form. # A form action is triggered by this `onclick` action if specified.
+                              "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.
+                              "parameters": [ # List of action parameters.
+                                { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters.
+                                  "key": "A String", # The name of the parameter for the action script.
+                                  "value": "A String", # The value of the parameter.
+                                },
+                              ],
+                            },
+                            "openLink": { # A link that opens a new window. # This `onclick` action triggers an open link action if specified.
+                              "url": "A String", # The URL to open.
+                            },
+                          },
+                          "text": "A String", # The text of the button.
+                        },
+                      },
+                      "content": "A String", # The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+                      "contentMultiline": True or False, # If the content should be multiline.
+                      "icon": "A String", # An enum value that's replaced by the Chat API with the corresponding icon image.
+                      "iconUrl": "A String", # The icon specified by a URL.
+                      "onClick": { # An `onclick` action (for example, open a link). # The `onclick` action. Only the top label, bottom label, and content region are clickable.
+                        "action": { # A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form. # A form action is triggered by this `onclick` action if specified.
+                          "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.
+                          "parameters": [ # List of action parameters.
+                            { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters.
+                              "key": "A String", # The name of the parameter for the action script.
+                              "value": "A String", # The value of the parameter.
+                            },
+                          ],
+                        },
+                        "openLink": { # A link that opens a new window. # This `onclick` action triggers an open link action if specified.
+                          "url": "A String", # The URL to open.
+                        },
+                      },
+                      "topLabel": "A String", # The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+                    },
+                    "textParagraph": { # A paragraph of text. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). # Display a text paragraph in this widget.
+                      "text": "A String",
+                    },
+                  },
+                ],
+              },
+            ],
+          },
+        ],
+        "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder)
+          { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder)
+            "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB.
+              "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ```
+                { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                  "actionLabel": "A String", # The label that displays as the action menu item.
+                  "onClick": # Object with schema name: GoogleAppsCardV1OnClick # The `onClick` action for this action item.
+                },
+              ],
+              "displayStyle": "A String", # In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+              "expressionData": [ # The expression data for the card. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                { # Represents the data that is used to evaluate an expression. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                  "conditions": [ # The list of conditions that are determined by the expression evaluation result.
+                    { # Represents a condition that can be used to trigger an action. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                      "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                      "expressionDataCondition": { # Represents a condition that is evaluated using CEL. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # The condition that is determined by the expression data.
+                        "conditionType": "A String", # The type of the condition.
+                      },
+                    },
+                  ],
+                  "eventActions": [ # The list of actions that the ExpressionData can be used.
+                    { # Represents an actionthat can be performed on an ui element. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                      "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                      "commonWidgetAction": { # Represents an action that is not specific to a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # Common widget action.
+                        "updateVisibilityAction": { # Represents an action that updates the visibility of a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # The action to update the visibility of a widget.
+                          "visibility": "A String", # The new visibility.
+                        },
+                      },
+                      "postEventTriggers": [ # The list of triggers that will be triggered after the EventAction is executed.
+                        { # Represents a trigger. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                          "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                        },
+                      ],
+                    },
+                  ],
+                  "expression": "A String", # The uncompiled expression.
+                  "id": "A String", # The unique identifier of the ExpressionData.
+                },
+              ],
+              "fixedFooter": { # A persistent (sticky) footer that that appears at the bottom of the card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). For an example in Google Chat apps, see [Add a persistent footer](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                "primaryButton": # Object with schema name: GoogleAppsCardV1Button # The primary button of the fixed footer. The button must be a text button with text and color set.
+                "secondaryButton": # Object with schema name: GoogleAppsCardV1Button # The secondary button of the fixed footer. The button must be a text button with text and color set. If `secondaryButton` is set, you must also set `primaryButton`.
+              },
+              "header": { # Represents a card header. For an example in Google Chat apps, see [Add a header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
+                "imageAltText": "A String", # The alternative text of this image that's used for accessibility.
+                "imageType": "A String", # The shape used to crop the image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                "imageUrl": "A String", # The HTTPS URL of the image in the card header.
+                "subtitle": "A String", # The subtitle of the card header. If specified, appears on its own line below the `title`.
+                "title": "A String", # Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.
+              },
+              "name": "A String", # Name of the card. Used as a card identifier in card navigation. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+              "peekCardHeader": { # Represents a card header. For an example in Google Chat apps, see [Add a header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                "imageAltText": "A String", # The alternative text of this image that's used for accessibility.
+                "imageType": "A String", # The shape used to crop the image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                "imageUrl": "A String", # The HTTPS URL of the image in the card header.
+                "subtitle": "A String", # The subtitle of the card header. If specified, appears on its own line below the `title`.
+                "title": "A String", # Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.
+              },
+              "sectionDividerStyle": "A String", # The divider style between the header, sections and footer.
+              "sections": [ # Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
+                { # A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                  "collapseControl": { # Represent an expand and collapse control. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used.
+                    "collapseButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.
+                    "expandButton": # Object with schema name: GoogleAppsCardV1Button # Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.
+                    "horizontalAlignment": "A String", # The horizontal alignment of the expand and collapse button.
+                  },
+                  "collapsible": True or False, # Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`.
+                  "header": "A String", # Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+                  "id": "A String", # A unique ID assigned to the section that's used to identify the section to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                  "uncollapsibleWidgetsCount": 42, # The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`.
+                  "widgets": [ # All the widgets in the section. Must contain at least one widget.
+                    { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types.
+                      "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ```
+                      "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ```
+                        "carouselCards": [ # A list of cards included in the carousel.
+                          { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat):
+                            "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified.
+                              { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget.
+                                "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget.
+                                  "altText": "A String", # The alternative text of this image that's used for accessibility.
+                                  "imageUrl": "A String", # The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```
+                                  "onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
+                                },
+                                "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget.
+                                  "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                  "text": "A String", # The text that's shown in the widget.
+                                  "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                },
+                              },
+                            ],
+                            "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified.
+                              { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget.
+                                "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget.
+                                  "altText": "A String", # The alternative text of this image that's used for accessibility.
+                                  "imageUrl": "A String", # The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```
+                                  "onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
+                                },
+                                "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget.
+                                  "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                  "text": "A String", # The text that's shown in the widget.
+                                  "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                },
+                              },
+                            ],
+                          },
+                        ],
+                      },
+                      "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ```
+                        "chips": [ # An array of chips.
+                          { # A text, icon, or text and icon chip that users can click. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat".
+                            "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`.
+                            "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead.
+                            "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text.
+                              "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                              "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                              "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                              "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                              "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                              },
+                            },
+                            "label": "A String", # The text displayed inside the chip.
+                            "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.
+                          },
+                        ],
+                        "layout": "A String", # Specified chip list layout.
+                      },
+                      "columns": { # The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. # Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ```
+                        "columnItems": [ # An array of columns. You can include up to 2 columns in a card or dialog.
+                          { # A column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)
+                            "horizontalAlignment": "A String", # Specifies whether widgets align to the left, right, or center of a column.
+                            "horizontalSizeStyle": "A String", # Specifies how a column fills the width of the card.
+                            "verticalAlignment": "A String", # Specifies whether widgets align to the top, bottom, or center of a column.
+                            "widgets": [ # An array of widgets included in a column. Widgets appear in the order that they are specified.
+                              { # The supported widgets that you can include in a column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)
+                                "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # ButtonList widget.
+                                "chipList": { # A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # ChipList widget.
+                                  "chips": [ # An array of chips.
+                                    { # A text, icon, or text and icon chip that users can click. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "altText": "A String", # The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat".
+                                      "disabled": True or False, # Whether the chip is in an inactive state and ignores user actions. Defaults to `false`.
+                                      "enabled": True or False, # Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead.
+                                      "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon image. If both `icon` and `text` are set, then the icon appears before the text.
+                                        "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                        "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                        "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                        "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                        "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                          "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                          "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                          "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                          "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                        },
+                                      },
+                                      "label": "A String", # The text displayed inside the chip.
+                                      "onClick": # Object with schema name: GoogleAppsCardV1OnClick # Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.
+                                    },
+                                  ],
+                                  "layout": "A String", # Specified chip list layout.
+                                },
+                                "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DateTimePicker widget.
+                                  "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                    "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                      "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                        "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                      },
+                                    },
+                                    "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                      "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                      "type": "A String", # The type of data source.
+                                    },
+                                  },
+                                  "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`.
+                                  "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                  "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface.
+                                    "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                    "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                    "parameters": [ # List of action parameters.
+                                      { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "key": "A String", # The name of the parameter for the action script.
+                                        "value": "A String", # The value of the parameter.
+                                      },
+                                    ],
+                                    "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                    "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "A String",
+                                    ],
+                                  },
+                                  "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.
+                                  "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time.
+                                  "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).
+                                },
+                                "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget.
+                                  "bottomLabel": "A String", # The text that appears below `text`. Always wraps.
+                                  "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                    "text": "A String", # The text that's shown in the widget.
+                                    "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  },
+                                  "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action.
+                                  "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                    "text": "A String", # The text that's shown in the widget.
+                                    "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  },
+                                  "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons.
+                                    "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                    "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                    "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                    "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                    "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                      "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                      "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                      "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                      "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                    },
+                                  },
+                                  "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Deprecated in favor of `startIcon`.
+                                    "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                    "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                    "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                    "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                    "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                      "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                      "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                      "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                      "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                    },
+                                  },
+                                  "onClick": # Object with schema name: GoogleAppsCardV1OnClick # This action is triggered when users click `topLabel` or `bottomLabel`.
+                                  "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text.
+                                    "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                                    "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                                    "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                                    "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                                    "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                                      "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                      "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                      "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                                      "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                                    },
+                                  },
+                                  "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action.
+                                    "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                    "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The action to perform when the switch state is changed, such as what function to run.
+                                      "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                      "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                      "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                      "parameters": [ # List of action parameters.
+                                        { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                          "key": "A String", # The name of the parameter for the action script.
+                                          "value": "A String", # The value of the parameter.
+                                        },
+                                      ],
+                                      "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                      "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "A String",
+                                      ],
+                                    },
+                                    "selected": True or False, # When `true`, the switch is selected.
+                                    "value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                  },
+                                  "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+                                  "topLabel": "A String", # The text that appears above `text`. Always truncates.
+                                  "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                    "text": "A String", # The text that's shown in the widget.
+                                    "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  },
+                                  "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`.
+                                },
+                                "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget.
+                                  "altText": "A String", # The alternative text of this image that's used for accessibility.
+                                  "imageUrl": "A String", # The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```
+                                  "onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
+                                },
+                                "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
+                                  "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+                                    { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+                                      "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
+                                      "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
+                                        "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
+                                        "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
+                                          "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                            "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                              "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                            },
+                                          },
+                                          "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                            "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                            "type": "A String", # The type of data source.
+                                          },
+                                        },
+                                      },
+                                      "remoteDataSource": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The data is from a remote data provider.
+                                        "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                        "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                        "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                        "parameters": [ # List of action parameters.
+                                          { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                            "key": "A String", # The name of the parameter for the action script.
+                                            "value": "A String", # The value of the parameter.
+                                          },
+                                        ],
+                                        "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                        "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                          "A String",
+                                        ],
+                                      },
+                                    },
+                                  ],
+                                  "externalDataSource": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An external data source, such as a relational database.
+                                    "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                    "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                    "parameters": [ # List of action parameters.
+                                      { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "key": "A String", # The name of the parameter for the action script.
+                                        "value": "A String", # The value of the parameter.
+                                      },
+                                    ],
+                                    "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                    "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "A String",
+                                    ],
+                                  },
+                                  "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                  "items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
+                                    { # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
+                                      "selected": True or False, # Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.
+                                      "startIconUri": "A String",
+                                      "text": "A String", # The text that identifies or describes the item to users.
+                                      "value": "A String", # The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                    },
+                                  ],
+                                  "label": "A String", # The text that appears above the selection input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be "Urgency" or "Select urgency".
+                                  "multiSelectMaxSelectedItems": 42, # For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.
+                                  "multiSelectMinQueryLength": 42, # For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items. If unset, the multiselect menu uses the following default values: * If the menu uses a static array of `SelectionInput` items, defaults to 0 characters and immediately populates items from the array. * If the menu uses a dynamic data source (`multi_select_data_source`), defaults to 3 characters before querying the data source to return suggested items.
+                                  "name": "A String", # Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                  "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                    "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                    "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                    "parameters": [ # List of action parameters.
+                                      { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "key": "A String", # The name of the parameter for the action script.
+                                        "value": "A String", # The value of the parameter.
+                                      },
+                                    ],
+                                    "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                    "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "A String",
+                                    ],
+                                  },
+                                  "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace.
+                                    "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
+                                    "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
+                                      "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                        "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                          "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                        },
+                                      },
+                                      "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                        "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                        "type": "A String", # The type of data source.
+                                      },
+                                    },
+                                  },
+                                  "type": "A String", # The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.
+                                },
+                                "textInput": { # A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextInput widget.
+                                  "autoCompleteAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Optional. Specify what action to take when the text input field provides suggestions to users who interact with it. If unspecified, the suggestions are set by `initialSuggestions` and are processed by the client. If specified, the app takes the action specified here, such as running a custom function. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                                    "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                    "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                    "parameters": [ # List of action parameters.
+                                      { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "key": "A String", # The name of the parameter for the action script.
+                                        "value": "A String", # The value of the parameter.
+                                      },
+                                    ],
+                                    "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                    "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "A String",
+                                    ],
+                                  },
+                                  "hintText": "A String", # Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible. Required if `label` is unspecified. Otherwise, optional.
+                                  "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                                    "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                      "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                        "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                      },
+                                    },
+                                    "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                      "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                      "type": "A String", # The type of data source.
+                                    },
+                                  },
+                                  "initialSuggestions": { # Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show just `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "items": [ # A list of suggestions used for autocomplete recommendations in text input fields.
+                                      { # One suggested value that users can enter in a text input field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "text": "A String", # The value of a suggested input to a text input field. This is equivalent to what users enter themselves.
+                                      },
+                                    ],
+                                  },
+                                  "label": "A String", # The text that appears above the text input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write `surname` instead of `name`. Required if `hintText` is unspecified. Otherwise, optional.
+                                  "name": "A String", # The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                  "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text. Examples of actions to take include running a custom function or opening a [dialog](https://developers.google.com/workspace/chat/dialogs) in Google Chat.
+                                    "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                                    "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                    "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                                    "parameters": [ # List of action parameters.
+                                      { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                        "key": "A String", # The name of the parameter for the action script.
+                                        "value": "A String", # The value of the parameter.
+                                      },
+                                    ],
+                                    "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                                    "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                      "A String",
+                                    ],
+                                  },
+                                  "placeholderText": "A String", # Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                  "type": "A String", # How a text input field appears in the user interface. For example, whether the field is single or multi-line.
+                                  "validation": { # Represents the necessary data for validating the widget it's attached to. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "characterLimit": 42, # Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                    "inputType": "A String", # Specify the type of the input widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                  },
+                                  "value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                                },
+                                "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget.
+                                  "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                                  "text": "A String", # The text that's shown in the widget.
+                                  "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                                },
+                              },
+                            ],
+                          },
+                        ],
+                      },
+                      "dateTimePicker": { # Lets users input a date, a time, or both a date and a time. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a widget that lets users input a date, time, or date and time. For example, the following JSON creates a date time picker to schedule an appointment: ``` "dateTimePicker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DATE_AND_TIME", "valueMsEpoch": 796435200000 } ```
+                        "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                          "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                            "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                              "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                            },
+                          },
+                          "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                            "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                            "type": "A String", # The type of data source.
+                          },
+                        },
+                        "label": "A String", # The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`.
+                        "name": "A String", # The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                        "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface.
+                          "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                          "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                          "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                          "parameters": [ # List of action parameters.
+                            { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "key": "A String", # The name of the parameter for the action script.
+                              "value": "A String", # The value of the parameter.
+                            },
+                          ],
+                          "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                          "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "A String",
+                          ],
+                        },
+                        "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.
+                        "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time.
+                        "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).
+                      },
+                      "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ```
+                        "bottomLabel": "A String", # The text that appears below `text`. Always wraps.
+                        "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                          "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                          "text": "A String", # The text that's shown in the widget.
+                          "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                        },
+                        "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action.
+                        "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                          "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                          "text": "A String", # The text that's shown in the widget.
+                          "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                        },
+                        "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons.
+                          "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                          "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                          "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                          "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                          "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                            "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                            "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                            "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                            "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                          },
+                        },
+                        "icon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Deprecated in favor of `startIcon`.
+                          "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                          "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                          "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                          "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                          "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                            "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                            "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                            "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                            "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                          },
+                        },
+                        "onClick": # Object with schema name: GoogleAppsCardV1OnClick # This action is triggered when users click `topLabel` or `bottomLabel`.
+                        "startIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The icon displayed in front of the text.
+                          "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
+                          "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
+                          "imageType": "A String", # The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
+                          "knownIcon": "A String", # Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
+                          "materialIcon": { # A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { "name": "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
+                            "fill": True or False, # Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                            "grade": 42, # Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                            "name": "A String", # The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.
+                            "weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.
+                          },
+                        },
+                        "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat):
+                        "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action.
+                          "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                          "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The action to perform when the switch state is changed, such as what function to run.
+                            "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                            "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                            "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                            "parameters": [ # List of action parameters.
+                              { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                "key": "A String", # The name of the parameter for the action script.
+                                "value": "A String", # The value of the parameter.
+                              },
+                            ],
+                            "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                            "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "A String",
+                            ],
+                          },
+                          "selected": True or False, # When `true`, the switch is selected.
+                          "value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                        },
+                        "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+                        "topLabel": "A String", # The text that appears above `text`. Always truncates.
+                        "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                          "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                          "text": "A String", # The text that's shown in the widget.
+                          "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                        },
+                        "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`.
+                      },
+                      "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ```
+                      },
+                      "eventActions": [ # Specifies the event actions that can be performed on the widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                        { # Represents an actionthat can be performed on an ui element. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                          "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                          "commonWidgetAction": { # Represents an action that is not specific to a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # Common widget action.
+                            "updateVisibilityAction": { # Represents an action that updates the visibility of a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. # The action to update the visibility of a widget.
+                              "visibility": "A String", # The new visibility.
+                            },
+                          },
+                          "postEventTriggers": [ # The list of triggers that will be triggered after the EventAction is executed.
+                            { # Represents a trigger. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                              "actionRuleId": "A String", # The unique identifier of the ActionRule.
+                            },
+                          ],
+                        },
+                      ],
+                      "grid": { # Displays a grid with a collection of items. Items can only include text or images. For responsive columns, or to include more than text or images, use `Columns`. For an example in Google Chat apps, see [Display a Grid with a collection of items](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items). A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A fine collection of items", "columnCount": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" } } } ``` # Displays a grid with a collection of items. A grid supports any number of columns and items. The number of rows is determined by the upper bounds of the number items divided by the number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A fine collection of items", "columnCount": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" } } } ```
+                        "borderStyle": { # The style options for the border of a card or widget, including the border type and color. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The border style to apply to each grid item.
+                          "cornerRadius": 42, # The corner radius for the border.
+                          "strokeColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The colors to use when the type is `BORDER_TYPE_STROKE`. To set the stroke color, specify a value for the `red`, `green`, and `blue` fields. The value must be a float number between 0 and 1 based on the RGB color value, where `0` (0/255) represents the absence of color and `1` (255/255) represents the maximum intensity of the color. For example, the following sets the color to red at its maximum intensity: ``` "color": { "red": 1, "green": 0, "blue": 0, } ``` The `alpha` field is unavailable for stroke color. If specified, this field is ignored.
+                            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+                            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+                            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+                            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+                          },
+                          "type": "A String", # The border type.
+                        },
+                        "columnCount": 42, # The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion).
+                        "items": [ # The items to display in the grid.
+                          { # Represents an item in a grid layout. Items can contain text, an image, or both text and an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "id": "A String", # A user-specified identifier for this grid item. This identifier is returned in the parent grid's `onClick` callback parameters.
+                            "image": { # Represents an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The image that displays in the grid item.
+                              "altText": "A String", # The accessibility label for the image.
+                              "borderStyle": { # The style options for the border of a card or widget, including the border type and color. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The border style to apply to the image.
+                                "cornerRadius": 42, # The corner radius for the border.
+                                "strokeColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The colors to use when the type is `BORDER_TYPE_STROKE`. To set the stroke color, specify a value for the `red`, `green`, and `blue` fields. The value must be a float number between 0 and 1 based on the RGB color value, where `0` (0/255) represents the absence of color and `1` (255/255) represents the maximum intensity of the color. For example, the following sets the color to red at its maximum intensity: ``` "color": { "red": 1, "green": 0, "blue": 0, } ``` The `alpha` field is unavailable for stroke color. If specified, this field is ignored.
+                                  "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+                                  "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+                                  "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+                                  "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+                                },
+                                "type": "A String", # The border type.
+                              },
+                              "cropStyle": { # Represents the crop style applied to an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 } ``` # The crop style to apply to the image.
+                                "aspectRatio": 3.14, # The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 } ```
+                                "type": "A String", # The crop type.
+                              },
+                              "imageUri": "A String", # The image URL.
+                            },
+                            "layout": "A String", # The layout to use for the grid item.
+                            "subtitle": "A String", # The grid item's subtitle.
+                            "title": "A String", # The grid item's title.
+                          },
+                        ],
+                        "onClick": # Object with schema name: GoogleAppsCardV1OnClick # This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.
+                        "title": "A String", # The text that displays in the grid header.
+                      },
+                      "horizontalAlignment": "A String", # Specifies whether widgets align to the left, right, or center of a column.
+                      "id": "A String", # A unique ID assigned to the widget that's used to identify the widget to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                      "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays an image. For example, the following JSON creates an image with alternative text: ``` "image": { "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "altText": "Chat app avatar" } ```
+                        "altText": "A String", # The alternative text of this image that's used for accessibility.
+                        "imageUrl": "A String", # The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```
+                        "onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
+                      },
+                      "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
+                        "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+                          { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+                            "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
+                            "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
+                              "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
+                              "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
+                                "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                                  "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                    "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                                  },
+                                },
+                                "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                                  "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                                  "type": "A String", # The type of data source.
+                                },
+                              },
+                            },
+                            "remoteDataSource": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # The data is from a remote data provider.
+                              "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                              "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                              "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                              "parameters": [ # List of action parameters.
+                                { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                  "key": "A String", # The name of the parameter for the action script.
+                                  "value": "A String", # The value of the parameter.
+                                },
+                              ],
+                              "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                              "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                                "A String",
+                              ],
+                            },
+                          },
+                        ],
+                        "externalDataSource": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An external data source, such as a relational database.
+                          "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                          "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                          "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                          "parameters": [ # List of action parameters.
+                            { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "key": "A String", # The name of the parameter for the action script.
+                              "value": "A String", # The value of the parameter.
+                            },
+                          ],
+                          "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                          "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "A String",
+                          ],
+                        },
+                        "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                        "items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
+                          { # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
+                            "selected": True or False, # Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.
+                            "startIconUri": "A String",
+                            "text": "A String", # The text that identifies or describes the item to users.
+                            "value": "A String", # The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                          },
+                        ],
+                        "label": "A String", # The text that appears above the selection input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be "Urgency" or "Select urgency".
+                        "multiSelectMaxSelectedItems": 42, # For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.
+                        "multiSelectMinQueryLength": 42, # For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items. If unset, the multiselect menu uses the following default values: * If the menu uses a static array of `SelectionInput` items, defaults to 0 characters and immediately populates items from the array. * If the menu uses a dynamic data source (`multi_select_data_source`), defaults to 3 characters before querying the data source to return suggested items.
+                        "name": "A String", # Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                        "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                          "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                          "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                          "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                          "parameters": [ # List of action parameters.
+                            { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "key": "A String", # The name of the parameter for the action script.
+                              "value": "A String", # The value of the parameter.
+                            },
+                          ],
+                          "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                          "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "A String",
+                          ],
+                        },
+                        "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Workspace.
+                          "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
+                          "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
+                            "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                              "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                                "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                              },
+                            },
+                            "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                              "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                              "type": "A String", # The type of data source.
+                            },
+                          },
+                        },
+                        "type": "A String", # The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.
+                      },
+                      "textInput": { # A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text box that users can type into. For example, the following JSON creates a text input for an email address: ``` "textInput": { "name": "mailing_address", "label": "Mailing Address" } ``` As another example, the following JSON creates a text input for a programming language with static suggestions: ``` "textInput": { "name": "preferred_programing_language", "label": "Preferred Language", "initialSuggestions": { "items": [ { "text": "C++" }, { "text": "Java" }, { "text": "JavaScript" }, { "text": "Python" } ] } } ```
+                        "autoCompleteAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Optional. Specify what action to take when the text input field provides suggestions to users who interact with it. If unspecified, the suggestions are set by `initialSuggestions` and are processed by the client. If specified, the app takes the action specified here, such as running a custom function. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):
+                          "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                          "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                          "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                          "parameters": [ # List of action parameters.
+                            { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "key": "A String", # The name of the parameter for the action script.
+                              "value": "A String", # The value of the parameter.
+                            },
+                          ],
+                          "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                          "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "A String",
+                          ],
+                        },
+                        "hintText": "A String", # Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible. Required if `label` is unspecified. Otherwise, optional.
+                        "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                          "chatDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # A data source from Google Chat.
+                            "spaceDataSource": { # A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat): # Google Chat spaces that the user is a member of.
+                              "defaultToCurrentSpace": True or False, # If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.
+                            },
+                          },
+                          "workflowDataSource": { # * Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google. # A data source from Google Workflow.
+                            "includeVariables": True or False, # Whether to include variables from the previous step in the data source.
+                            "type": "A String", # The type of data source.
+                          },
+                        },
+                        "initialSuggestions": { # Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show just `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          "items": [ # A list of suggestions used for autocomplete recommendations in text input fields.
+                            { # One suggested value that users can enter in a text input field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "text": "A String", # The value of a suggested input to a text input field. This is equivalent to what users enter themselves.
+                            },
+                          ],
+                        },
+                        "label": "A String", # The text that appears above the text input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write `surname` instead of `name`. Required if `hintText` is unspecified. Otherwise, optional.
+                        "name": "A String", # The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                        "onChangeAction": { # An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text. Examples of actions to take include running a custom function or opening a [dialog](https://developers.google.com/workspace/chat/dialogs) in Google Chat.
+                          "allWidgetsAreRequired": True or False, # Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          "function": "A String", # A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).
+                          "interaction": "A String", # Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
+                          "loadIndicator": "A String", # Specifies the loading indicator that the action displays while making the call to the action.
+                          "parameters": [ # List of action parameters.
+                            { # List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                              "key": "A String", # The name of the parameter for the action script.
+                              "value": "A String", # The value of the parameter.
+                            },
+                          ],
+                          "persistValues": True or False, # Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
+                          "requiredWidgets": [ # Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                            "A String",
+                          ],
+                        },
+                        "placeholderText": "A String", # Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/workspace/chat):
+                        "type": "A String", # How a text input field appears in the user interface. For example, whether the field is single or multi-line.
+                        "validation": { # Represents the necessary data for validating the widget it's attached to. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          "characterLimit": 42, # Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                          "inputType": "A String", # Specify the type of the input widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
+                        },
+                        "value": "A String", # The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
+                      },
+                      "textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ```
+                        "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.
+                        "text": "A String", # The text that's shown in the widget.
+                        "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):
+                      },
+                      "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.
+                    },
+                  ],
+                },
+              ],
+            },
+            "cardId": "A String", # Required if the message contains multiple cards. A unique identifier for a card in a message.
+          },
+        ],
+        "clientAssignedMessageId": "A String", # Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the [`messageId`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id) field when you create the message. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
+        "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.
+        "deleteTime": "A String", # Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.
+        "deletionMetadata": { # Information about a deleted message. A message is deleted when `delete_time` is set. # Output only. Information about a deleted message. A message is deleted when `delete_time` is set.
+          "deletionType": "A String", # Indicates who deleted the message.
+        },
+        "emojiReactionSummaries": [ # Output only. The list of emoji reaction summaries on the message.
+          { # The number of people who reacted to a message with a specific emoji.
+            "emoji": { # An emoji that is used as a reaction to a message. # Output only. Emoji associated with the reactions.
+              "customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # A custom emoji.
+                "emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
+                "name": "A String", # Identifier. The resource name of the custom emoji, assigned by the server. Format: `customEmojis/{customEmoji}`
+                "payload": { # Payload data for the custom emoji. # Optional. Input only. Payload data. Required when the custom emoji is created.
+                  "fileContent": "A String", # Required. Input only. The image used for the custom emoji. The payload must be under 256 KB and the dimension of the image must be square and between 64 and 500 pixels. The restrictions are subject to change.
+                  "filename": "A String", # Required. Input only. The image file name. Supported file extensions: `.png`, `.jpg`, `.gif`.
+                },
+                "temporaryImageUri": "A String", # Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.
+                "uid": "A String", # Output only. Unique key for the custom emoji resource.
+              },
+              "unicode": "A String", # Optional. A basic emoji represented by a unicode string.
+            },
+            "reactionCount": 42, # Output only. The total number of reactions using the associated emoji.
+          },
+        ],
+        "fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.
+        "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message)
+        "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.
+        "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content.
+        "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links).
+          "url": "A String", # Output only. The URL that was matched.
+        },
+        "name": "A String", # Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
+        "privateMessageViewer": { # A user in Google Chat. When returned as an output from a request, if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output for a `User` resource only populates the user's `name` and `type`. # Optional. Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. To include this field in your request, you must call the Chat API using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and omit the following: * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments) For details, see [Send a message privately](https://developers.google.com/workspace/chat/create-messages#private).
+          "displayName": "A String", # Output only. The user's display name.
+          "domainId": "A String", # Unique identifier of the user's Google Workspace domain.
+          "isAnonymous": True or False, # Output only. When `true`, the user is deleted or their profile is not visible.
+          "name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API.
+          "type": "A String", # User type.
+        },
+        "quotedMessageMetadata": { # Information about a message that another message quotes. When you update a message, you can't add or replace the `quotedMessageMetadata` field, but you can remove it. For example usage, see [Quote another message](https://developers.google.com/workspace/chat/create-messages#quote-a-message). # Optional. Information about a message that another message quotes. When you create a message, you can quote messages within the same thread, or quote a root message to create a new root message. However, you can't quote a message reply from a different thread. When you update a message, you can't add or replace the `quotedMessageMetadata` field, but you can remove it. For example usage, see [Quote another message](https://developers.google.com/workspace/chat/create-messages#quote-a-message).
+          "forwardedMetadata": { # Metadata about the source space from which a message was forwarded. # Output only. Metadata about the source space of the quoted message. Populated only for FORWARD quote type.
+            "space": "A String", # Output only. The resource name of the source space. Format: spaces/{space}
+            "spaceDisplayName": "A String", # Output only. The display name of the source space or DM at the time of forwarding. For `SPACE`, this is the space name. For `DIRECT_MESSAGE`, this is the other participant's name (e.g., "User A"). For `GROUP_CHAT`, this is a generated name based on members' first names, limited to 5 including the creator (e.g., "User A, User B").
+          },
+          "lastUpdateTime": "A String", # Required. The timestamp when the quoted message was created or when the quoted message was last updated. If the message was edited, use this field, `last_update_time`. If the message was never edited, use `create_time`. If `last_update_time` doesn't match the latest version of the quoted message, the request fails.
+          "name": "A String", # Required. Resource name of the message that is quoted. Format: `spaces/{space}/messages/{message}`
+          "quoteType": "A String", # Optional. Specifies the quote type. If not set, defaults to REPLY in the message read/write path for backward compatibility.
+          "quotedMessageSnapshot": { # Provides a snapshot of the content of the quoted message at the time of quoting or forwarding # Output only. A snapshot of the quoted message's content.
+            "annotations": [ # Output only. Annotations parsed from the text body of the quoted message. Populated only for FORWARD quote type.
+              { # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+                "customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
+                  "customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
+                    "emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
+                    "name": "A String", # Identifier. The resource name of the custom emoji, assigned by the server. Format: `customEmojis/{customEmoji}`
+                    "payload": { # Payload data for the custom emoji. # Optional. Input only. Payload data. Required when the custom emoji is created.
+                      "fileContent": "A String", # Required. Input only. The image used for the custom emoji. The payload must be under 256 KB and the dimension of the image must be square and between 64 and 500 pixels. The restrictions are subject to change.
+                      "filename": "A String", # Required. Input only. The image file name. Supported file extensions: `.png`, `.jpg`, `.gif`.
+                    },
+                    "temporaryImageUri": "A String", # Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.
+                    "uid": "A String", # Output only. Unique key for the custom emoji resource.
+                  },
+                },
+                "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+                "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0. # The metadata for a rich link.
+                  "calendarEventLinkData": { # Data for Calendar event links. # Data for a Calendar event link.
+                    "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+                    "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+                  },
+                  "chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
+                    "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
+                    "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
+                    "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}`
+                  },
+                  "driveLinkData": { # Data for Google Drive links. # Data for a drive link.
+                    "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file.
+                      "driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
+                    },
+                    "mimeType": "A String", # The mime type of the linked Google Drive resource.
+                  },
+                  "meetSpaceLinkData": { # Data for Meet space links. # Data for a Meet space link.
+                    "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+                    "meetingCode": "A String", # Meeting code of the linked Meet space.
+                    "type": "A String", # Indicates the type of the Meet space.
+                  },
+                  "richLinkType": "A String", # The rich link type.
+                  "uri": "A String", # The URI of this link.
+                },
+                "slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command.
+                  "bot": { # A user in Google Chat. When returned as an output from a request, if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output for a `User` resource only populates the user's `name` and `type`. # The Chat app whose command was invoked.
+                    "displayName": "A String", # Output only. The user's display name.
+                    "domainId": "A String", # Unique identifier of the user's Google Workspace domain.
+                    "isAnonymous": True or False, # Output only. When `true`, the user is deleted or their profile is not visible.
+                    "name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API.
+                    "type": "A String", # User type.
+                  },
+                  "commandId": "A String", # The command ID of the invoked slash command.
+                  "commandName": "A String", # The name of the invoked slash command.
+                  "triggersDialog": True or False, # Indicates whether the slash command is for a dialog.
+                  "type": "A String", # The type of slash command.
+                },
+                "startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.
+                "type": "A String", # The type of this annotation.
+                "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
+                  "type": "A String", # The type of user mention.
+                  "user": { # A user in Google Chat. When returned as an output from a request, if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output for a `User` resource only populates the user's `name` and `type`. # The user mentioned.
+                    "displayName": "A String", # Output only. The user's display name.
+                    "domainId": "A String", # Unique identifier of the user's Google Workspace domain.
+                    "isAnonymous": True or False, # Output only. When `true`, the user is deleted or their profile is not visible.
+                    "name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API.
+                    "type": "A String", # User type.
+                  },
+                },
+              },
+            ],
+            "attachments": [ # Output only. Attachments that were part of the quoted message. These are copies of the quoted message's attachment metadata. Populated only for FORWARD quote type.
+              { # An attachment in Google Chat.
+                "attachmentDataRef": { # A reference to the attachment data. # Optional. A reference to the attachment data. This field is used to create or update messages with attachments, or with the media API to download the attachment data.
+                  "attachmentUploadToken": "A String", # Optional. Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments.
+                  "resourceName": "A String", # Optional. The resource name of the attachment data. This field is used with the media API to download the attachment data.
+                },
+                "contentName": "A String", # Output only. The original file name for the content, not the full path.
+                "contentType": "A String", # Output only. The content type (MIME type) of the file.
+                "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps shouldn't use this URL to download attachment content.
+                "driveDataRef": { # A reference to the data of a drive attachment. # Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.
+                  "driveFileId": "A String", # The ID for the drive file. Use with the Drive API.
+                },
+                "name": "A String", # Identifier. Resource name of the attachment. Format: `spaces/{space}/messages/{message}/attachments/{attachment}`.
+                "source": "A String", # Output only. The source of the attachment.
+                "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
+              },
+            ],
+            "formattedText": "A String", # Output only. Contains the quoted message `text` with markups added to support rich formatting like hyperlinks,custom emojis, markup, etc. Populated only for FORWARD quote type.
+            "sender": "A String", # Output only. The quoted message's author name. Populated for both REPLY & FORWARD quote types.
+            "text": "A String", # Output only. Snapshot of the quoted message's text content.
+          },
+        },
+        "sender": { # A user in Google Chat. When returned as an output from a request, if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output for a `User` resource only populates the user's `name` and `type`. # Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) `name` and `type`.
+          "displayName": "A String", # Output only. The user's display name.
+          "domainId": "A String", # Unique identifier of the user's Google Workspace domain.
+          "isAnonymous": True or False, # Output only. When `true`, the user is deleted or their profile is not visible.
+          "name": "A String", # Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API.
+          "type": "A String", # User type.
+        },
+        "silent": True or False, # Output only. Whether this is a silent message. Silent messages are messages where Chat suppresses push notifications for recipients.
+        "slashCommand": { # Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. # Output only. Slash command information, if applicable.
+          "commandId": "A String", # The ID of the slash command.
+        },
+        "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. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`.
+          "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.
+              "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space.
+                "principals": [ # Optional. Unordered list. Allowed principals for this permission.
+                  { # A principal representing an entity granted access.
+                    "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience.
+                      "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.
+                    },
+                  },
+                ],
+              },
+              "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space.
+                "principals": [ # Optional. Unordered list. Allowed principals for this permission.
+                  { # A principal representing an entity granted access.
+                    "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience.
+                      "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.
+                    },
+                  },
+                ],
+              },
+            },
+            "accessState": "A String", # Output only. Indicates the access state of the space.
+            "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+          },
+          "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
+          "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+          "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users.
+          "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
+          "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
+          "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+          "importModeExpireTime": "A String", # Output only. The time when the space will be automatically deleted by the system if it remains in import mode. Each space created in import mode must exit this mode before this expire time using `spaces.completeImport`. This field is only populated for spaces that were created with import mode.
+          "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space.
+          "membershipCount": { # Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`.
+            "joinedDirectHumanUserCount": 42, # Output only. Count of human users that have directly joined the space, not counting users joined by having membership in a joined group.
+            "joinedGroupCount": 42, # Output only. Count of all groups that have directly joined the space.
+          },
+          "name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`.
+          "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
+            "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space.
+              "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+              "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+              "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+            },
+            "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space.
+              "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+              "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+              "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+            },
+            "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space.
+              "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+              "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+              "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+            },
+            "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines.
+              "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+              "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+              "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+            },
+            "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space.
+              "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+              "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+              "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+            },
+            "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space.
+              "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+              "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+              "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+            },
+            "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off.
+              "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+              "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+              "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+            },
+            "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space.
+              "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+              "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+              "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+            },
+          },
+          "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
+          "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human.
+          "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules.
+            "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters.
+            "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters.
+          },
+          "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space.
+          "spaceThreadingState": "A String", # Output only. The threading state in the Chat space.
+          "spaceType": "A String", # Optional. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.
+          "spaceUri": "A String", # Output only. The URI for a user to access the space.
+          "threaded": True or False, # Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.
+          "type": "A String", # Output only. Deprecated: Use `space_type` instead. The type of a space.
+        },
+        "text": "A String", # Optional. Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a message](https://developers.google.com/workspace/chat/create-messages).
+        "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).
+          "name": "A String", # Identifier. Resource name of the thread. Example: `spaces/{space}/threads/{thread}`
+          "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead.
+        },
+        "threadReply": True or False, # Output only. When `true`, the message is a response in a reply thread. When `false`, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false`.
+      },
+      "read": True or False, # Indicates if the matched message is read by the calling user. Only returned if the request view is `SEARCH_MESSAGES_VIEW_FULL` and the calling credentials include one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`
+      "spaceMuteSetting": "A String", # The mute setting of the calling user for the space where the message is posted. The caller app can use this information to decide how to process the message depending on whether the space is muted for the user or not. Only returned if the request view is `SEARCH_MESSAGES_VIEW_FULL` and the calling credentials include the following [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`
+    },
+  ],
+}
+
+ +
+ search_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+
update(name, allowMissing=None, body=None, updateMask=None, x__xgafv=None)
Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app.
@@ -21314,6 +24428,7 @@ 

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -24365,6 +27480,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index 131e388050..fa97e9afb3 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -3065,6 +3065,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -6111,6 +6112,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -9157,6 +9159,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -12201,6 +12204,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -15243,6 +15247,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -18285,6 +18290,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -21790,6 +21796,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -24836,6 +24843,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -27882,6 +27890,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -30926,6 +30935,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -33968,6 +33978,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, @@ -37010,6 +37021,7 @@

Method Details

"fallbackText": "A String", # Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. "formattedText": "A String", # Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. + "markupSyntax": "A String", # Optional. Specifies how the server interprets the message `text` field content. "matchedUrl": { # A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). "url": "A String", # Output only. The URL that was matched. }, diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 407c425c69..b3ccd6443e 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -17,6 +17,15 @@ "https://www.googleapis.com/auth/chat.admin.spaces.readonly": { "description": "View display name, description, and other metadata for all Google Chat conversations owned by your organization" }, +"https://www.googleapis.com/auth/chat.app.all.memberships.readonly": { +"description": "On their own behalf, apps in Google Chat can see all members in Google Chat spaces and conversations throughout your Workspace organization, even when the Chat app isn't a member" +}, +"https://www.googleapis.com/auth/chat.app.all.messages.readonly": { +"description": "On their own behalf, apps in Google Chat can see all messages and reactions throughout your Workspace organization, even when the Chat app isn't a member of a space or conversation" +}, +"https://www.googleapis.com/auth/chat.app.all.spaces.readonly": { +"description": "On their own behalf, apps in Google Chat can see metadata about all spaces and conversations in Google Chat throughout your Workspace organization, even when the Chat app isn't a member" +}, "https://www.googleapis.com/auth/chat.app.delete": { "description": "On their own behalf, apps in Google Chat can delete conversations and spaces and remove access to associated files" }, @@ -670,7 +679,7 @@ ] }, "search": { -"description": "Returns a list of spaces in a Google Workspace organization. For an example, see [Search for and manage spaces](https://developers.google.com/workspace/chat/search-manage-admin). When `use_admin_access` is set to `false`, the results are limited to spaces where the calling user is a joined member. To search with administrator privileges, set `use_admin_access` to `true`. Setting `use_admin_access` to `false` is available under Developer Preview. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - [User authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces`", +"description": "Returns a list of spaces in a Google Workspace organization. For an example, see [Search for and manage spaces](https://developers.google.com/workspace/chat/search-manage-admin). When `use_admin_access` is set to `false`, the results are limited to spaces where the calling user is a joined member. To search with administrator privileges, set `use_admin_access` to `true`. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - [User authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces`", "flatPath": "v1/spaces:search", "httpMethod": "GET", "id": "chat.spaces.search", @@ -693,12 +702,12 @@ "type": "string" }, "query": { -"description": "Required. A search query. You can search by using the following parameters when `useAdminAccess` is set to `true`: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` When `useAdminAccess` is set to `false`: - `display_name` - `external_user_allowed` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required when `useAdminAccess` is set to `true`, and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. When `useAdminAccess` is set to `false`, `display_name` is required to retrieve meaningful results. Otherwise, the default behavior is to return an empty response. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required when `useAdminAccess` is set to `true`, and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = \"SPACE\" AND display_name:\"Hello\"` and an invalid example is `space_type = \"SPACE\" OR display_name:\"Hello\"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < \"2022-01-01T00:00:00+00:00\" AND last_active_time > \"2023-01-01T00:00:00+00:00\"`. The following example queries are valid when `useAdminAccess` is set to `true`: ``` customer = \"customers/my_customer\" AND space_type = \"SPACE\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND display_name:\"Hello World\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (last_active_time < \"2020-01-01T00:00:00+00:00\" OR last_active_time > \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (display_name:\"Hello World\" OR display_name:\"Fun event\") AND (last_active_time > \"2020-01-01T00:00:00+00:00\" AND last_active_time < \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (create_time > \"2019-01-01T00:00:00+00:00\" AND create_time < \"2020-01-01T00:00:00+00:00\") AND (external_user_allowed = \"true\") AND (space_history_state = \"HISTORY_ON\" OR space_history_state = \"HISTORY_OFF\") ``` The following example queries are valid when `useAdminAccess` is set to `false`: ``` display_name:\"Hello World\" (display_name:\"Hello\" OR display_name:\"Fun\") (external_user_allowed = \"true\") // Returns an empty response. (external_user_allowed = \"true\" AND display_name:\"Hello\") ```", +"description": "Required. A search query. You can search by using the following parameters when `useAdminAccess` is set to `true`: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` When `useAdminAccess` is set to `false`: - `display_name` - `external_user_allowed` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required when `useAdminAccess` is set to `true`, and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. When `useAdminAccess` is set to `false`, `display_name` is required to retrieve meaningful results. Otherwise, the default behavior is to return an empty response. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = \"SPACE\" AND display_name:\"Hello\"` and an invalid example is `space_type = \"SPACE\" OR display_name:\"Hello\"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < \"2022-01-01T00:00:00+00:00\" AND last_active_time > \"2023-01-01T00:00:00+00:00\"`. The following example queries are valid when `useAdminAccess` is set to `true`: ``` customer = \"customers/my_customer\" AND space_type = \"SPACE\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND display_name:\"Hello World\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (last_active_time < \"2020-01-01T00:00:00+00:00\" OR last_active_time > \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (display_name:\"Hello World\" OR display_name:\"Fun event\") AND (last_active_time > \"2020-01-01T00:00:00+00:00\" AND last_active_time < \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (create_time > \"2019-01-01T00:00:00+00:00\" AND create_time < \"2020-01-01T00:00:00+00:00\") AND (external_user_allowed = \"true\") AND (space_history_state = \"HISTORY_ON\" OR space_history_state = \"HISTORY_OFF\") ``` The following example queries are valid when `useAdminAccess` is set to `false`: ``` display_name:\"Hello World\" AND space_type = \"SPACE\" (display_name:\"Hello\" OR display_name:\"Fun\") AND space_type = \"SPACE\" (external_user_allowed = \"true\" AND space_type = \"SPACE\") // Returns an empty response. (external_user_allowed = \"true\" AND display_name:\"Hello\" AND space_type = \"SPACE\") ```", "location": "query", "type": "string" }, "useAdminAccess": { -"description": "When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Setting `use_admin_access` to `false` is available under Developer Preview. [Developer Preview](https://developers.google.com/workspace/preview).", +"description": "When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).", "location": "query", "type": "boolean" } @@ -1069,6 +1078,21 @@ "name" ], "parameters": { +"markupSyntax": { +"description": "Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.", +"enum": [ +"MARKUP_SYNTAX_UNSPECIFIED", +"MARKUP_SYNTAX_CHAT", +"MARKUP_SYNTAX_MARKDOWN" +], +"enumDescriptions": [ +"Represents the unspecified value.", +"Uses Google Chat's markup syntax. See https://developers.google.com/workspace/chat/format-messages#format-texts for more information.", +"Uses Markdown syntax. This syntax is based on the [CommonMark](https://commonmark.org/help/) specification, with additional extensions. See https://developers.google.com/workspace/chat/format-messages#format-texts for more information." +], +"location": "query", +"type": "string" +}, "name": { "description": "Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).", "location": "path", @@ -1102,6 +1126,21 @@ "location": "query", "type": "string" }, +"markupSyntax": { +"description": "Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.", +"enum": [ +"MARKUP_SYNTAX_UNSPECIFIED", +"MARKUP_SYNTAX_CHAT", +"MARKUP_SYNTAX_MARKDOWN" +], +"enumDescriptions": [ +"Represents the unspecified value.", +"Uses Google Chat's markup syntax. See https://developers.google.com/workspace/chat/format-messages#format-texts for more information.", +"Uses Markdown syntax. This syntax is based on the [CommonMark](https://commonmark.org/help/) specification, with additional extensions. See https://developers.google.com/workspace/chat/format-messages#format-texts for more information." +], +"location": "query", +"type": "string" +}, "orderBy": { "description": "Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: - `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.", "location": "query", @@ -1183,6 +1222,35 @@ "https://www.googleapis.com/auth/chat.messages" ] }, +"search": { +"description": "Searches for messages in Google Chat that the calling user has access to. Returns a list of messages matching the search criteria. To search across all spaces the user has access to, set `parent` to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. The returned messages have their `name` field populated with the full resource name, which includes the specific `space` in which the message resides. This API doesn't return all message types. The types of messages listed below aren't included in the response. Use ListMessages to list all messages. - Private Messages that are visible to the authenticated user. - Messages posted by Chat apps in spaces or group chats. - Messages in a Chat app DM. - Messages from blocked users. - Messages in spaces that the caller has muted. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages`", +"flatPath": "v1/spaces/{spacesId}/messages:search", +"httpMethod": "POST", +"id": "chat.spaces.messages.search", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the space to search within. To search across all spaces the user has access to, set this field to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. To limit the search to one or more spaces, use `space.name` or `space.display_name` in the `filter`.", +"location": "path", +"pattern": "^spaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/messages:search", +"request": { +"$ref": "SearchMessagesRequest" +}, +"response": { +"$ref": "SearchMessagesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/chat.messages", +"https://www.googleapis.com/auth/chat.messages.readonly" +] +}, "update": { "description": "Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app.", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}", @@ -1387,6 +1455,9 @@ "$ref": "SpaceEvent" }, "scopes": [ +"https://www.googleapis.com/auth/chat.app.all.memberships.readonly", +"https://www.googleapis.com/auth/chat.app.all.messages.readonly", +"https://www.googleapis.com/auth/chat.app.all.spaces.readonly", "https://www.googleapis.com/auth/chat.app.memberships", "https://www.googleapis.com/auth/chat.app.memberships.readonly", "https://www.googleapis.com/auth/chat.app.messages.readonly", @@ -1440,6 +1511,9 @@ "$ref": "ListSpaceEventsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/chat.app.all.memberships.readonly", +"https://www.googleapis.com/auth/chat.app.all.messages.readonly", +"https://www.googleapis.com/auth/chat.app.all.spaces.readonly", "https://www.googleapis.com/auth/chat.app.memberships", "https://www.googleapis.com/auth/chat.app.memberships.readonly", "https://www.googleapis.com/auth/chat.app.messages.readonly", @@ -1486,8 +1560,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.users.availability", -"https://www.googleapis.com/auth/chat.users.availability.readonly", -"https://www.googleapis.com/auth/chat.users.readstate" +"https://www.googleapis.com/auth/chat.users.availability.readonly" ] }, "markAsActive": { @@ -1515,8 +1588,7 @@ "$ref": "Availability" }, "scopes": [ -"https://www.googleapis.com/auth/chat.users.availability", -"https://www.googleapis.com/auth/chat.users.readstate" +"https://www.googleapis.com/auth/chat.users.availability" ] }, "markAsAway": { @@ -1544,8 +1616,7 @@ "$ref": "Availability" }, "scopes": [ -"https://www.googleapis.com/auth/chat.users.availability", -"https://www.googleapis.com/auth/chat.users.readstate" +"https://www.googleapis.com/auth/chat.users.availability" ] }, "markAsDoNotDisturb": { @@ -1573,8 +1644,7 @@ "$ref": "Availability" }, "scopes": [ -"https://www.googleapis.com/auth/chat.users.availability", -"https://www.googleapis.com/auth/chat.users.readstate" +"https://www.googleapis.com/auth/chat.users.availability" ] }, "patch": { @@ -1608,8 +1678,7 @@ "$ref": "Availability" }, "scopes": [ -"https://www.googleapis.com/auth/chat.users.availability", -"https://www.googleapis.com/auth/chat.users.readstate" +"https://www.googleapis.com/auth/chat.users.availability" ] } } @@ -2008,7 +2077,7 @@ } } }, -"revision": "20260705", +"revision": "20260728", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessPermissionSetting": { @@ -5485,6 +5554,20 @@ "readOnly": true, "type": "string" }, +"markupSyntax": { +"description": "Optional. Specifies how the server interprets the message `text` field content.", +"enum": [ +"MARKUP_SYNTAX_UNSPECIFIED", +"MARKUP_SYNTAX_CHAT", +"MARKUP_SYNTAX_MARKDOWN" +], +"enumDescriptions": [ +"Represents the unspecified value.", +"Uses Google Chat's markup syntax. See https://developers.google.com/workspace/chat/format-messages#format-texts for more information.", +"Uses Markdown syntax. This syntax is based on the [CommonMark](https://commonmark.org/help/) specification, with additional extensions. See https://developers.google.com/workspace/chat/format-messages#format-texts for more information." +], +"type": "string" +}, "matchedUrl": { "$ref": "MatchedUrl", "description": "Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links).", @@ -5963,6 +6046,117 @@ }, "type": "object" }, +"SearchMessageResult": { +"description": "A single result item from a message search.", +"id": "SearchMessageResult", +"properties": { +"message": { +"$ref": "Message", +"description": "The matched message." +}, +"read": { +"description": "Indicates if the matched message is read by the calling user. Only returned if the request view is `SEARCH_MESSAGES_VIEW_FULL` and the calling credentials include one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`", +"type": "boolean" +}, +"spaceMuteSetting": { +"description": "The mute setting of the calling user for the space where the message is posted. The caller app can use this information to decide how to process the message depending on whether the space is muted for the user or not. Only returned if the request view is `SEARCH_MESSAGES_VIEW_FULL` and the calling credentials include the following [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`", +"enum": [ +"MUTE_SETTING_UNSPECIFIED", +"UNMUTED", +"MUTED" +], +"enumDescriptions": [ +"Reserved.", +"The user will receive notifications for the space based on the notification setting.", +"The user will not receive any notifications for the space, regardless of the notification setting." +], +"type": "string" +} +}, +"type": "object" +}, +"SearchMessagesRequest": { +"description": "Request message for searching messages.", +"id": "SearchMessagesRequest", +"properties": { +"filter": { +"description": "Required. A search query. The query can specify one or more search keywords, which are used to filter the results, You can also filter the results using the following message fields: - `create_time`: Accepts a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `<` and `>=`. - `sender.name`: The resource name of the sender (`users/{user}`). Only supports `=`. You can use the e-mail as an alias for `{user}`. For example, `users/example@gmail.com`, where `example@gmail.com` is the e-mail of the Google Chat user. - `space.name`: The resource name of the space where the message is posted. (`spaces/{space}`). Only supports `=`. If this filter is not set, the search is performed across all direct messages and spaces the user has access to as a space member. - `space.display_name`: Supports the operator `:` (has) and filters spaces based on a partial match of their display name. Results are limited to the top five space matches. For example, `space.display_name:Project` searches for messages in the top five spaces that contain the word \"Project\" in their display names. - `attachment`: Supports the operator `:*` (has any) to check for the presence of attachments. If `attachment:*` is specified, only messages that have at least one attachment are returned. - `annotations.user_mentions.user.name`: The resource name of the mentioned user (`users/{user}`). Only supports `:` (has). For example: `annotations.user_mentions.user.name:\"users/1234567890\"` returns only messages that contain a mention to the specified user. Alternatively, the alias `me` can be used to filter for messages that mention the caller user, for example: `annotations.user_mentions.user.name:users/me`. You can also use the e-mail as an alias for `{user}`, for example, `users/example@gmail.com`. For advanced filtering, the following functions are also available: - `has_link()`: Returns only messages that have at least one hyperlink in the message text. - `is_unread()`: Filters out messages that have been read by the calling user. Using the `space.display_name` filter requires that the calling credentials include one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` Using the `is_unread()` filter requires that the calling credentials include one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate` Across different fields, only `AND` operators are supported. A valid example is `sender.name = \"users/1234567890\" AND is_unread()`. The word `AND` is optional and is implied if omitted. For example, `sender.name = \"users/1234567890\" is_unread()` is valid and is equivalent to the previous example. An invalid example is `sender.name = \"users/1234567890\" OR is_unread()` because `OR` is not supported between different fields. Among the same field: - `create_time` supports only `AND`, and can only be used to represent an interval, such as `create_time >= \"2022-01-01T00:00:00+00:00\" AND create_time < \"2023-01-01T00:00:00+00:00\"`. - `sender.name` supports only the `OR` operator, for example: `sender.name = \"users/1234567890\" OR sender.name = \"users/0987654321\"`. - `space.name` supports only the `OR` operator, for example: `space.name = \"spaces/ABCDEFGH\" OR space.name = \"spaces/QWERTYUI\"`. - `space.display_name` supports the operators `AND` and `OR`, but not a mix of both. For example: `space.display_name:Project AND space.display_name:Tasks` returns messages that are in spaces with display names containing both `Project` and `Tasks`, whereas `space.display_name:Project OR space.display_name:Tasks` returns messages that are in spaces with display names containing either `Project` or `Tasks` or both. - `annotations.user_mentions.user.name` supports the operators `AND` and `OR`, but not a mix of both. For example: `annotations.user_mentions.user.name:\"users/1234567890\" AND annotations.user_mentions.user.name:\"users/0987654321\"` returns only messages that mentions both users, whereas `annotations.user_mentions.user.name:\"users/1234567890\" OR annotations.user_mentions.user.name:\"users/0987654321\"` returns messages that mention either user or both. Parentheses are required to disambiguate operator precedence when combining `AND` and `OR` operators in the same query. For example: `(sender.name=\"users/me\" OR sender.name=\"users/123456\") AND is_unread()`. Otherwise, parentheses are optional. The following example queries are valid: ``` \"Pending reports\" AND create_time >= \"2023-01-01T00:00:00Z\" sender.name = \"users/example@gmail.com\" annotations.user_mentions.user.name:\"users/0987654321\" attachment:* AND space.name = \"spaces/ABCDEFGH\" tasks AND is_unread() AND sender.name = \"users/1234567890\" \"things to do\" \"urgent\" (sender.name = \"users/1234567890\") AND (create_time < \"2023-05-01T00:00:00Z\") tasks AND space.name = \"spaces/ABCDEFGH\" AND has_link() \"project one\" is_unread() space.display_name:Project tasks ``` The maximum query length is 1,000 characters. Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.", +"type": "string" +}, +"markupSyntax": { +"description": "Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.", +"enum": [ +"MARKUP_SYNTAX_UNSPECIFIED", +"MARKUP_SYNTAX_CHAT", +"MARKUP_SYNTAX_MARKDOWN" +], +"enumDescriptions": [ +"Represents the unspecified value.", +"Uses Google Chat's markup syntax. See https://developers.google.com/workspace/chat/format-messages#format-texts for more information.", +"Uses Markdown syntax. This syntax is based on the [CommonMark](https://commonmark.org/help/) specification, with additional extensions. See https://developers.google.com/workspace/chat/format-messages#format-texts for more information." +], +"type": "string" +}, +"orderBy": { +"description": "Optional. How the results list is ordered. Supported attributes to order by are: - `create_time`: Sorts the results by the time of the message creation. Default value. - `relevance`: Sorts the results by relevance. [Developer Preview](https://developers.google.com/workspace/preview). The default ordering is `create_time desc`. Only a single order per query (`create_time` or `relevance`) is supported. Only descending order (`desc`) is supported, and it must be specified after the order attribute.", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 25 are returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token, received from the previous search messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.", +"type": "string" +}, +"view": { +"description": "Optional. Specifies what kind of search results view to return. The default is `SEARCH_MESSAGES_VIEW_BASIC`.", +"enum": [ +"SEARCH_MESSAGES_VIEW_UNSPECIFIED", +"SEARCH_MESSAGES_VIEW_BASIC", +"SEARCH_MESSAGES_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the BASIC view.", +"Includes only the matched messages in the results, but no additional metadata. This is the default value.", +"Includes everything in the results: the matched messages and additional metadata." +], +"type": "string" +} +}, +"type": "object" +}, +"SearchMessagesResponse": { +"description": "Response message for searching messages.", +"id": "SearchMessagesResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.", +"type": "string" +}, +"results": { +"description": "The list of search results that matched the query.", +"items": { +"$ref": "SearchMessageResult" +}, +"type": "array" +} +}, +"type": "object" +}, +"SearchSpaceResult": { +"description": "A single result item from a space search.", +"id": "SearchSpaceResult", +"properties": { +"space": { +"$ref": "Space", +"description": "Output only. The matched space.", +"readOnly": true +} +}, +"type": "object" +}, "SearchSpacesResponse": { "description": "Response with a list of spaces corresponding to the search spaces request.", "id": "SearchSpacesResponse", @@ -5971,6 +6165,14 @@ "description": "A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.", "type": "string" }, +"results": { +"description": "Output only. The list of search results that matched the query.", +"items": { +"$ref": "SearchSpaceResult" +}, +"readOnly": true, +"type": "array" +}, "spaces": { "deprecated": true, "description": "Deprecated: Please use the new `results` field instead. A page of the requested spaces. This field will be populated only when `useAdminAccess` is set to `true` and deprecated in favor of the new `results` field.", From c5d72ac5b1bd7ddaf584ac55cd1c5399406fd3db Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:00 +0000 Subject: [PATCH 25/84] fix(clouddeploy): update the api #### clouddeploy:v1 The following keys were changed: - endpoints (Total Keys: 1) --- .../discovery_cache/documents/clouddeploy.v1.json | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json index f61bff4fd2..51e752a57b 100644 --- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json +++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json @@ -33,11 +33,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://clouddeploy.us-central2.rep.googleapis.com/", -"location": "us-central2" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://clouddeploy.us-east1.rep.googleapis.com/", "location": "us-east1" }, @@ -2426,7 +2421,7 @@ } } }, -"revision": "20260525", +"revision": "20260722", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { From 77678d5cd5de3b7f14c3cf4ee91e80faebe2d4b6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:00 +0000 Subject: [PATCH 26/84] feat(cloudidentity): update the api #### cloudidentity:v1beta1 The following keys were added: - schemas.ExternalId (Total Keys: 4) - schemas.Group.properties.externalIds (Total Keys: 2) --- docs/dyn/cloudidentity_v1beta1.groups.html | 30 +++++++++++++++++++ .../documents/cloudidentity.v1beta1.json | 24 ++++++++++++++- 2 files changed, 53 insertions(+), 1 deletion(-) diff --git a/docs/dyn/cloudidentity_v1beta1.groups.html b/docs/dyn/cloudidentity_v1beta1.groups.html index 9b136c76fc..9bd782814e 100644 --- a/docs/dyn/cloudidentity_v1beta1.groups.html +++ b/docs/dyn/cloudidentity_v1beta1.groups.html @@ -151,6 +151,12 @@

Method Details

"statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created. }, }, + "externalIds": [ # Optional. External identifiers associated with the `Group`. Enables external identity providers and directory sync tools to link their native unique identifiers with this group. Currently, the only allowable namespace is `"system/external"`. + { # An external identifier for an entity in the Cloud Identity Groups API. Used to link a `Group` in Cloud Identity Groups API with a corresponding entity in an external identity system or directory. + "id": "A String", # Required. The unique identifier assigned by the external identity provider. The API does not enforce uniqueness of IDs across entities, but clients should ensure IDs are unique within their namespace. + "namespace": "A String", # Required. The namespace in which the entity exists. Cannot be empty. Currently, the only allowable namespace is `"system/external"`. + }, + ], "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. The `EntityKey` of the `Group`. "id": "A String", # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`. @@ -275,6 +281,12 @@

Method Details

"statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created. }, }, + "externalIds": [ # Optional. External identifiers associated with the `Group`. Enables external identity providers and directory sync tools to link their native unique identifiers with this group. Currently, the only allowable namespace is `"system/external"`. + { # An external identifier for an entity in the Cloud Identity Groups API. Used to link a `Group` in Cloud Identity Groups API with a corresponding entity in an external identity system or directory. + "id": "A String", # Required. The unique identifier assigned by the external identity provider. The API does not enforce uniqueness of IDs across entities, but clients should ensure IDs are unique within their namespace. + "namespace": "A String", # Required. The namespace in which the entity exists. Cannot be empty. Currently, the only allowable namespace is `"system/external"`. + }, + ], "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. The `EntityKey` of the `Group`. "id": "A String", # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`. @@ -366,6 +378,12 @@

Method Details

"statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created. }, }, + "externalIds": [ # Optional. External identifiers associated with the `Group`. Enables external identity providers and directory sync tools to link their native unique identifiers with this group. Currently, the only allowable namespace is `"system/external"`. + { # An external identifier for an entity in the Cloud Identity Groups API. Used to link a `Group` in Cloud Identity Groups API with a corresponding entity in an external identity system or directory. + "id": "A String", # Required. The unique identifier assigned by the external identity provider. The API does not enforce uniqueness of IDs across entities, but clients should ensure IDs are unique within their namespace. + "namespace": "A String", # Required. The namespace in which the entity exists. Cannot be empty. Currently, the only allowable namespace is `"system/external"`. + }, + ], "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. The `EntityKey` of the `Group`. "id": "A String", # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`. @@ -454,6 +472,12 @@

Method Details

"statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created. }, }, + "externalIds": [ # Optional. External identifiers associated with the `Group`. Enables external identity providers and directory sync tools to link their native unique identifiers with this group. Currently, the only allowable namespace is `"system/external"`. + { # An external identifier for an entity in the Cloud Identity Groups API. Used to link a `Group` in Cloud Identity Groups API with a corresponding entity in an external identity system or directory. + "id": "A String", # Required. The unique identifier assigned by the external identity provider. The API does not enforce uniqueness of IDs across entities, but clients should ensure IDs are unique within their namespace. + "namespace": "A String", # Required. The namespace in which the entity exists. Cannot be empty. Currently, the only allowable namespace is `"system/external"`. + }, + ], "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. The `EntityKey` of the `Group`. "id": "A String", # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`. @@ -548,6 +572,12 @@

Method Details

"statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created. }, }, + "externalIds": [ # Optional. External identifiers associated with the `Group`. Enables external identity providers and directory sync tools to link their native unique identifiers with this group. Currently, the only allowable namespace is `"system/external"`. + { # An external identifier for an entity in the Cloud Identity Groups API. Used to link a `Group` in Cloud Identity Groups API with a corresponding entity in an external identity system or directory. + "id": "A String", # Required. The unique identifier assigned by the external identity provider. The API does not enforce uniqueness of IDs across entities, but clients should ensure IDs are unique within their namespace. + "namespace": "A String", # Required. The namespace in which the entity exists. Cannot be empty. Currently, the only allowable namespace is `"system/external"`. + }, + ], "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. The `EntityKey` of the `Group`. "id": "A String", # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`. diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index 649d212f63..e3337a62f4 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -2349,7 +2349,7 @@ } } }, -"revision": "20260617", +"revision": "20260722", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -3575,6 +3575,21 @@ }, "type": "object" }, +"ExternalId": { +"description": "An external identifier for an entity in the Cloud Identity Groups API. Used to link a `Group` in Cloud Identity Groups API with a corresponding entity in an external identity system or directory.", +"id": "ExternalId", +"properties": { +"id": { +"description": "Required. The unique identifier assigned by the external identity provider. The API does not enforce uniqueness of IDs across entities, but clients should ensure IDs are unique within their namespace.", +"type": "string" +}, +"namespace": { +"description": "Required. The namespace in which the entity exists. Cannot be empty. Currently, the only allowable namespace is `\"system/external\"`.", +"type": "string" +} +}, +"type": "object" +}, "GetMembershipGraphResponse": { "description": "The response message for MembershipsService.GetMembershipGraph.", "id": "GetMembershipGraphResponse", @@ -4517,6 +4532,13 @@ "$ref": "DynamicGroupMetadata", "description": "Optional. Dynamic group metadata like queries and status." }, +"externalIds": { +"description": "Optional. External identifiers associated with the `Group`. Enables external identity providers and directory sync tools to link their native unique identifiers with this group. Currently, the only allowable namespace is `\"system/external\"`.", +"items": { +"$ref": "ExternalId" +}, +"type": "array" +}, "groupKey": { "$ref": "EntityKey", "description": "Required. The `EntityKey` of the `Group`." From e194d29e93bf9df6fd8fab33f171d25227f599bb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:00 +0000 Subject: [PATCH 27/84] feat(cloudresourcemanager): update the api #### cloudresourcemanager:v3 The following keys were added: - resources.v3.methods.fetchResourceSemantics (Total Keys: 9) - schemas.FetchResourceSemanticsResponse (Total Keys: 5) --- docs/dyn/cloudresourcemanager_v3.html | 5 + docs/dyn/cloudresourcemanager_v3.v3.html | 111 ++++++++++++++++++ .../documents/cloudresourcemanager.v3.json | 46 +++++++- 3 files changed, 161 insertions(+), 1 deletion(-) create mode 100644 docs/dyn/cloudresourcemanager_v3.v3.html diff --git a/docs/dyn/cloudresourcemanager_v3.html b/docs/dyn/cloudresourcemanager_v3.html index 693621d009..0ab14f3a1b 100644 --- a/docs/dyn/cloudresourcemanager_v3.html +++ b/docs/dyn/cloudresourcemanager_v3.html @@ -124,6 +124,11 @@

Instance Methods

Returns the tagValues Resource.

+

+ v3() +

+

Returns the v3 Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/cloudresourcemanager_v3.v3.html b/docs/dyn/cloudresourcemanager_v3.v3.html new file mode 100644 index 0000000000..8d15faa476 --- /dev/null +++ b/docs/dyn/cloudresourcemanager_v3.v3.html @@ -0,0 +1,111 @@ + + + +

Cloud Resource Manager API . v3

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ fetchResourceSemantics(fullResourceName=None, x__xgafv=None)

+

Returns the semantics associated with the specified resource.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ fetchResourceSemantics(fullResourceName=None, x__xgafv=None) +
Returns the semantics associated with the specified resource.
+
+Args:
+  fullResourceName: string, Required. The full resource name of the GCP resource to retrieve semantics for. Examples: "//compute.googleapis.com/projects/123/zones/us-central1-a/instances/my-instance" "//storage.googleapis.com/projects/_/buckets/my_bucket"
+  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 FetchResourceSemantics.
+  "fullResourceName": "A String", # The full resource name for which semantics are returned. Examples: "//compute.googleapis.com/projects/123/zones/us-central1-a/instances/my-instance" "//storage.googleapis.com/projects/_/buckets/my_bucket"
+  "semantics": { # Map of resource semantics (e.g., `"ENVIRONMENT": "PRODUCTION"`).
+    "a_key": "A String",
+  },
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json index 2aaddfe80d..6af2204b37 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json @@ -1966,9 +1966,35 @@ } } } +}, +"v3": { +"methods": { +"fetchResourceSemantics": { +"description": "Returns the semantics associated with the specified resource.", +"flatPath": "v3:fetchResourceSemantics", +"httpMethod": "GET", +"id": "cloudresourcemanager.fetchResourceSemantics", +"parameterOrder": [], +"parameters": { +"fullResourceName": { +"description": "Required. The full resource name of the GCP resource to retrieve semantics for. Examples: \"//compute.googleapis.com/projects/123/zones/us-central1-a/instances/my-instance\" \"//storage.googleapis.com/projects/_/buckets/my_bucket\"", +"location": "query", +"type": "string" +} +}, +"path": "v3:fetchResourceSemantics", +"response": { +"$ref": "FetchResourceSemanticsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +} } }, -"revision": "20260218", +"revision": "20260715", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -2293,6 +2319,24 @@ }, "type": "object" }, +"FetchResourceSemanticsResponse": { +"description": "Response message for FetchResourceSemantics.", +"id": "FetchResourceSemanticsResponse", +"properties": { +"fullResourceName": { +"description": "The full resource name for which semantics are returned. Examples: \"//compute.googleapis.com/projects/123/zones/us-central1-a/instances/my-instance\" \"//storage.googleapis.com/projects/_/buckets/my_bucket\"", +"type": "string" +}, +"semantics": { +"additionalProperties": { +"type": "string" +}, +"description": "Map of resource semantics (e.g., `\"ENVIRONMENT\": \"PRODUCTION\"`).", +"type": "object" +} +}, +"type": "object" +}, "Folder": { "description": "A folder in an organization's resource hierarchy, used to organize that organization's resources.", "id": "Folder", From 7a42243bcfe9814f74af279c309bd7acbd1180e7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:00 +0000 Subject: [PATCH 28/84] feat(cloudsearch): update the api #### cloudsearch:v1 The following keys were added: - resources.query.resources.sources.methods.list.parameters.requestOptions.countryCode (Total Keys: 2) - schemas.RequestOptions.properties.countryCode.type (Total Keys: 1) --- docs/dyn/cloudsearch_v1.query.html | 3 +++ docs/dyn/cloudsearch_v1.query.sources.html | 5 +++-- .../discovery_cache/documents/cloudsearch.v1.json | 11 ++++++++++- 3 files changed, 16 insertions(+), 3 deletions(-) diff --git a/docs/dyn/cloudsearch_v1.query.html b/docs/dyn/cloudsearch_v1.query.html index 64fbdcb9dd..03bd9ab184 100644 --- a/docs/dyn/cloudsearch_v1.query.html +++ b/docs/dyn/cloudsearch_v1.query.html @@ -108,6 +108,7 @@

Method Details

{ # Remove Logged Activity Request. "requestOptions": { # Shared request options for all RPC methods. # Request options, such as the search application and clientId. "clientDisplayLanguageCode": "A String", # The BCP-47 language code, such as "pt" or "en". It represents the user's preferred Display Language. + "countryCode": "A String", # Optional. Specifies the country/region where the query originated, as a lowercase ISO 3166-1 alpha-2 region code (using 'uk' instead of 'gb' for the United Kingdom). "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. }, @@ -209,6 +210,7 @@

Method Details

}, "requestOptions": { # Shared request options for all RPC methods. # Request options, such as the search application and user timezone. "clientDisplayLanguageCode": "A String", # The BCP-47 language code, such as "pt" or "en". It represents the user's preferred Display Language. + "countryCode": "A String", # Optional. Specifies the country/region where the query originated, as a lowercase ISO 3166-1 alpha-2 region code (using 'uk' instead of 'gb' for the United Kingdom). "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. }, @@ -582,6 +584,7 @@

Method Details

"query": "A String", # Partial query for which autocomplete suggestions will be shown. For example, if the query is "sea", then the server might return "season", "search", "seagull" and so on. "requestOptions": { # Shared request options for all RPC methods. # Request options, such as the search application and user timezone. "clientDisplayLanguageCode": "A String", # The BCP-47 language code, such as "pt" or "en". It represents the user's preferred Display Language. + "countryCode": "A String", # Optional. Specifies the country/region where the query originated, as a lowercase ISO 3166-1 alpha-2 region code (using 'uk' instead of 'gb' for the United Kingdom). "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. }, diff --git a/docs/dyn/cloudsearch_v1.query.sources.html b/docs/dyn/cloudsearch_v1.query.sources.html index 50393d9299..60a31a37b4 100644 --- a/docs/dyn/cloudsearch_v1.query.sources.html +++ b/docs/dyn/cloudsearch_v1.query.sources.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- list(pageToken=None, requestOptions_clientDisplayLanguageCode=None, requestOptions_debugOptions_enableDebugging=None, requestOptions_languageCode=None, requestOptions_searchApplicationId=None, requestOptions_timeZone=None, x__xgafv=None)

+ list(pageToken=None, requestOptions_clientDisplayLanguageCode=None, requestOptions_countryCode=None, requestOptions_debugOptions_enableDebugging=None, requestOptions_languageCode=None, requestOptions_searchApplicationId=None, requestOptions_timeZone=None, x__xgafv=None)

Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).

list_next()

@@ -90,12 +90,13 @@

Method Details

- list(pageToken=None, requestOptions_clientDisplayLanguageCode=None, requestOptions_debugOptions_enableDebugging=None, requestOptions_languageCode=None, requestOptions_searchApplicationId=None, requestOptions_timeZone=None, x__xgafv=None) + list(pageToken=None, requestOptions_clientDisplayLanguageCode=None, requestOptions_countryCode=None, requestOptions_debugOptions_enableDebugging=None, requestOptions_languageCode=None, requestOptions_searchApplicationId=None, requestOptions_timeZone=None, x__xgafv=None)
Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).
 
 Args:
   pageToken: string, Number of sources to return in the response.
   requestOptions_clientDisplayLanguageCode: string, The BCP-47 language code, such as "pt" or "en". It represents the user's preferred Display Language.
+  requestOptions_countryCode: string, Optional. Specifies the country/region where the query originated, as a lowercase ISO 3166-1 alpha-2 region code (using 'uk' instead of 'gb' for the United Kingdom).
   requestOptions_debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
   requestOptions_languageCode: string, The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions.
   requestOptions_searchApplicationId: string, The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922).
diff --git a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json
index 8d8a01559a..da1de6af31 100644
--- a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json
@@ -1020,6 +1020,11 @@
 "location": "query",
 "type": "string"
 },
+"requestOptions.countryCode": {
+"description": "Optional. Specifies the country/region where the query originated, as a lowercase ISO 3166-1 alpha-2 region code (using 'uk' instead of 'gb' for the United Kingdom).",
+"location": "query",
+"type": "string"
+},
 "requestOptions.debugOptions.enableDebugging": {
 "description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
 "location": "query",
@@ -2106,7 +2111,7 @@
 }
 }
 },
-"revision": "20260610",
+"revision": "20260729",
 "rootUrl": "https://cloudsearch.googleapis.com/",
 "schemas": {
 "Action": {
@@ -6894,6 +6899,10 @@ false
 "description": "The BCP-47 language code, such as \"pt\" or \"en\". It represents the user's preferred Display Language.",
 "type": "string"
 },
+"countryCode": {
+"description": "Optional. Specifies the country/region where the query originated, as a lowercase ISO 3166-1 alpha-2 region code (using 'uk' instead of 'gb' for the United Kingdom).",
+"type": "string"
+},
 "debugOptions": {
 "$ref": "DebugOptions",
 "description": "Debug options of the request"

From add752f01ddc2a752181c4a0e7af262de853f276 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Aug 2026 07:58:00 +0000
Subject: [PATCH 29/84] feat(cloudsupport): update the api

#### cloudsupport:v2

The following keys were deleted:
- resources.supportEventSubscriptions.methods.create (Total Keys: 12)
- resources.supportEventSubscriptions.methods.delete (Total Keys: 11)
- resources.supportEventSubscriptions.methods.expunge (Total Keys: 12)
- resources.supportEventSubscriptions.methods.get (Total Keys: 11)
- resources.supportEventSubscriptions.methods.list (Total Keys: 20)
- resources.supportEventSubscriptions.methods.patch (Total Keys: 15)
- resources.supportEventSubscriptions.methods.undelete (Total Keys: 12)

The following keys were added:
- resources.organizations.resources.supportEventSubscriptions.methods.create (Total Keys: 12)
- resources.organizations.resources.supportEventSubscriptions.methods.delete (Total Keys: 11)
- resources.organizations.resources.supportEventSubscriptions.methods.expunge (Total Keys: 12)
- resources.organizations.resources.supportEventSubscriptions.methods.get (Total Keys: 11)
- resources.organizations.resources.supportEventSubscriptions.methods.list (Total Keys: 20)
- resources.organizations.resources.supportEventSubscriptions.methods.patch (Total Keys: 15)
- resources.organizations.resources.supportEventSubscriptions.methods.undelete (Total Keys: 12)

#### cloudsupport:v2beta

The following keys were deleted:
- resources.supportEventSubscriptions.methods.create (Total Keys: 12)
- resources.supportEventSubscriptions.methods.delete (Total Keys: 11)
- resources.supportEventSubscriptions.methods.expunge (Total Keys: 12)
- resources.supportEventSubscriptions.methods.get (Total Keys: 11)
- resources.supportEventSubscriptions.methods.list (Total Keys: 20)
- resources.supportEventSubscriptions.methods.patch (Total Keys: 15)
- resources.supportEventSubscriptions.methods.undelete (Total Keys: 12)

The following keys were added:
- resources.organizations.resources.supportEventSubscriptions.methods.create (Total Keys: 12)
- resources.organizations.resources.supportEventSubscriptions.methods.delete (Total Keys: 11)
- resources.organizations.resources.supportEventSubscriptions.methods.expunge (Total Keys: 12)
- resources.organizations.resources.supportEventSubscriptions.methods.get (Total Keys: 11)
- resources.organizations.resources.supportEventSubscriptions.methods.list (Total Keys: 20)
- resources.organizations.resources.supportEventSubscriptions.methods.patch (Total Keys: 15)
- resources.organizations.resources.supportEventSubscriptions.methods.undelete (Total Keys: 12)
---
 docs/dyn/cloudsupport_v2.html                 |   4 +-
 docs/dyn/cloudsupport_v2.organizations.html   |  91 +++++
 ...ganizations.supportEventSubscriptions.html | 348 ++++++++++++++++++
 docs/dyn/cloudsupport_v2beta.html             |   4 +-
 .../cloudsupport_v2beta.organizations.html    |  91 +++++
 ...ganizations.supportEventSubscriptions.html | 348 ++++++++++++++++++
 .../documents/cloudsupport.v2.json            |  52 +--
 .../documents/cloudsupport.v2beta.json        |  52 +--
 8 files changed, 938 insertions(+), 52 deletions(-)
 create mode 100644 docs/dyn/cloudsupport_v2.organizations.html
 create mode 100644 docs/dyn/cloudsupport_v2.organizations.supportEventSubscriptions.html
 create mode 100644 docs/dyn/cloudsupport_v2beta.organizations.html
 create mode 100644 docs/dyn/cloudsupport_v2beta.organizations.supportEventSubscriptions.html

diff --git a/docs/dyn/cloudsupport_v2.html b/docs/dyn/cloudsupport_v2.html
index c7df59267b..f0d1515f27 100644
--- a/docs/dyn/cloudsupport_v2.html
+++ b/docs/dyn/cloudsupport_v2.html
@@ -90,9 +90,9 @@ 

Instance Methods

Returns the media Resource.

- supportEventSubscriptions() + organizations()

-

Returns the supportEventSubscriptions Resource.

+

Returns the organizations Resource.

close()

diff --git a/docs/dyn/cloudsupport_v2.organizations.html b/docs/dyn/cloudsupport_v2.organizations.html new file mode 100644 index 0000000000..ba38f0d851 --- /dev/null +++ b/docs/dyn/cloudsupport_v2.organizations.html @@ -0,0 +1,91 @@ + + + +

Google Cloud Support API . organizations

+

Instance Methods

+

+ supportEventSubscriptions() +

+

Returns the supportEventSubscriptions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudsupport_v2.organizations.supportEventSubscriptions.html b/docs/dyn/cloudsupport_v2.organizations.supportEventSubscriptions.html new file mode 100644 index 0000000000..9d69fcca28 --- /dev/null +++ b/docs/dyn/cloudsupport_v2.organizations.supportEventSubscriptions.html @@ -0,0 +1,348 @@ + + + +

Google Cloud Support API . organizations . supportEventSubscriptions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a support event subscription for an organization. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "pub_sub_topic": "projects/my-project/topics/my-topic" }' \ "https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().create( parent="organizations/123456789", body={ "pub_sub_topic": "projects/my-project/topics/my-topic" }, ) print(request.execute()) ```

+

+ delete(name, x__xgafv=None)

+

Soft deletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request DELETE \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService).supportEventSubscriptions().delete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```

+

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

+

Expunges a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription:expunge" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().expunge( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```

+

+ get(name, x__xgafv=None)

+

Gets a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().get( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```

+

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

+

Lists support event subscriptions. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().list( parent="organizations/123456789" ) print(request.execute()) ```

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "pub_sub_topic": "projects/my-project/topics/new-topic" }' \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription?updateMask=pub_sub_topic" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().patch( name="organizations/123456789/supportEventSubscriptions/abcdef123456", body={ "pub_sub_topic": "projects/my-project/topics/new-topic" }, ) print(request.execute()) ```

+

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

+

Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription:undelete" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().undelete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a support event subscription for an organization. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "pub_sub_topic": "projects/my-project/topics/my-topic" }' \ "https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().create( parent="organizations/123456789", body={ "pub_sub_topic": "projects/my-project/topics/my-topic" }, ) print(request.execute()) ```
+
+Args:
+  parent: string, Required. The parent resource name where the support event subscription will be created. Format: organizations/{organization_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Soft deletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request DELETE \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService).supportEventSubscriptions().delete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```
+
+Args:
+  name: string, Required. The name of the support event subscription to delete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+ +
+ expunge(name, body=None, x__xgafv=None) +
Expunges a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription:expunge" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().expunge( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```
+
+Args:
+  name: string, Required. The name of the support event subscription to expunge. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ExpungeSupportEventSubscription.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().get( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```
+
+Args:
+  name: string, Required. The name of the support event subscription to retrieve. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) +
Lists support event subscriptions. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().list( parent="organizations/123456789" ) print(request.execute()) ```
+
+Args:
+  parent: string, Required. The fully qualified name of the Cloud resource to list support event subscriptions under. Format: organizations/{organization_id} (required)
+  filter: string, Optional. Filter expression based on AIP-160. Supported fields: - pub_sub_topic - state Examples: - `pub_sub_topic="projects/example-project/topics/example-topic"` - `state=WORKING` - `pub_sub_topic="projects/example-project/topics/example-topic" AND state=WORKING`
+  pageSize: integer, Optional. The maximum number of support event subscriptions to return.
+  pageToken: string, Optional. A token identifying the page of results to return. If unspecified, the first page is retrieved. When paginating, all other parameters provided to `ListSupportEventSubscriptions` must match the call that provided the page token.
+  showDeleted: boolean, Optional. Whether to show deleted subscriptions. By default, deleted subscriptions are not returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListSupportEventSubscriptions.
+  "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.
+  "supportEventSubscriptions": [ # The support event subscriptions.
+    { # A support event subscription.
+      "createTime": "A String", # Output only. The time at which the subscription was created.
+      "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+      "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+      "name": "A String", # Identifier. The resource name of the support event subscription.
+      "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+      "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+      "state": "A String", # Output only. The state of the subscription.
+      "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "pub_sub_topic": "projects/my-project/topics/new-topic" }' \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription?updateMask=pub_sub_topic" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().patch( name="organizations/123456789/supportEventSubscriptions/abcdef123456", body={ "pub_sub_topic": "projects/my-project/topics/new-topic" }, ) print(request.execute()) ```
+
+Args:
+  name: string, Identifier. The resource name of the support event subscription. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+  updateMask: string, Optional. The list of fields to update. The only supported value is pub_sub_topic.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+ +
+ undelete(name, body=None, x__xgafv=None) +
Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription:undelete" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().undelete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```
+
+Args:
+  name: string, Required. The name of the support event subscription to undelete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for UndeleteSupportEventSubscription.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudsupport_v2beta.html b/docs/dyn/cloudsupport_v2beta.html index b3428f0582..440a6f88e4 100644 --- a/docs/dyn/cloudsupport_v2beta.html +++ b/docs/dyn/cloudsupport_v2beta.html @@ -90,9 +90,9 @@

Instance Methods

Returns the media Resource.

- supportEventSubscriptions() + organizations()

-

Returns the supportEventSubscriptions Resource.

+

Returns the organizations Resource.

close()

diff --git a/docs/dyn/cloudsupport_v2beta.organizations.html b/docs/dyn/cloudsupport_v2beta.organizations.html new file mode 100644 index 0000000000..c69386ea92 --- /dev/null +++ b/docs/dyn/cloudsupport_v2beta.organizations.html @@ -0,0 +1,91 @@ + + + +

Google Cloud Support API . organizations

+

Instance Methods

+

+ supportEventSubscriptions() +

+

Returns the supportEventSubscriptions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudsupport_v2beta.organizations.supportEventSubscriptions.html b/docs/dyn/cloudsupport_v2beta.organizations.supportEventSubscriptions.html new file mode 100644 index 0000000000..61859faa58 --- /dev/null +++ b/docs/dyn/cloudsupport_v2beta.organizations.supportEventSubscriptions.html @@ -0,0 +1,348 @@ + + + +

Google Cloud Support API . organizations . supportEventSubscriptions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a support event subscription for an organization. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "pub_sub_topic": "projects/my-project/topics/my-topic" }' \ "https://cloudsupport.googleapis.com/v2beta/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().create( parent="organizations/123456789", body={ "pub_sub_topic": "projects/my-project/topics/my-topic" }, ) print(request.execute()) ```

+

+ delete(name, x__xgafv=None)

+

Soft deletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request DELETE \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService).supportEventSubscriptions().delete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```

+

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

+

Expunges a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription:expunge" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().expunge( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```

+

+ get(name, x__xgafv=None)

+

Gets a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().get( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```

+

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

+

Lists support event subscriptions. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().list( parent="organizations/123456789" ) print(request.execute()) ```

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "pub_sub_topic": "projects/my-project/topics/new-topic" }' \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription?updateMask=pub_sub_topic" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().patch( name="organizations/123456789/supportEventSubscriptions/abcdef123456", body={ "pub_sub_topic": "projects/my-project/topics/new-topic" }, ) print(request.execute()) ```

+

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

+

Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription:undelete" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().undelete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a support event subscription for an organization. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "pub_sub_topic": "projects/my-project/topics/my-topic" }' \ "https://cloudsupport.googleapis.com/v2beta/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().create( parent="organizations/123456789", body={ "pub_sub_topic": "projects/my-project/topics/my-topic" }, ) print(request.execute()) ```
+
+Args:
+  parent: string, Required. The parent resource name where the support event subscription will be created. Format: organizations/{organization_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Soft deletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request DELETE \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService).supportEventSubscriptions().delete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```
+
+Args:
+  name: string, Required. The name of the support event subscription to delete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+ +
+ expunge(name, body=None, x__xgafv=None) +
Expunges a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription:expunge" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().expunge( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```
+
+Args:
+  name: string, Required. The name of the support event subscription to expunge. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ExpungeSupportEventSubscription.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().get( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```
+
+Args:
+  name: string, Required. The name of the support event subscription to retrieve. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) +
Lists support event subscriptions. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().list( parent="organizations/123456789" ) print(request.execute()) ```
+
+Args:
+  parent: string, Required. The fully qualified name of the Cloud resource to list support event subscriptions under. Format: organizations/{organization_id} (required)
+  filter: string, Optional. Filter expression based on AIP-160. Supported fields: - pub_sub_topic - state Examples: - `pub_sub_topic="projects/example-project/topics/example-topic"` - `state=WORKING` - `pub_sub_topic="projects/example-project/topics/example-topic" AND state=WORKING`
+  pageSize: integer, Optional. The maximum number of support event subscriptions to return.
+  pageToken: string, Optional. A token identifying the page of results to return. If unspecified, the first page is retrieved. When paginating, all other parameters provided to `ListSupportEventSubscriptions` must match the call that provided the page token.
+  showDeleted: boolean, Optional. Whether to show deleted subscriptions. By default, deleted subscriptions are not returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListSupportEventSubscriptions.
+  "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.
+  "supportEventSubscriptions": [ # The support event subscriptions.
+    { # A support event subscription.
+      "createTime": "A String", # Output only. The time at which the subscription was created.
+      "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+      "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+      "name": "A String", # Identifier. The resource name of the support event subscription.
+      "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+      "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+      "state": "A String", # Output only. The state of the subscription.
+      "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "pub_sub_topic": "projects/my-project/topics/new-topic" }' \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription?updateMask=pub_sub_topic" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().patch( name="organizations/123456789/supportEventSubscriptions/abcdef123456", body={ "pub_sub_topic": "projects/my-project/topics/new-topic" }, ) print(request.execute()) ```
+
+Args:
+  name: string, Identifier. The resource name of the support event subscription. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+  updateMask: string, Optional. The list of fields to update. The only supported value is pub_sub_topic.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+ +
+ undelete(name, body=None, x__xgafv=None) +
Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription:undelete" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().undelete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```
+
+Args:
+  name: string, Required. The name of the support event subscription to undelete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for UndeleteSupportEventSubscription.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A support event subscription.
+  "createTime": "A String", # Output only. The time at which the subscription was created.
+  "deleteTime": "A String", # Output only. The time at which the subscription was deleted.
+  "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.
+  "name": "A String", # Identifier. The resource name of the support event subscription.
+  "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
+  "purgeTime": "A String", # Output only. The time at which the subscription will be purged.
+  "state": "A String", # Output only. The state of the subscription.
+  "updateTime": "A String", # Output only. The time at which the subscription was last updated.
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json index ceaf4c4e27..28036ff2ca 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json @@ -601,13 +601,15 @@ } } }, +"organizations": { +"resources": { "supportEventSubscriptions": { "methods": { "create": { "description": "Creates a support event subscription for an organization. EXAMPLES: cURL: ```shell parent=\"organizations/123456789\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header 'Content-Type: application/json' \\ --data '{ \"pub_sub_topic\": \"projects/my-project/topics/my-topic\" }' \\ \"https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().create( parent=\"organizations/123456789\", body={ \"pub_sub_topic\": \"projects/my-project/topics/my-topic\" }, ) print(request.execute()) ```", -"flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions", +"flatPath": "v2/organizations/{organizationsId}/supportEventSubscriptions", "httpMethod": "POST", -"id": "cloudsupport.supportEventSubscriptions.create", +"id": "cloudsupport.organizations.supportEventSubscriptions.create", "parameterOrder": [ "parent" ], @@ -615,7 +617,7 @@ "parent": { "description": "Required. The parent resource name where the support event subscription will be created. Format: organizations/{organization_id}", "location": "path", -"pattern": "^[^/]+/[^/]+$", +"pattern": "^organizations/[^/]+$", "required": true, "type": "string" } @@ -633,9 +635,9 @@ }, "delete": { "description": "Soft deletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request DELETE \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$support_event_subscription\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService).supportEventSubscriptions().delete( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ```", -"flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}", +"flatPath": "v2/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}", "httpMethod": "DELETE", -"id": "cloudsupport.supportEventSubscriptions.delete", +"id": "cloudsupport.organizations.supportEventSubscriptions.delete", "parameterOrder": [ "name" ], @@ -643,7 +645,7 @@ "name": { "description": "Required. The name of the support event subscription to delete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}", "location": "path", -"pattern": "^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$", +"pattern": "^organizations/[^/]+/supportEventSubscriptions/[^/]+$", "required": true, "type": "string" } @@ -657,10 +659,10 @@ ] }, "expunge": { -"description": "Expunges a support event subscription.", -"flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}:expunge", +"description": "Expunges a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$support_event_subscription:expunge\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().expunge( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ```", +"flatPath": "v2/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}:expunge", "httpMethod": "POST", -"id": "cloudsupport.supportEventSubscriptions.expunge", +"id": "cloudsupport.organizations.supportEventSubscriptions.expunge", "parameterOrder": [ "name" ], @@ -668,7 +670,7 @@ "name": { "description": "Required. The name of the support event subscription to expunge. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}", "location": "path", -"pattern": "^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$", +"pattern": "^organizations/[^/]+/supportEventSubscriptions/[^/]+$", "required": true, "type": "string" } @@ -686,9 +688,9 @@ }, "get": { "description": "Gets a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$support_event_subscription\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().get( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ```", -"flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}", +"flatPath": "v2/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}", "httpMethod": "GET", -"id": "cloudsupport.supportEventSubscriptions.get", +"id": "cloudsupport.organizations.supportEventSubscriptions.get", "parameterOrder": [ "name" ], @@ -696,7 +698,7 @@ "name": { "description": "Required. The name of the support event subscription to retrieve. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}", "location": "path", -"pattern": "^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$", +"pattern": "^organizations/[^/]+/supportEventSubscriptions/[^/]+$", "required": true, "type": "string" } @@ -711,9 +713,9 @@ }, "list": { "description": "Lists support event subscriptions. EXAMPLES: cURL: ```shell parent=\"organizations/123456789\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().list( parent=\"organizations/123456789\" ) print(request.execute()) ```", -"flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions", +"flatPath": "v2/organizations/{organizationsId}/supportEventSubscriptions", "httpMethod": "GET", -"id": "cloudsupport.supportEventSubscriptions.list", +"id": "cloudsupport.organizations.supportEventSubscriptions.list", "parameterOrder": [ "parent" ], @@ -737,7 +739,7 @@ "parent": { "description": "Required. The fully qualified name of the Cloud resource to list support event subscriptions under. Format: organizations/{organization_id}", "location": "path", -"pattern": "^[^/]+/[^/]+$", +"pattern": "^organizations/[^/]+$", "required": true, "type": "string" }, @@ -757,9 +759,9 @@ }, "patch": { "description": "Updates a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request PATCH \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header \"Content-Type: application/json\" \\ --data '{ \"pub_sub_topic\": \"projects/my-project/topics/new-topic\" }' \\ \"https://cloudsupport.googleapis.com/v2/$support_event_subscription?updateMask=pub_sub_topic\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().patch( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\", body={ \"pub_sub_topic\": \"projects/my-project/topics/new-topic\" }, ) print(request.execute()) ```", -"flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}", +"flatPath": "v2/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}", "httpMethod": "PATCH", -"id": "cloudsupport.supportEventSubscriptions.patch", +"id": "cloudsupport.organizations.supportEventSubscriptions.patch", "parameterOrder": [ "name" ], @@ -767,7 +769,7 @@ "name": { "description": "Identifier. The resource name of the support event subscription.", "location": "path", -"pattern": "^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$", +"pattern": "^organizations/[^/]+/supportEventSubscriptions/[^/]+$", "required": true, "type": "string" }, @@ -790,10 +792,10 @@ ] }, "undelete": { -"description": "Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$support_event_subscription:undelete\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().undelete( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ``` Undeletes a support event subscription.", -"flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}:undelete", +"description": "Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$support_event_subscription:undelete\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().undelete( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ```", +"flatPath": "v2/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}:undelete", "httpMethod": "POST", -"id": "cloudsupport.supportEventSubscriptions.undelete", +"id": "cloudsupport.organizations.supportEventSubscriptions.undelete", "parameterOrder": [ "name" ], @@ -801,7 +803,7 @@ "name": { "description": "Required. The name of the support event subscription to undelete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}", "location": "path", -"pattern": "^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$", +"pattern": "^organizations/[^/]+/supportEventSubscriptions/[^/]+$", "required": true, "type": "string" } @@ -819,8 +821,10 @@ } } } +} +} }, -"revision": "20260707", +"revision": "20260726", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json index ee236f7ce0..b31ca7273e 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json @@ -668,13 +668,15 @@ } } }, +"organizations": { +"resources": { "supportEventSubscriptions": { "methods": { "create": { "description": "Creates a support event subscription for an organization. EXAMPLES: cURL: ```shell parent=\"organizations/123456789\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header 'Content-Type: application/json' \\ --data '{ \"pub_sub_topic\": \"projects/my-project/topics/my-topic\" }' \\ \"https://cloudsupport.googleapis.com/v2beta/$parent/supportEventSubscriptions\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().create( parent=\"organizations/123456789\", body={ \"pub_sub_topic\": \"projects/my-project/topics/my-topic\" }, ) print(request.execute()) ```", -"flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions", +"flatPath": "v2beta/organizations/{organizationsId}/supportEventSubscriptions", "httpMethod": "POST", -"id": "cloudsupport.supportEventSubscriptions.create", +"id": "cloudsupport.organizations.supportEventSubscriptions.create", "parameterOrder": [ "parent" ], @@ -682,7 +684,7 @@ "parent": { "description": "Required. The parent resource name where the support event subscription will be created. Format: organizations/{organization_id}", "location": "path", -"pattern": "^[^/]+/[^/]+$", +"pattern": "^organizations/[^/]+$", "required": true, "type": "string" } @@ -700,9 +702,9 @@ }, "delete": { "description": "Soft deletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request DELETE \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$support_event_subscription\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService).supportEventSubscriptions().delete( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ```", -"flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions/{supportEventSubscriptionsId}", +"flatPath": "v2beta/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}", "httpMethod": "DELETE", -"id": "cloudsupport.supportEventSubscriptions.delete", +"id": "cloudsupport.organizations.supportEventSubscriptions.delete", "parameterOrder": [ "name" ], @@ -710,7 +712,7 @@ "name": { "description": "Required. The name of the support event subscription to delete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}", "location": "path", -"pattern": "^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$", +"pattern": "^organizations/[^/]+/supportEventSubscriptions/[^/]+$", "required": true, "type": "string" } @@ -724,10 +726,10 @@ ] }, "expunge": { -"description": "Expunges a support event subscription.", -"flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions/{supportEventSubscriptionsId}:expunge", +"description": "Expunges a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$support_event_subscription:expunge\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().expunge( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ```", +"flatPath": "v2beta/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}:expunge", "httpMethod": "POST", -"id": "cloudsupport.supportEventSubscriptions.expunge", +"id": "cloudsupport.organizations.supportEventSubscriptions.expunge", "parameterOrder": [ "name" ], @@ -735,7 +737,7 @@ "name": { "description": "Required. The name of the support event subscription to expunge. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}", "location": "path", -"pattern": "^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$", +"pattern": "^organizations/[^/]+/supportEventSubscriptions/[^/]+$", "required": true, "type": "string" } @@ -753,9 +755,9 @@ }, "get": { "description": "Gets a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$support_event_subscription\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().get( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ```", -"flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions/{supportEventSubscriptionsId}", +"flatPath": "v2beta/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}", "httpMethod": "GET", -"id": "cloudsupport.supportEventSubscriptions.get", +"id": "cloudsupport.organizations.supportEventSubscriptions.get", "parameterOrder": [ "name" ], @@ -763,7 +765,7 @@ "name": { "description": "Required. The name of the support event subscription to retrieve. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}", "location": "path", -"pattern": "^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$", +"pattern": "^organizations/[^/]+/supportEventSubscriptions/[^/]+$", "required": true, "type": "string" } @@ -778,9 +780,9 @@ }, "list": { "description": "Lists support event subscriptions. EXAMPLES: cURL: ```shell parent=\"organizations/123456789\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$parent/supportEventSubscriptions\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().list( parent=\"organizations/123456789\" ) print(request.execute()) ```", -"flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions", +"flatPath": "v2beta/organizations/{organizationsId}/supportEventSubscriptions", "httpMethod": "GET", -"id": "cloudsupport.supportEventSubscriptions.list", +"id": "cloudsupport.organizations.supportEventSubscriptions.list", "parameterOrder": [ "parent" ], @@ -804,7 +806,7 @@ "parent": { "description": "Required. The fully qualified name of the Cloud resource to list support event subscriptions under. Format: organizations/{organization_id}", "location": "path", -"pattern": "^[^/]+/[^/]+$", +"pattern": "^organizations/[^/]+$", "required": true, "type": "string" }, @@ -824,9 +826,9 @@ }, "patch": { "description": "Updates a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request PATCH \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header \"Content-Type: application/json\" \\ --data '{ \"pub_sub_topic\": \"projects/my-project/topics/new-topic\" }' \\ \"https://cloudsupport.googleapis.com/v2beta/$support_event_subscription?updateMask=pub_sub_topic\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().patch( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\", body={ \"pub_sub_topic\": \"projects/my-project/topics/new-topic\" }, ) print(request.execute()) ```", -"flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions/{supportEventSubscriptionsId}", +"flatPath": "v2beta/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}", "httpMethod": "PATCH", -"id": "cloudsupport.supportEventSubscriptions.patch", +"id": "cloudsupport.organizations.supportEventSubscriptions.patch", "parameterOrder": [ "name" ], @@ -834,7 +836,7 @@ "name": { "description": "Identifier. The resource name of the support event subscription.", "location": "path", -"pattern": "^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$", +"pattern": "^organizations/[^/]+/supportEventSubscriptions/[^/]+$", "required": true, "type": "string" }, @@ -857,10 +859,10 @@ ] }, "undelete": { -"description": "Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$support_event_subscription:undelete\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().undelete( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ``` Undeletes a support event subscription.", -"flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions/{supportEventSubscriptionsId}:undelete", +"description": "Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$support_event_subscription:undelete\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().undelete( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ```", +"flatPath": "v2beta/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}:undelete", "httpMethod": "POST", -"id": "cloudsupport.supportEventSubscriptions.undelete", +"id": "cloudsupport.organizations.supportEventSubscriptions.undelete", "parameterOrder": [ "name" ], @@ -868,7 +870,7 @@ "name": { "description": "Required. The name of the support event subscription to undelete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}", "location": "path", -"pattern": "^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$", +"pattern": "^organizations/[^/]+/supportEventSubscriptions/[^/]+$", "required": true, "type": "string" } @@ -886,8 +888,10 @@ } } } +} +} }, -"revision": "20260707", +"revision": "20260726", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { From b6f5f7327328b3708d10ed21bde72268da69cb33 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:00 +0000 Subject: [PATCH 30/84] feat(cloudtasks): update the api #### cloudtasks:v2beta2 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.queues.resources.tasks.methods.batchCreate (Total Keys: 12) - resources.projects.resources.locations.resources.queues.resources.tasks.methods.batchDelete (Total Keys: 12) - schemas.BatchCreateTasksRequest (Total Keys: 5) - schemas.BatchDeleteTasksRequest (Total Keys: 5) - schemas.CreateTaskRequest.properties.parent.type (Total Keys: 1) - schemas.Operation (Total Keys: 9) - schemas.Task.properties.retryConfig.$ref (Total Keys: 1) #### cloudtasks:v2beta3 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.queues.resources.tasks.methods.batchCreate (Total Keys: 12) - resources.projects.resources.locations.resources.queues.resources.tasks.methods.batchDelete (Total Keys: 12) - schemas.BatchCreateTasksRequest (Total Keys: 5) - schemas.BatchDeleteTasksRequest (Total Keys: 5) - schemas.CreateTaskRequest.properties.parent.type (Total Keys: 1) - schemas.Operation (Total Keys: 9) - schemas.Task.properties.retryConfig.$ref (Total Keys: 1) --- ...cloudtasks_v2beta2.projects.locations.html | 5 + ...sks_v2beta2.projects.locations.queues.html | 18 +- ...beta2.projects.locations.queues.tasks.html | 252 ++++++++++++++++++ ...cloudtasks_v2beta3.projects.locations.html | 5 + ...v2beta3.projects.locations.operations.html | 124 +++++++++ ...sks_v2beta3.projects.locations.queues.html | 18 +- ...beta3.projects.locations.queues.tasks.html | 220 +++++++++++++++ .../documents/cloudtasks.v2beta2.json | 168 +++++++++++- .../documents/cloudtasks.v2beta3.json | 168 +++++++++++- 9 files changed, 956 insertions(+), 22 deletions(-) create mode 100644 docs/dyn/cloudtasks_v2beta3.projects.locations.operations.html diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.html index f3b848a2b4..73ca52e164 100644 --- a/docs/dyn/cloudtasks_v2beta2.projects.locations.html +++ b/docs/dyn/cloudtasks_v2beta2.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_v2beta2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html index 63e087ddc4..9970d0376e 100644 --- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html +++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html @@ -182,7 +182,7 @@

Method Details

"maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field is output only for pull queues and always -1, which indicates no limit. No other queue types can have `max_concurrent_tasks` set to -1. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. * This field is output only for pull queues. In addition to the `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of LeaseTasks requests are allowed per pull queue. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -259,7 +259,7 @@

Method Details

"maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field is output only for pull queues and always -1, which indicates no limit. No other queue types can have `max_concurrent_tasks` set to -1. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. * This field is output only for pull queues. In addition to the `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of LeaseTasks requests are allowed per pull queue. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -362,7 +362,7 @@

Method Details

"maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field is output only for pull queues and always -1, which indicates no limit. No other queue types can have `max_concurrent_tasks` set to -1. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. * This field is output only for pull queues. In addition to the `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of LeaseTasks requests are allowed per pull queue. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -496,7 +496,7 @@

Method Details

"maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field is output only for pull queues and always -1, which indicates no limit. No other queue types can have `max_concurrent_tasks` set to -1. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. * This field is output only for pull queues. In addition to the `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of LeaseTasks requests are allowed per pull queue. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -591,7 +591,7 @@

Method Details

"maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field is output only for pull queues and always -1, which indicates no limit. No other queue types can have `max_concurrent_tasks` set to -1. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. * This field is output only for pull queues. In addition to the `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of LeaseTasks requests are allowed per pull queue. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -669,7 +669,7 @@

Method Details

"maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field is output only for pull queues and always -1, which indicates no limit. No other queue types can have `max_concurrent_tasks` set to -1. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. * This field is output only for pull queues. In addition to the `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of LeaseTasks requests are allowed per pull queue. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -759,7 +759,7 @@

Method Details

"maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field is output only for pull queues and always -1, which indicates no limit. No other queue types can have `max_concurrent_tasks` set to -1. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. * This field is output only for pull queues. In addition to the `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of LeaseTasks requests are allowed per pull queue. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -849,7 +849,7 @@

Method Details

"maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field is output only for pull queues and always -1, which indicates no limit. No other queue types can have `max_concurrent_tasks` set to -1. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. * This field is output only for pull queues. In addition to the `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of LeaseTasks requests are allowed per pull queue. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -939,7 +939,7 @@

Method Details

"maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field is output only for pull queues and always -1, which indicates no limit. No other queue types can have `max_concurrent_tasks` set to -1. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. * This field is output only for pull queues. In addition to the `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of LeaseTasks requests are allowed per pull queue. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html index 938d9c1606..5601b0e00b 100644 --- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html +++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html @@ -77,6 +77,12 @@

Instance Methods

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

Acknowledges a pull task. The worker, that is, the entity that leased this task must call this method to indicate that the work associated with the task has finished. The worker must acknowledge a task within the lease_duration or the lease will expire and the task will become available to be leased again. After the task is acknowledged, it will not be returned by a later LeaseTasks, GetTask, or ListTasks.

+

+ batchCreate(parent, body=None, x__xgafv=None)

+

Creates a batch of tasks and adds them to a queue. This call is not atomic. All tasks must be for the same queue. A maximum of 100 tasks can be created in a single batch.

+

+ batchDelete(parent, body=None, x__xgafv=None)

+

Deletes a batch of tasks. This is a non-atomic operation: if deletion fails for some tasks, it can still succeed for others. The metadata field of google.longrunning.Operation contains details of failed deletions. A maximum of 1000 tasks can be deleted in a batch.

buffer(queue, taskId, body=None, x__xgafv=None)

Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. To create the task with a custom ID, use the following format and set TASK_ID to your desired ID: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer To create the task with an automatically generated ID, use the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer.

@@ -136,6 +142,179 @@

Method Details

}
+
+ batchCreate(parent, body=None, x__xgafv=None) +
Creates a batch of tasks and adds them to a queue. This call is not atomic. All tasks must be for the same queue. A maximum of 100 tasks can be created in a single batch.
+
+Args:
+  parent: string, Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for [BatchCreateTasks].
+  "requestId": "A String", # Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side.
+  "requests": [ # Required. The list of requests to create tasks. The queue specified in parent field of each CreateTaskRequest will be the same. This validation happens on the client side as well as in the handler. BatchCreateTasksRequest.parent will also be the same value as the individual CreateTaskRequest.parent . The maximum number of requests is 100.
+    { # Request message for CreateTask.
+      "parent": "A String", # Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist.
+      "responseView": "A String", # The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.
+      "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
+        "appEngineHttpRequest": { # App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_target set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_url Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. # App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.
+          "appEngineRouting": { # App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). # Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
+            "host": "A String", # Output only. The host that the task is sent to. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). The host is constructed as: * `host = [application_domain_name]` `| [service] + '.' + [application_domain_name]` `| [version] + '.' + [application_domain_name]` `| [version_dot_service]+ '.' + [application_domain_name]` `| [instance] + '.' + [application_domain_name]` `| [instance_dot_service] + '.' + [application_domain_name]` `| [instance_dot_version] + '.' + [application_domain_name]` `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` * `application_domain_name` = The domain name of the app, for example .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. * `service =` service * `version =` version * `version_dot_service =` version `+ '.' +` service * `instance =` instance * `instance_dot_service =` instance `+ '.' +` service * `instance_dot_version =` instance `+ '.' +` version * `instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +` service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted.
+            "instance": "A String", # App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+            "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.
+          },
+          "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Tasks will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. If the task has a payload, Cloud Tasks sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explicitly setting `Content-Type` to a particular media type when the task is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * `Host` * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see [request headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation.
+            "a_key": "A String",
+          },
+          "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the App Engine documentation for your runtime on [How Requests are Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
+          "payload": "A String", # Payload. The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod.
+          "relativeUrl": "A String", # The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
+        },
+        "createTime": "A String", # Output only. The time that the task was created. `create_time` will be truncated to the nearest second.
+        "httpRequest": { # HTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task. # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
+          "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
+          "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created 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-Cloud-Tasks"`. * `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.
+            "a_key": "A String",
+          },
+          "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+          "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
+            "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
+            "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
+          },
+          "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
+            "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
+            "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
+          },
+          "url": "A String", # Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt.
+        },
+        "name": "A String", # Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+        "pullMessage": { # The pull message contains data that can be used by the caller of LeaseTasks to process the task. This proto can only be used for tasks in a queue which has pull_target set. # LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set.
+          "payload": "A String", # A data payload consumed by the worker to execute the task.
+          "tag": "A String", # The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks.
+        },
+        "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task.
+          "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0.
+          "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+          "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+          "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+          "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+          "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+        },
+        "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond.
+        "status": { # Status of the task. # Output only. The task status.
+          "attemptDispatchCount": 42, # Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
+          "attemptResponseCount": 42, # Output only. The number of attempts which have received a response. This field is not calculated for pull tasks.
+          "firstAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's first attempt. Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks.
+            "dispatchTime": "A String", # Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond.
+            "responseStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for this attempt. If the task has not been attempted or the task is currently running then the response status is unset.
+              "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+              "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+              "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+            },
+            "responseTime": "A String", # Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond.
+            "scheduleTime": "A String", # Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond.
+          },
+          "lastAttemptStatus": { # The status of a task attempt. # Output only. The status of the task's last attempt. This field is not calculated for pull tasks.
+            "dispatchTime": "A String", # Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond.
+            "responseStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for this attempt. If the task has not been attempted or the task is currently running then the response status is unset.
+              "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+              "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+              "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+            },
+            "responseTime": "A String", # Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond.
+            "scheduleTime": "A String", # Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond.
+          },
+        },
+        "view": "A String", # Output only. The view specifies which subset of the Task has been returned.
+      },
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ batchDelete(parent, body=None, x__xgafv=None) +
Deletes a batch of tasks. This is a non-atomic operation: if deletion fails for some tasks, it can still succeed for others. The metadata field of google.longrunning.Operation contains details of failed deletions. A maximum of 1000 tasks can be deleted in a batch.
+
+Args:
+  parent: string, Required. The queue name. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for deleting a batch of tasks using BatchDeleteTasks.
+  "names": [ # Required. The names of the tasks to delete. A maximum of 1000 tasks can be deleted in a batch. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
+    "A String",
+  ],
+  "requestId": "A String", # Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
buffer(queue, taskId, body=None, x__xgafv=None)
Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. To create the task with a custom ID, use the following format and set TASK_ID to your desired ID: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer To create the task with an automatically generated ID, use the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer.
@@ -204,6 +383,14 @@ 

Method Details

"payload": "A String", # A data payload consumed by the worker to execute the task. "tag": "A String", # The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited. + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond. "status": { # Status of the task. # Output only. The task status. "attemptDispatchCount": 42, # Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. @@ -301,6 +488,14 @@

Method Details

"payload": "A String", # A data payload consumed by the worker to execute the task. "tag": "A String", # The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited. + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond. "status": { # Status of the task. # Output only. The task status. "attemptDispatchCount": 42, # Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. @@ -353,6 +548,7 @@

Method Details

The object takes the form of: { # Request message for CreateTask. + "parent": "A String", # Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. "responseView": "A String", # The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. "appEngineHttpRequest": { # App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_target set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_url Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. # App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set. @@ -391,6 +587,14 @@

Method Details

"payload": "A String", # A data payload consumed by the worker to execute the task. "tag": "A String", # The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited. + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond. "status": { # Status of the task. # Output only. The task status. "attemptDispatchCount": 42, # Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. @@ -473,6 +677,14 @@

Method Details

"payload": "A String", # A data payload consumed by the worker to execute the task. "tag": "A String", # The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited. + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond. "status": { # Status of the task. # Output only. The task status. "attemptDispatchCount": 42, # Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. @@ -584,6 +796,14 @@

Method Details

"payload": "A String", # A data payload consumed by the worker to execute the task. "tag": "A String", # The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited. + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond. "status": { # Status of the task. # Output only. The task status. "attemptDispatchCount": 42, # Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. @@ -684,6 +904,14 @@

Method Details

"payload": "A String", # A data payload consumed by the worker to execute the task. "tag": "A String", # The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited. + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond. "status": { # Status of the task. # Output only. The task status. "attemptDispatchCount": 42, # Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. @@ -784,6 +1012,14 @@

Method Details

"payload": "A String", # A data payload consumed by the worker to execute the task. "tag": "A String", # The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited. + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond. "status": { # Status of the task. # Output only. The task status. "attemptDispatchCount": 42, # Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. @@ -897,6 +1133,14 @@

Method Details

"payload": "A String", # A data payload consumed by the worker to execute the task. "tag": "A String", # The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited. + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond. "status": { # Status of the task. # Output only. The task status. "attemptDispatchCount": 42, # Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. @@ -992,6 +1236,14 @@

Method Details

"payload": "A String", # A data payload consumed by the worker to execute the task. "tag": "A String", # The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, + "retryConfig": { # Retry config. These settings determine how a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # The maximum number of attempts for a task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be > 0. + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited. + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond. "status": { # Status of the task. # Output only. The task status. "attemptDispatchCount": 42, # Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.html index d65b579a10..cdd56969bb 100644 --- a/docs/dyn/cloudtasks_v2beta3.projects.locations.html +++ b/docs/dyn/cloudtasks_v2beta3.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_v2beta3.projects.locations.operations.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.operations.html new file mode 100644 index 0000000000..ce55034c01 --- /dev/null +++ b/docs/dyn/cloudtasks_v2beta3.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_v2beta3.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html index a897ce2a42..ee3b20cad5 100644 --- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html +++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html @@ -180,7 +180,7 @@

Method Details

"maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -258,7 +258,7 @@

Method Details

"maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -362,7 +362,7 @@

Method Details

"maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -497,7 +497,7 @@

Method Details

"maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -593,7 +593,7 @@

Method Details

"maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -672,7 +672,7 @@

Method Details

"maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -763,7 +763,7 @@

Method Details

"maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -854,7 +854,7 @@

Method Details

"maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). @@ -945,7 +945,7 @@

Method Details

"maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, - "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html index f8ddca43f2..0f32672648 100644 --- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html +++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html @@ -74,6 +74,12 @@

Cloud Tasks API . projects . locations . queues . tasks

Instance Methods

+

+ batchCreate(parent, body=None, x__xgafv=None)

+

Creates a batch of tasks and adds them to a queue. This call is not atomic. All tasks must be for the same queue. A maximum of 100 tasks can be created in a single batch.

+

+ batchDelete(parent, body=None, x__xgafv=None)

+

Deletes a batch of tasks. This is a non-atomic operation: if deletion fails for some tasks, it can still succeed for others. The metadata field of google.longrunning.Operation contains details of failed deletions. A maximum of 1000 tasks can be deleted in a batch.

buffer(queue, taskId, body=None, x__xgafv=None)

Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. To create the task with a custom ID, use the following format and set TASK_ID to your desired ID: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer To create the task with an automatically generated ID, use the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer.

@@ -99,6 +105,177 @@

Instance Methods

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

Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed.

Method Details

+
+ batchCreate(parent, body=None, x__xgafv=None) +
Creates a batch of tasks and adds them to a queue. This call is not atomic. All tasks must be for the same queue. A maximum of 100 tasks can be created in a single batch.
+
+Args:
+  parent: string, Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for [BatchCreateTasks].
+  "requestId": "A String", # Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side.
+  "requests": [ # Required. The list of requests to create tasks. The queue specified in parent field of each CreateTaskRequest will be the same. This validation happens on the client side as well as in the handler. BatchCreateTasksRequest.parent will also be the same value as the individual CreateTaskRequest.parent . The maximum number of requests is 100.
+    { # Request message for CreateTask.
+      "parent": "A String", # Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist.
+      "responseView": "A String", # The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.
+      "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
+        "appEngineHttpRequest": { # App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. # HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
+          "appEngineRouting": { # App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). # Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
+            "host": "A String", # Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+            "instance": "A String", # App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+            "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.
+          },
+          "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible HttpMethod.
+          "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Tasks will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. If the task has a body, Cloud Tasks sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explicitly setting `Content-Type` to a particular media type when the task is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * `Host` * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see [request headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers). These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation.
+            "a_key": "A String",
+          },
+          "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the App Engine documentation for your runtime on [How Requests are Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
+          "relativeUri": "A String", # The relative URI. The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
+        },
+        "createTime": "A String", # Output only. The time that the task was created. `create_time` will be truncated to the nearest second.
+        "dispatchCount": 42, # Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
+        "dispatchDeadline": "A String", # The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an approximate deadline.
+        "firstAttempt": { # The status of a task attempt. # Output only. The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.
+          "dispatchTime": "A String", # Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond.
+          "responseStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the worker for this attempt. If `response_time` is unset, then the task has not been attempted or is currently running and the `response_status` field is meaningless.
+            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+          },
+          "responseTime": "A String", # Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond.
+          "scheduleTime": "A String", # Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond.
+        },
+        "httpRequest": { # HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([`200` - `299`]), the task will be removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User-specified throttling: retry configuration, rate limits, and the queue's state. * System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the `Retry-After` HTTP response header is considered. * To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time). # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
+          "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
+          "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when the 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 Cloud Tasks. * 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-Cloud-Tasks"`. * `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.
+            "a_key": "A String",
+          },
+          "httpMethod": "A String", # The HTTP method to use for the request. The default is POST.
+          "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
+            "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
+            "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
+          },
+          "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
+            "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
+            "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
+          },
+          "url": "A String", # Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt.
+        },
+        "lastAttempt": { # The status of a task attempt. # Output only. The status of the task's last attempt.
+          "dispatchTime": "A String", # Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond.
+          "responseStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the worker for this attempt. If `response_time` is unset, then the task has not been attempted or is currently running and the `response_status` field is meaningless.
+            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+          },
+          "responseTime": "A String", # Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond.
+          "scheduleTime": "A String", # Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond.
+        },
+        "name": "A String", # Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+        "pullMessage": { # Pull Message. This proto can only be used for tasks in a queue which has PULL type. It currently exists for backwards compatibility with the App Engine Task Queue SDK. This message type maybe returned with methods list and get, when the response view is FULL. # Pull Message contained in a task in a PULL queue type. This payload type cannot be explicitly set through Cloud Tasks API. Its purpose, currently is to provide backward compatibility with App Engine Task Queue [pull](https://cloud.google.com/appengine/docs/standard/java/taskqueue/pull/) queues to provide a way to inspect contents of pull tasks through the CloudTasks.GetTask.
+          "payload": "A String", # A data payload consumed by the worker to execute the task.
+          "tag": "A String", # The tasks's tag. The tag is less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks.
+        },
+        "responseCount": 42, # Output only. The number of attempts which have received a response.
+        "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task.
+          "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+          "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+          "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+          "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+          "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+        },
+        "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond.
+        "view": "A String", # Output only. The view specifies which subset of the Task has been returned.
+      },
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ batchDelete(parent, body=None, x__xgafv=None) +
Deletes a batch of tasks. This is a non-atomic operation: if deletion fails for some tasks, it can still succeed for others. The metadata field of google.longrunning.Operation contains details of failed deletions. A maximum of 1000 tasks can be deleted in a batch.
+
+Args:
+  parent: string, Required. The queue name. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for deleting a batch of tasks using BatchDeleteTasks.
+  "names": [ # Required. The names of the tasks to delete. A maximum of 1000 tasks can be deleted in a batch. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
+    "A String",
+  ],
+  "requestId": "A String", # Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
buffer(queue, taskId, body=None, x__xgafv=None)
Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. To create the task with a custom ID, use the following format and set TASK_ID to your desired ID: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer To create the task with an automatically generated ID, use the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer.
@@ -198,6 +375,13 @@ 

Method Details

"tag": "A String", # The tasks's tag. The tag is less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, "responseCount": 42, # Output only. The number of attempts which have received a response. + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. "view": "A String", # Output only. The view specifies which subset of the Task has been returned. }, @@ -219,6 +403,7 @@

Method Details

The object takes the form of: { # Request message for CreateTask. + "parent": "A String", # Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. "responseView": "A String", # The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. "appEngineHttpRequest": { # App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. # HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set. @@ -288,6 +473,13 @@

Method Details

"tag": "A String", # The tasks's tag. The tag is less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, "responseCount": 42, # Output only. The number of attempts which have received a response. + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. "view": "A String", # Output only. The view specifies which subset of the Task has been returned. }, @@ -369,6 +561,13 @@

Method Details

"tag": "A String", # The tasks's tag. The tag is less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, "responseCount": 42, # Output only. The number of attempts which have received a response. + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. "view": "A String", # Output only. The view specifies which subset of the Task has been returned. }
@@ -479,6 +678,13 @@

Method Details

"tag": "A String", # The tasks's tag. The tag is less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, "responseCount": 42, # Output only. The number of attempts which have received a response. + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. "view": "A String", # Output only. The view specifies which subset of the Task has been returned. }
@@ -576,6 +782,13 @@

Method Details

"tag": "A String", # The tasks's tag. The tag is less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, "responseCount": 42, # Output only. The number of attempts which have received a response. + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. "view": "A String", # Output only. The view specifies which subset of the Task has been returned. }, @@ -686,6 +899,13 @@

Method Details

"tag": "A String", # The tasks's tag. The tag is less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks. }, "responseCount": 42, # Output only. The number of attempts which have received a response. + "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + }, "scheduleTime": "A String", # The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. "view": "A String", # Output only. The view specifies which subset of the Task has been returned. }
diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json index cf27650443..deeac74b9b 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json @@ -274,6 +274,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": "v2beta2/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": "v2beta2/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "queues": { "methods": { "create": { @@ -641,6 +670,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"batchCreate": { +"description": "Creates a batch of tasks and adds them to a queue. This call is not atomic. All tasks must be for the same queue. A maximum of 100 tasks can be created in a single batch.", +"flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:batchCreate", +"httpMethod": "POST", +"id": "cloudtasks.projects.locations.queues.tasks.batchCreate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta2/{+parent}/tasks:batchCreate", +"request": { +"$ref": "BatchCreateTasksRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"batchDelete": { +"description": "Deletes a batch of tasks. This is a non-atomic operation: if deletion fails for some tasks, it can still succeed for others. The metadata field of google.longrunning.Operation contains details of failed deletions. A maximum of 1000 tasks can be deleted in a batch.", +"flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:batchDelete", +"httpMethod": "POST", +"id": "cloudtasks.projects.locations.queues.tasks.batchDelete", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The queue name. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta2/{+parent}/tasks:batchDelete", +"request": { +"$ref": "BatchDeleteTasksRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "buffer": { "description": "Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. To create the task with a custom ID, use the following format and set TASK_ID to your desired ID: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer To create the task with an automatically generated ID, use the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer.", "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{taskId}:buffer", @@ -941,7 +1026,7 @@ } } }, -"revision": "20260609", +"revision": "20260722", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AcknowledgeTaskRequest": { @@ -1067,6 +1152,42 @@ }, "type": "object" }, +"BatchCreateTasksRequest": { +"description": "Request message for [BatchCreateTasks].", +"id": "BatchCreateTasksRequest", +"properties": { +"requestId": { +"description": "Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side.", +"type": "string" +}, +"requests": { +"description": "Required. The list of requests to create tasks. The queue specified in parent field of each CreateTaskRequest will be the same. This validation happens on the client side as well as in the handler. BatchCreateTasksRequest.parent will also be the same value as the individual CreateTaskRequest.parent . The maximum number of requests is 100.", +"items": { +"$ref": "CreateTaskRequest" +}, +"type": "array" +} +}, +"type": "object" +}, +"BatchDeleteTasksRequest": { +"description": "Request message for deleting a batch of tasks using BatchDeleteTasks.", +"id": "BatchDeleteTasksRequest", +"properties": { +"names": { +"description": "Required. The names of the tasks to delete. A maximum of 1000 tasks can be deleted in a batch. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`", +"items": { +"type": "string" +}, +"type": "array" +}, +"requestId": { +"description": "Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side.", +"type": "string" +} +}, +"type": "object" +}, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -1157,6 +1278,10 @@ "description": "Request message for CreateTask.", "id": "CreateTaskRequest", "properties": { +"parent": { +"description": "Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist.", +"type": "string" +}, "responseView": { "description": "The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.", "enum": [ @@ -1555,6 +1680,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", @@ -1666,7 +1826,7 @@ }, "retryConfig": { "$ref": "RetryConfig", -"description": "Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks)." +"description": "Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks)." }, "state": { "description": "Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.", @@ -1918,6 +2078,10 @@ "$ref": "PullMessage", "description": "LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set." }, +"retryConfig": { +"$ref": "RetryConfig", +"description": "Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task." +}, "scheduleTime": { "description": "The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json index 5eaef62cf8..71529d8961 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.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": "v2beta3/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": "v2beta3/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "queues": { "methods": { "create": { @@ -581,6 +610,62 @@ "resources": { "tasks": { "methods": { +"batchCreate": { +"description": "Creates a batch of tasks and adds them to a queue. This call is not atomic. All tasks must be for the same queue. A maximum of 100 tasks can be created in a single batch.", +"flatPath": "v2beta3/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:batchCreate", +"httpMethod": "POST", +"id": "cloudtasks.projects.locations.queues.tasks.batchCreate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta3/{+parent}/tasks:batchCreate", +"request": { +"$ref": "BatchCreateTasksRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"batchDelete": { +"description": "Deletes a batch of tasks. This is a non-atomic operation: if deletion fails for some tasks, it can still succeed for others. The metadata field of google.longrunning.Operation contains details of failed deletions. A maximum of 1000 tasks can be deleted in a batch.", +"flatPath": "v2beta3/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:batchDelete", +"httpMethod": "POST", +"id": "cloudtasks.projects.locations.queues.tasks.batchDelete", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The queue name. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta3/{+parent}/tasks:batchDelete", +"request": { +"$ref": "BatchDeleteTasksRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "buffer": { "description": "Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. To create the task with a custom ID, use the following format and set TASK_ID to your desired ID: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer To create the task with an automatically generated ID, use the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer.", "flatPath": "v2beta3/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{taskId}:buffer", @@ -797,7 +882,7 @@ } } }, -"revision": "20260609", +"revision": "20260722", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { @@ -911,6 +996,42 @@ }, "type": "object" }, +"BatchCreateTasksRequest": { +"description": "Request message for [BatchCreateTasks].", +"id": "BatchCreateTasksRequest", +"properties": { +"requestId": { +"description": "Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side.", +"type": "string" +}, +"requests": { +"description": "Required. The list of requests to create tasks. The queue specified in parent field of each CreateTaskRequest will be the same. This validation happens on the client side as well as in the handler. BatchCreateTasksRequest.parent will also be the same value as the individual CreateTaskRequest.parent . The maximum number of requests is 100.", +"items": { +"$ref": "CreateTaskRequest" +}, +"type": "array" +} +}, +"type": "object" +}, +"BatchDeleteTasksRequest": { +"description": "Request message for deleting a batch of tasks using BatchDeleteTasks.", +"id": "BatchDeleteTasksRequest", +"properties": { +"names": { +"description": "Required. The names of the tasks to delete. A maximum of 1000 tasks can be deleted in a batch. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`", +"items": { +"type": "string" +}, +"type": "array" +}, +"requestId": { +"description": "Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side.", +"type": "string" +} +}, +"type": "object" +}, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -975,6 +1096,10 @@ "description": "Request message for CreateTask.", "id": "CreateTaskRequest", "properties": { +"parent": { +"description": "Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist.", +"type": "string" +}, "responseView": { "description": "The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.", "enum": [ @@ -1324,6 +1449,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", @@ -1425,7 +1585,7 @@ }, "retryConfig": { "$ref": "RetryConfig", -"description": "Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks)." +"description": "Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks)." }, "stackdriverLoggingConfig": { "$ref": "StackdriverLoggingConfig", @@ -1695,6 +1855,10 @@ "format": "int32", "type": "integer" }, +"retryConfig": { +"$ref": "RetryConfig", +"description": "Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task." +}, "scheduleTime": { "description": "The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond.", "format": "google-datetime", From c8de4499e8ade364a9741c4d0d5e0fc3c0741db9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:02 +0000 Subject: [PATCH 31/84] feat(compute): update the api #### compute:alpha The following keys were deleted: - schemas.StoragePool.properties.exapoolProvisionedCapacityGb.readOnly (Total Keys: 1) The following keys were added: - endpoints (Total Keys: 1) - resources.advice.methods.calendarModeExtension (Total Keys: 16) - resources.interconnects.methods.setName (Total Keys: 18) - resources.managedRulesets.methods.get (Total Keys: 15) - resources.managedRulesets.methods.list (Total Keys: 24) - resources.reservationConsumedInstances.methods.list (Total Keys: 32) - schemas.CalendarModeExtensionAdviceRequest (Total Keys: 5) - schemas.CalendarModeExtensionAdviceResponse (Total Keys: 10) - schemas.CustomerEncryptionKey.properties.rawKey.deprecated (Total Keys: 1) - schemas.CustomerEncryptionKey.properties.rsaEncryptedKey.deprecated (Total Keys: 1) - schemas.CustomerEncryptionKey.properties.sha256.deprecated (Total Keys: 1) - schemas.FirewallPolicyRuleOperationMetadata (Total Keys: 5) - schemas.GlobalVmExtensionPolicyExtensionPolicy.properties.installedSoftwareSelector.$ref (Total Keys: 1) - schemas.GlobalVmExtensionPolicyInstalledSoftwareSelector (Total Keys: 8) - schemas.InstanceGroupManagerUpdatePolicy.properties.disruptionMode.deprecated (Total Keys: 1) - schemas.InstanceGroupManagersApplyUpdatesRequest.properties.disruptionMode.deprecated (Total Keys: 1) - schemas.InstancePropertiesPatch.properties.exposeHostTopology.type (Total Keys: 1) - schemas.InterconnectsSetNameRequest (Total Keys: 4) - schemas.ManagedRuleset (Total Keys: 31) - schemas.NetworkPolicyTrafficClassificationRuleMatcher.properties.destAddressGroups (Total Keys: 2) - schemas.Operation.properties.firewallPolicyRuleOperationMetadata (Total Keys: 2) - schemas.RegionInstanceGroupManagersApplyUpdatesRequest.properties.disruptionMode.deprecated (Total Keys: 1) - schemas.ReservationConsumedInstance (Total Keys: 36) - schemas.ResourceStatusPhysicalHostTopologyAdditionalAttributes.properties.networkTopologyIds (Total Keys: 3) - schemas.Scheduling.properties.exposeHostTopology.type (Total Keys: 1) - schemas.VmExtensionPolicyExtensionPolicy.properties.installedSoftwareSelector.$ref (Total Keys: 1) - schemas.VmExtensionPolicyInstalledSoftwareSelector (Total Keys: 8) The following keys were changed: - schemas.HostsListResponse.properties.kind.default (Total Keys: 1) #### compute:beta The following keys were deleted: - schemas.StoragePool.properties.exapoolProvisionedCapacityGb.readOnly (Total Keys: 1) The following keys were added: - endpoints (Total Keys: 1) - schemas.CustomerEncryptionKey.properties.rawKey.deprecated (Total Keys: 1) - schemas.CustomerEncryptionKey.properties.rsaEncryptedKey.deprecated (Total Keys: 1) - schemas.CustomerEncryptionKey.properties.sha256.deprecated (Total Keys: 1) - schemas.PublicAdvertisedPrefix.properties.networkTier.type (Total Keys: 1) - schemas.PublicDelegatedPrefix.properties.networkTier.type (Total Keys: 1) - schemas.ResourceStatusPhysicalHostTopologyAdditionalAttributes.properties.networkTopologyIds (Total Keys: 3) - schemas.ResourceStatusScheduling.properties.gracefulShutdownTimestamp (Total Keys: 2) - schemas.RouterStatusBgpPeerStatus.properties.depreferenced (Total Keys: 2) - schemas.StoragePool.properties.shareSettings.$ref (Total Keys: 1) - schemas.StoragePoolShareSettings (Total Keys: 7) The following keys were changed: - schemas.HostsListResponse.properties.kind.default (Total Keys: 1) #### compute:v1 The following keys were deleted: - schemas.StoragePool.properties.exapoolProvisionedCapacityGb.readOnly (Total Keys: 1) The following keys were added: - endpoints (Total Keys: 1) - resources.hosts.methods.get (Total Keys: 41) - resources.hosts.methods.list (Total Keys: 29) - resources.instances.methods.delete.parameters.noGracefulShutdown (Total Keys: 2) - resources.instances.methods.stop.parameters.noGracefulShutdown (Total Keys: 2) - resources.reliabilityRisks.methods.get (Total Keys: 15) - resources.reliabilityRisks.methods.list (Total Keys: 24) - schemas.CustomerEncryptionKey.properties.rawKey.deprecated (Total Keys: 1) - schemas.CustomerEncryptionKey.properties.rsaEncryptedKey.deprecated (Total Keys: 1) - schemas.CustomerEncryptionKey.properties.sha256.deprecated (Total Keys: 1) - schemas.Host (Total Keys: 60) - schemas.ReliabilityRisk (Total Keys: 35) - schemas.ResourceStatus.properties.shutdownDetails (Total Keys: 2) - schemas.ResourceStatusReservationConsumptionInfo.properties.consumedReservationBlock (Total Keys: 2) - schemas.ResourceStatusReservationConsumptionInfo.properties.consumedReservationSubBlock (Total Keys: 2) - schemas.ResourceStatusScheduling.properties.gracefulShutdownTimestamp (Total Keys: 2) - schemas.ResourceStatusScheduling.properties.terminationTimestamp.type (Total Keys: 1) - schemas.ResourceStatusShutdownDetails (Total Keys: 6) - schemas.RiskDetails (Total Keys: 18) - schemas.RiskRecommendation (Total Keys: 3) - schemas.Scheduling.properties.gracefulShutdown.$ref (Total Keys: 1) - schemas.Scheduling.properties.preemptionNoticeDuration.$ref (Total Keys: 1) - schemas.SchedulingGracefulShutdown (Total Keys: 4) - schemas.StoragePool.properties.shareSettings.$ref (Total Keys: 1) - schemas.StoragePoolShareSettings (Total Keys: 7) --- ...mpute_alpha.acceleratorPodControllers.html | 76 +- docs/dyn/compute_alpha.addresses.html | 128 +- docs/dyn/compute_alpha.advice.html | 54 + docs/dyn/compute_alpha.autoscalers.html | 80 +- docs/dyn/compute_alpha.backendBuckets.html | 140 +- docs/dyn/compute_alpha.backendServices.html | 202 +- docs/dyn/compute_alpha.crossSiteNetworks.html | 60 +- .../dyn/compute_alpha.dhcpOptionsConfigs.html | 60 +- docs/dyn/compute_alpha.diskSettings.html | 20 +- docs/dyn/compute_alpha.disks.html | 527 +++-- .../compute_alpha.externalVpnGateways.html | 60 +- docs/dyn/compute_alpha.firewallPolicies.html | 280 ++- docs/dyn/compute_alpha.firewalls.html | 80 +- ...alpha.folderGlobalVmExtensionPolicies.html | 130 +- ...e_alpha.folderZoneVmExtensionPolicies.html | 116 +- docs/dyn/compute_alpha.forwardingRules.html | 100 +- .../dyn/compute_alpha.futureReservations.html | 80 +- docs/dyn/compute_alpha.globalAddresses.html | 116 +- .../compute_alpha.globalFolderOperations.html | 40 +- .../compute_alpha.globalForwardingRules.html | 100 +- ...ute_alpha.globalNetworkEndpointGroups.html | 80 +- docs/dyn/compute_alpha.globalOperations.html | 80 +- ...te_alpha.globalOrganizationOperations.html | 40 +- ...e_alpha.globalPublicDelegatedPrefixes.html | 60 +- ...mpute_alpha.globalVmExtensionPolicies.html | 130 +- docs/dyn/compute_alpha.haControllers.html | 290 +-- docs/dyn/compute_alpha.healthChecks.html | 122 +- docs/dyn/compute_alpha.hosts.html | 22 +- docs/dyn/compute_alpha.html | 10 + docs/dyn/compute_alpha.httpHealthChecks.html | 80 +- docs/dyn/compute_alpha.httpsHealthChecks.html | 80 +- docs/dyn/compute_alpha.imageFamilyViews.html | 36 +- docs/dyn/compute_alpha.imageViews.html | 72 +- docs/dyn/compute_alpha.images.html | 280 ++- ...ha.instanceGroupManagerResizeRequests.html | 144 +- .../compute_alpha.instanceGroupManagers.html | 1659 ++++++++++++---- docs/dyn/compute_alpha.instanceGroups.html | 100 +- docs/dyn/compute_alpha.instanceSettings.html | 20 +- docs/dyn/compute_alpha.instanceTemplates.html | 364 +++- docs/dyn/compute_alpha.instances.html | 1615 ++++++++++++---- .../compute_alpha.instantSnapshotGroups.html | 40 +- docs/dyn/compute_alpha.instantSnapshots.html | 60 +- ...te_alpha.interconnectAttachmentGroups.html | 80 +- ...compute_alpha.interconnectAttachments.html | 80 +- .../dyn/compute_alpha.interconnectGroups.html | 80 +- docs/dyn/compute_alpha.interconnects.html | 394 +++- docs/dyn/compute_alpha.licenses.html | 60 +- docs/dyn/compute_alpha.machineImages.html | 411 +++- docs/dyn/compute_alpha.managedRulesets.html | 308 +++ .../dyn/compute_alpha.networkAttachments.html | 60 +- ...ute_alpha.networkEdgeSecurityServices.html | 60 +- .../compute_alpha.networkEndpointGroups.html | 80 +- ...compute_alpha.networkFirewallPolicies.html | 260 ++- docs/dyn/compute_alpha.networks.html | 180 +- docs/dyn/compute_alpha.nodeGroups.html | 160 +- docs/dyn/compute_alpha.nodeTemplates.html | 40 +- .../compute_alpha.orgVmExtensionPolicies.html | 20 +- ...organizationGlobalVmExtensionPolicies.html | 130 +- ...ompute_alpha.organizationRolloutPlans.html | 40 +- .../compute_alpha.organizationRollouts.html | 100 +- ...te_alpha.organizationSecurityPolicies.html | 200 +- ....organizationSnapshotRecycleBinPolicy.html | 20 +- ...a.organizationZoneVmExtensionPolicies.html | 96 +- docs/dyn/compute_alpha.packetMirrorings.html | 60 +- docs/dyn/compute_alpha.previewFeatures.html | 20 +- docs/dyn/compute_alpha.projectViews.html | 11 + docs/dyn/compute_alpha.projects.html | 240 ++- ...ompute_alpha.publicAdvertisedPrefixes.html | 100 +- ...compute_alpha.publicDelegatedPrefixes.html | 100 +- .../compute_alpha.recoverableSnapshots.html | 121 +- docs/dyn/compute_alpha.regionAutoscalers.html | 80 +- .../compute_alpha.regionBackendBuckets.html | 60 +- .../compute_alpha.regionBackendServices.html | 136 +- docs/dyn/compute_alpha.regionCommitments.html | 100 +- ...ute_alpha.regionCompositeHealthChecks.html | 60 +- .../dyn/compute_alpha.regionDiskSettings.html | 20 +- docs/dyn/compute_alpha.regionDisks.html | 451 +++-- ...alpha.regionHealthAggregationPolicies.html | 60 +- ...mpute_alpha.regionHealthCheckServices.html | 60 +- .../dyn/compute_alpha.regionHealthChecks.html | 115 +- .../compute_alpha.regionHealthSources.html | 60 +- ...ionInstanceGroupManagerResizeRequests.html | 144 +- ...ute_alpha.regionInstanceGroupManagers.html | 1465 +++++++++++--- .../compute_alpha.regionInstanceGroups.html | 20 +- ...compute_alpha.regionInstanceTemplates.html | 283 ++- docs/dyn/compute_alpha.regionInstances.html | 173 +- ...ute_alpha.regionInstantSnapshotGroups.html | 40 +- .../compute_alpha.regionInstantSnapshots.html | 60 +- docs/dyn/compute_alpha.regionMultiMigs.html | 82 +- ...ute_alpha.regionNetworkEndpointGroups.html | 80 +- ...e_alpha.regionNetworkFirewallPolicies.html | 200 +- .../compute_alpha.regionNetworkPolicies.html | 208 +- ...ute_alpha.regionNotificationEndpoints.html | 40 +- docs/dyn/compute_alpha.regionOperations.html | 60 +- ...pute_alpha.regionRecoverableSnapshots.html | 94 +- .../compute_alpha.regionSecurityPolicies.html | 140 +- .../compute_alpha.regionSnapshotSettings.html | 20 +- docs/dyn/compute_alpha.regionSnapshots.html | 161 +- .../compute_alpha.regionSslCertificates.html | 40 +- docs/dyn/compute_alpha.regionSslPolicies.html | 60 +- ...compute_alpha.regionTargetHttpProxies.html | 60 +- ...ompute_alpha.regionTargetHttpsProxies.html | 100 +- .../compute_alpha.regionTargetTcpProxies.html | 40 +- docs/dyn/compute_alpha.regionUrlMaps.html | 100 +- docs/dyn/compute_alpha.reliabilityRisks.html | 2 +- docs/dyn/compute_alpha.reservationBlocks.html | 20 +- ...te_alpha.reservationConsumedInstances.html | 347 ++++ docs/dyn/compute_alpha.reservationSlots.html | 40 +- .../compute_alpha.reservationSubBlocks.html | 80 +- docs/dyn/compute_alpha.reservations.html | 100 +- docs/dyn/compute_alpha.resourcePolicies.html | 60 +- docs/dyn/compute_alpha.rolloutPlans.html | 40 +- docs/dyn/compute_alpha.rollouts.html | 100 +- docs/dyn/compute_alpha.routers.html | 200 +- docs/dyn/compute_alpha.routes.html | 40 +- docs/dyn/compute_alpha.securityPolicies.html | 140 +- .../dyn/compute_alpha.serviceAttachments.html | 60 +- docs/dyn/compute_alpha.snapshotGroups.html | 40 +- ...ompute_alpha.snapshotRecycleBinPolicy.html | 20 +- docs/dyn/compute_alpha.snapshotSettings.html | 20 +- docs/dyn/compute_alpha.snapshots.html | 188 +- docs/dyn/compute_alpha.sslCertificates.html | 40 +- docs/dyn/compute_alpha.sslPolicies.html | 60 +- docs/dyn/compute_alpha.storagePools.html | 90 +- docs/dyn/compute_alpha.subnetworks.html | 100 +- docs/dyn/compute_alpha.targetGrpcProxies.html | 60 +- docs/dyn/compute_alpha.targetHttpProxies.html | 80 +- .../dyn/compute_alpha.targetHttpsProxies.html | 160 +- docs/dyn/compute_alpha.targetInstances.html | 60 +- docs/dyn/compute_alpha.targetPools.html | 160 +- docs/dyn/compute_alpha.targetSslProxies.html | 140 +- docs/dyn/compute_alpha.targetTcpProxies.html | 80 +- docs/dyn/compute_alpha.targetVpnGateways.html | 60 +- docs/dyn/compute_alpha.urlMaps.html | 100 +- docs/dyn/compute_alpha.vpnGateways.html | 60 +- docs/dyn/compute_alpha.vpnTunnels.html | 60 +- docs/dyn/compute_alpha.wireGroups.html | 60 +- .../compute_alpha.zoneFolderOperations.html | 40 +- docs/dyn/compute_alpha.zoneOperations.html | 60 +- ...pute_alpha.zoneOrganizationOperations.html | 40 +- .../compute_alpha.zoneQueuedResources.html | 728 +++++-- ...compute_alpha.zoneVmExtensionPolicies.html | 116 +- docs/dyn/compute_beta.addresses.html | 104 +- docs/dyn/compute_beta.autoscalers.html | 56 +- docs/dyn/compute_beta.backendBuckets.html | 98 +- docs/dyn/compute_beta.backendServices.html | 154 +- docs/dyn/compute_beta.crossSiteNetworks.html | 42 +- docs/dyn/compute_beta.diskSettings.html | 14 +- docs/dyn/compute_beta.disks.html | 403 ++-- .../dyn/compute_beta.externalVpnGateways.html | 42 +- docs/dyn/compute_beta.firewallPolicies.html | 182 +- docs/dyn/compute_beta.firewalls.html | 56 +- docs/dyn/compute_beta.forwardingRules.html | 70 +- docs/dyn/compute_beta.futureReservations.html | 56 +- docs/dyn/compute_beta.globalAddresses.html | 92 +- .../compute_beta.globalForwardingRules.html | 70 +- ...pute_beta.globalNetworkEndpointGroups.html | 56 +- docs/dyn/compute_beta.globalOperations.html | 56 +- ...ute_beta.globalOrganizationOperations.html | 28 +- ...te_beta.globalPublicDelegatedPrefixes.html | 54 +- ...ompute_beta.globalVmExtensionPolicies.html | 42 +- docs/dyn/compute_beta.healthChecks.html | 98 +- docs/dyn/compute_beta.hosts.html | 16 +- docs/dyn/compute_beta.httpHealthChecks.html | 56 +- docs/dyn/compute_beta.httpsHealthChecks.html | 56 +- docs/dyn/compute_beta.imageFamilyViews.html | 36 +- docs/dyn/compute_beta.imageViews.html | 36 +- docs/dyn/compute_beta.images.html | 250 ++- ...ta.instanceGroupManagerResizeRequests.html | 126 +- .../compute_beta.instanceGroupManagers.html | 1017 +++++++--- docs/dyn/compute_beta.instanceGroups.html | 70 +- docs/dyn/compute_beta.instanceSettings.html | 14 +- docs/dyn/compute_beta.instanceTemplates.html | 344 +++- docs/dyn/compute_beta.instances.html | 1356 +++++++++---- .../compute_beta.instantSnapshotGroups.html | 28 +- docs/dyn/compute_beta.instantSnapshots.html | 42 +- ...ute_beta.interconnectAttachmentGroups.html | 42 +- .../compute_beta.interconnectAttachments.html | 56 +- docs/dyn/compute_beta.interconnectGroups.html | 56 +- docs/dyn/compute_beta.interconnects.html | 56 +- docs/dyn/compute_beta.licenses.html | 42 +- docs/dyn/compute_beta.machineImages.html | 381 +++- docs/dyn/compute_beta.networkAttachments.html | 42 +- ...pute_beta.networkEdgeSecurityServices.html | 42 +- .../compute_beta.networkEndpointGroups.html | 56 +- .../compute_beta.networkFirewallPolicies.html | 168 +- docs/dyn/compute_beta.networks.html | 126 +- docs/dyn/compute_beta.nodeGroups.html | 112 +- docs/dyn/compute_beta.nodeTemplates.html | 28 +- ...compute_beta.organizationRolloutPlans.html | 28 +- .../compute_beta.organizationRollouts.html | 70 +- ...ute_beta.organizationSecurityPolicies.html | 140 +- docs/dyn/compute_beta.packetMirrorings.html | 42 +- docs/dyn/compute_beta.previewFeatures.html | 14 +- docs/dyn/compute_beta.projectViews.html | 11 + docs/dyn/compute_beta.projects.html | 154 +- ...compute_beta.publicAdvertisedPrefixes.html | 82 +- .../compute_beta.publicDelegatedPrefixes.html | 85 +- docs/dyn/compute_beta.regionAutoscalers.html | 56 +- .../compute_beta.regionBackendBuckets.html | 42 +- .../compute_beta.regionBackendServices.html | 106 +- docs/dyn/compute_beta.regionCommitments.html | 42 +- ...pute_beta.regionCompositeHealthChecks.html | 42 +- docs/dyn/compute_beta.regionDiskSettings.html | 14 +- docs/dyn/compute_beta.regionDisks.html | 353 ++-- ..._beta.regionHealthAggregationPolicies.html | 42 +- ...ompute_beta.regionHealthCheckServices.html | 42 +- docs/dyn/compute_beta.regionHealthChecks.html | 91 +- .../dyn/compute_beta.regionHealthSources.html | 42 +- ...ionInstanceGroupManagerResizeRequests.html | 126 +- ...pute_beta.regionInstanceGroupManagers.html | 896 ++++++--- .../compute_beta.regionInstanceGroups.html | 14 +- .../compute_beta.regionInstanceTemplates.html | 265 ++- docs/dyn/compute_beta.regionInstances.html | 165 +- ...pute_beta.regionInstantSnapshotGroups.html | 28 +- .../compute_beta.regionInstantSnapshots.html | 42 +- docs/dyn/compute_beta.regionMultiMigs.html | 70 +- ...pute_beta.regionNetworkEndpointGroups.html | 56 +- ...te_beta.regionNetworkFirewallPolicies.html | 140 +- .../compute_beta.regionNetworkPolicies.html | 112 +- ...pute_beta.regionNotificationEndpoints.html | 28 +- docs/dyn/compute_beta.regionOperations.html | 42 +- .../compute_beta.regionSecurityPolicies.html | 98 +- .../compute_beta.regionSnapshotSettings.html | 14 +- docs/dyn/compute_beta.regionSnapshots.html | 137 +- .../compute_beta.regionSslCertificates.html | 28 +- docs/dyn/compute_beta.regionSslPolicies.html | 42 +- .../compute_beta.regionTargetHttpProxies.html | 42 +- ...compute_beta.regionTargetHttpsProxies.html | 70 +- .../compute_beta.regionTargetTcpProxies.html | 28 +- docs/dyn/compute_beta.regionUrlMaps.html | 70 +- docs/dyn/compute_beta.reliabilityRisks.html | 2 +- docs/dyn/compute_beta.reservationBlocks.html | 14 +- docs/dyn/compute_beta.reservationSlots.html | 28 +- .../compute_beta.reservationSubBlocks.html | 42 +- docs/dyn/compute_beta.reservations.html | 70 +- docs/dyn/compute_beta.resourcePolicies.html | 42 +- docs/dyn/compute_beta.rolloutPlans.html | 28 +- docs/dyn/compute_beta.rollouts.html | 70 +- docs/dyn/compute_beta.routers.html | 141 +- docs/dyn/compute_beta.routes.html | 28 +- docs/dyn/compute_beta.securityPolicies.html | 98 +- docs/dyn/compute_beta.serviceAttachments.html | 42 +- docs/dyn/compute_beta.snapshotGroups.html | 28 +- docs/dyn/compute_beta.snapshotSettings.html | 14 +- docs/dyn/compute_beta.snapshots.html | 164 +- docs/dyn/compute_beta.sslCertificates.html | 28 +- docs/dyn/compute_beta.sslPolicies.html | 42 +- docs/dyn/compute_beta.storagePools.html | 92 +- docs/dyn/compute_beta.subnetworks.html | 70 +- docs/dyn/compute_beta.targetGrpcProxies.html | 42 +- docs/dyn/compute_beta.targetHttpProxies.html | 56 +- docs/dyn/compute_beta.targetHttpsProxies.html | 112 +- docs/dyn/compute_beta.targetInstances.html | 42 +- docs/dyn/compute_beta.targetPools.html | 112 +- docs/dyn/compute_beta.targetSslProxies.html | 98 +- docs/dyn/compute_beta.targetTcpProxies.html | 56 +- docs/dyn/compute_beta.targetVpnGateways.html | 42 +- docs/dyn/compute_beta.urlMaps.html | 70 +- docs/dyn/compute_beta.vpnGateways.html | 42 +- docs/dyn/compute_beta.vpnTunnels.html | 42 +- docs/dyn/compute_beta.wireGroups.html | 42 +- docs/dyn/compute_beta.zoneOperations.html | 42 +- .../compute_beta.zoneVmExtensionPolicies.html | 42 +- docs/dyn/compute_v1.addresses.html | 104 +- docs/dyn/compute_v1.autoscalers.html | 56 +- docs/dyn/compute_v1.backendBuckets.html | 98 +- docs/dyn/compute_v1.backendServices.html | 154 +- docs/dyn/compute_v1.crossSiteNetworks.html | 42 +- docs/dyn/compute_v1.disks.html | 358 ++-- docs/dyn/compute_v1.externalVpnGateways.html | 42 +- docs/dyn/compute_v1.firewallPolicies.html | 140 +- docs/dyn/compute_v1.firewalls.html | 56 +- docs/dyn/compute_v1.forwardingRules.html | 70 +- docs/dyn/compute_v1.futureReservations.html | 56 +- docs/dyn/compute_v1.globalAddresses.html | 92 +- .../dyn/compute_v1.globalForwardingRules.html | 70 +- ...ompute_v1.globalNetworkEndpointGroups.html | 56 +- docs/dyn/compute_v1.globalOperations.html | 56 +- ...mpute_v1.globalOrganizationOperations.html | 28 +- ...pute_v1.globalPublicDelegatedPrefixes.html | 42 +- .../compute_v1.globalVmExtensionPolicies.html | 42 +- docs/dyn/compute_v1.healthChecks.html | 98 +- docs/dyn/compute_v1.hosts.html | 641 ++++++ docs/dyn/compute_v1.html | 10 + docs/dyn/compute_v1.httpHealthChecks.html | 56 +- docs/dyn/compute_v1.httpsHealthChecks.html | 56 +- docs/dyn/compute_v1.imageFamilyViews.html | 36 +- docs/dyn/compute_v1.images.html | 250 ++- ...v1.instanceGroupManagerResizeRequests.html | 126 +- .../dyn/compute_v1.instanceGroupManagers.html | 415 ++-- docs/dyn/compute_v1.instanceGroups.html | 70 +- docs/dyn/compute_v1.instanceSettings.html | 14 +- docs/dyn/compute_v1.instanceTemplates.html | 440 ++++- docs/dyn/compute_v1.instances.html | 1564 +++++++++++---- .../dyn/compute_v1.instantSnapshotGroups.html | 28 +- docs/dyn/compute_v1.instantSnapshots.html | 42 +- ...mpute_v1.interconnectAttachmentGroups.html | 42 +- .../compute_v1.interconnectAttachments.html | 56 +- docs/dyn/compute_v1.interconnectGroups.html | 56 +- docs/dyn/compute_v1.interconnects.html | 56 +- docs/dyn/compute_v1.licenses.html | 42 +- docs/dyn/compute_v1.machineImages.html | 525 ++++- docs/dyn/compute_v1.networkAttachments.html | 42 +- ...ompute_v1.networkEdgeSecurityServices.html | 42 +- .../dyn/compute_v1.networkEndpointGroups.html | 56 +- .../compute_v1.networkFirewallPolicies.html | 168 +- docs/dyn/compute_v1.networks.html | 126 +- docs/dyn/compute_v1.nodeGroups.html | 112 +- docs/dyn/compute_v1.nodeTemplates.html | 28 +- ...mpute_v1.organizationSecurityPolicies.html | 140 +- docs/dyn/compute_v1.packetMirrorings.html | 42 +- docs/dyn/compute_v1.previewFeatures.html | 14 +- docs/dyn/compute_v1.projects.html | 140 +- .../compute_v1.publicAdvertisedPrefixes.html | 70 +- .../compute_v1.publicDelegatedPrefixes.html | 70 +- docs/dyn/compute_v1.regionAutoscalers.html | 56 +- docs/dyn/compute_v1.regionBackendBuckets.html | 42 +- .../dyn/compute_v1.regionBackendServices.html | 106 +- docs/dyn/compute_v1.regionCommitments.html | 28 +- ...ompute_v1.regionCompositeHealthChecks.html | 42 +- docs/dyn/compute_v1.regionDisks.html | 317 +-- ...te_v1.regionHealthAggregationPolicies.html | 42 +- .../compute_v1.regionHealthCheckServices.html | 42 +- docs/dyn/compute_v1.regionHealthChecks.html | 91 +- docs/dyn/compute_v1.regionHealthSources.html | 42 +- ...ionInstanceGroupManagerResizeRequests.html | 126 +- ...ompute_v1.regionInstanceGroupManagers.html | 380 ++-- docs/dyn/compute_v1.regionInstanceGroups.html | 14 +- .../compute_v1.regionInstanceTemplates.html | 337 +++- docs/dyn/compute_v1.regionInstances.html | 189 +- ...ompute_v1.regionInstantSnapshotGroups.html | 28 +- .../compute_v1.regionInstantSnapshots.html | 42 +- ...ompute_v1.regionNetworkEndpointGroups.html | 56 +- ...pute_v1.regionNetworkFirewallPolicies.html | 126 +- ...ompute_v1.regionNotificationEndpoints.html | 28 +- docs/dyn/compute_v1.regionOperations.html | 42 +- .../compute_v1.regionSecurityPolicies.html | 98 +- .../compute_v1.regionSnapshotSettings.html | 14 +- docs/dyn/compute_v1.regionSnapshots.html | 137 +- .../dyn/compute_v1.regionSslCertificates.html | 28 +- docs/dyn/compute_v1.regionSslPolicies.html | 42 +- .../compute_v1.regionTargetHttpProxies.html | 42 +- .../compute_v1.regionTargetHttpsProxies.html | 70 +- .../compute_v1.regionTargetTcpProxies.html | 28 +- docs/dyn/compute_v1.regionUrlMaps.html | 56 +- docs/dyn/compute_v1.reliabilityRisks.html | 328 ++++ docs/dyn/compute_v1.reservationBlocks.html | 14 +- docs/dyn/compute_v1.reservationSlots.html | 28 +- docs/dyn/compute_v1.reservationSubBlocks.html | 42 +- docs/dyn/compute_v1.reservations.html | 70 +- docs/dyn/compute_v1.resourcePolicies.html | 42 +- docs/dyn/compute_v1.rolloutPlans.html | 28 +- docs/dyn/compute_v1.rollouts.html | 70 +- docs/dyn/compute_v1.routers.html | 140 +- docs/dyn/compute_v1.routes.html | 28 +- docs/dyn/compute_v1.securityPolicies.html | 98 +- docs/dyn/compute_v1.serviceAttachments.html | 42 +- docs/dyn/compute_v1.snapshotSettings.html | 14 +- docs/dyn/compute_v1.snapshots.html | 137 +- docs/dyn/compute_v1.sslCertificates.html | 28 +- docs/dyn/compute_v1.sslPolicies.html | 42 +- docs/dyn/compute_v1.storagePools.html | 92 +- docs/dyn/compute_v1.subnetworks.html | 70 +- docs/dyn/compute_v1.targetGrpcProxies.html | 42 +- docs/dyn/compute_v1.targetHttpProxies.html | 56 +- docs/dyn/compute_v1.targetHttpsProxies.html | 112 +- docs/dyn/compute_v1.targetInstances.html | 42 +- docs/dyn/compute_v1.targetPools.html | 112 +- docs/dyn/compute_v1.targetSslProxies.html | 98 +- docs/dyn/compute_v1.targetTcpProxies.html | 56 +- docs/dyn/compute_v1.targetVpnGateways.html | 42 +- docs/dyn/compute_v1.urlMaps.html | 70 +- docs/dyn/compute_v1.vpnGateways.html | 42 +- docs/dyn/compute_v1.vpnTunnels.html | 42 +- docs/dyn/compute_v1.wireGroups.html | 42 +- docs/dyn/compute_v1.zoneOperations.html | 42 +- .../compute_v1.zoneVmExtensionPolicies.html | 42 +- .../documents/compute.alpha.json | 1294 ++++++++++++- .../documents/compute.beta.json | 462 ++++- .../discovery_cache/documents/compute.v1.json | 1714 ++++++++++++++--- 381 files changed, 34190 insertions(+), 13747 deletions(-) create mode 100644 docs/dyn/compute_alpha.managedRulesets.html create mode 100644 docs/dyn/compute_alpha.reservationConsumedInstances.html create mode 100644 docs/dyn/compute_v1.hosts.html create mode 100644 docs/dyn/compute_v1.reliabilityRisks.html diff --git a/docs/dyn/compute_alpha.acceleratorPodControllers.html b/docs/dyn/compute_alpha.acceleratorPodControllers.html index 3b9fda97fe..5546b85d49 100644 --- a/docs/dyn/compute_alpha.acceleratorPodControllers.html +++ b/docs/dyn/compute_alpha.acceleratorPodControllers.html @@ -157,15 +157,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -212,7 +214,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -224,14 +226,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -251,6 +253,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -431,8 +439,8 @@

Method Details

# endpoint. The subnetwork must belong to the specified network and have # available IP addresses. "type": "A String", # Required. The type of management service this interface provides. - # Supported types include NMX-C for partition management and gNMI for switch - # monitoring. + # Supported types include NMX-C for partition management, gNMI for switch + # monitoring, and TPU slice management. }, }, "name": "A String", # Required. The name of the resource, provided by the client when initially creating @@ -495,8 +503,8 @@

Method Details

# endpoint. The subnetwork must belong to the specified network and have # available IP addresses. "type": "A String", # Required. The type of management service this interface provides. - # Supported types include NMX-C for partition management and gNMI for switch - # monitoring. + # Supported types include NMX-C for partition management, gNMI for switch + # monitoring, and TPU slice management. }, }, "name": "A String", # Required. The name of the resource, provided by the client when initially creating @@ -564,15 +572,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -619,7 +629,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -631,14 +641,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -658,6 +668,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -922,8 +938,8 @@

Method Details

# endpoint. The subnetwork must belong to the specified network and have # available IP addresses. "type": "A String", # Required. The type of management service this interface provides. - # Supported types include NMX-C for partition management and gNMI for switch - # monitoring. + # Supported types include NMX-C for partition management, gNMI for switch + # monitoring, and TPU slice management. }, }, "name": "A String", # Required. The name of the resource, provided by the client when initially creating @@ -1031,8 +1047,8 @@

Method Details

# endpoint. The subnetwork must belong to the specified network and have # available IP addresses. "type": "A String", # Required. The type of management service this interface provides. - # Supported types include NMX-C for partition management and gNMI for switch - # monitoring. + # Supported types include NMX-C for partition management, gNMI for switch + # monitoring, and TPU slice management. }, }, "name": "A String", # Required. The name of the resource, provided by the client when initially creating @@ -1101,15 +1117,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1156,7 +1174,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1168,14 +1186,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1195,6 +1213,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.addresses.html b/docs/dyn/compute_alpha.addresses.html index 3859bc69f1..8df32ebc97 100644 --- a/docs/dyn/compute_alpha.addresses.html +++ b/docs/dyn/compute_alpha.addresses.html @@ -246,8 +246,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -329,6 +331,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -502,15 +510,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -557,7 +567,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -569,14 +579,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -596,6 +606,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -768,8 +784,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -851,6 +869,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -906,8 +930,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -989,6 +1015,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -1068,15 +1100,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1123,7 +1157,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1135,14 +1169,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1162,6 +1196,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1420,8 +1460,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -1503,6 +1545,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -1656,15 +1704,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1711,7 +1761,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1723,14 +1773,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1750,6 +1800,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1966,15 +2022,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2021,7 +2079,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2033,14 +2091,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2060,6 +2118,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.advice.html b/docs/dyn/compute_alpha.advice.html index 581ced68e6..95f2788edb 100644 --- a/docs/dyn/compute_alpha.advice.html +++ b/docs/dyn/compute_alpha.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)

+

Advise 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) +
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.
+
+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 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:
+      # 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 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.
+    "status": "A String", # Status of recommendation.
+  },
+  "recommendationId": "A String", # Unique id of the recommendation, 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_alpha.autoscalers.html b/docs/dyn/compute_alpha.autoscalers.html
index 52c6fee21b..9e774310e2 100644
--- a/docs/dyn/compute_alpha.autoscalers.html
+++ b/docs/dyn/compute_alpha.autoscalers.html
@@ -743,15 +743,17 @@ 

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -798,7 +800,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -810,14 +812,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -837,6 +839,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1789,15 +1797,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1844,7 +1854,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1856,14 +1866,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1883,6 +1893,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2973,15 +2989,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3028,7 +3046,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3040,14 +3058,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3067,6 +3085,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3671,15 +3695,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3726,7 +3752,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3738,14 +3764,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3765,6 +3791,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.backendBuckets.html b/docs/dyn/compute_alpha.backendBuckets.html index 182fcf2a27..16afb09244 100644 --- a/docs/dyn/compute_alpha.backendBuckets.html +++ b/docs/dyn/compute_alpha.backendBuckets.html @@ -212,15 +212,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -267,7 +269,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -279,14 +281,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -306,6 +308,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -895,15 +903,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -950,7 +960,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -962,14 +972,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -989,6 +999,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1191,15 +1207,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1246,7 +1264,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1258,14 +1276,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1285,6 +1303,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2257,15 +2281,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2312,7 +2338,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2324,14 +2350,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2351,6 +2377,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3435,15 +3467,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3490,7 +3524,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3502,14 +3536,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3529,6 +3563,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3736,15 +3776,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3791,7 +3833,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3803,14 +3845,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3830,6 +3872,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -5133,15 +5181,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5188,7 +5238,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5200,14 +5250,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5227,6 +5277,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index 992e12061f..797a491fc4 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -221,15 +221,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -276,7 +278,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -288,14 +290,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -315,6 +317,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2182,7 +2190,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -2475,15 +2487,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2530,7 +2544,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2542,14 +2556,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2569,6 +2583,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2771,15 +2791,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2826,7 +2848,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2838,14 +2860,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2865,6 +2887,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4632,7 +4660,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -7604,7 +7636,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -7805,15 +7841,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7860,7 +7898,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7872,14 +7910,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7899,6 +7937,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -9752,7 +9796,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -11651,7 +11699,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -13490,7 +13542,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -13691,15 +13747,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13746,7 +13804,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13758,14 +13816,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13785,6 +13843,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -13992,15 +14056,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14047,7 +14113,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14059,14 +14125,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14086,6 +14152,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -15169,15 +15241,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15224,7 +15298,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15236,14 +15310,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15263,6 +15337,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -17060,7 +17140,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -17261,15 +17345,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17316,7 +17402,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17328,14 +17414,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17355,6 +17441,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.crossSiteNetworks.html b/docs/dyn/compute_alpha.crossSiteNetworks.html index 4b5fc45e5e..88f1437d91 100644 --- a/docs/dyn/compute_alpha.crossSiteNetworks.html +++ b/docs/dyn/compute_alpha.crossSiteNetworks.html @@ -169,15 +169,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -224,7 +226,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -236,14 +238,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -263,6 +265,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -525,15 +533,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -580,7 +590,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -592,14 +602,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -619,6 +629,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1023,15 +1039,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1078,7 +1096,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1090,14 +1108,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1117,6 +1135,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.dhcpOptionsConfigs.html b/docs/dyn/compute_alpha.dhcpOptionsConfigs.html index 18e6137c4d..0120a77251 100644 --- a/docs/dyn/compute_alpha.dhcpOptionsConfigs.html +++ b/docs/dyn/compute_alpha.dhcpOptionsConfigs.html @@ -173,15 +173,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -228,7 +230,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -240,14 +242,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -267,6 +269,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -666,15 +674,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -721,7 +731,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -733,14 +743,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -760,6 +770,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1302,15 +1318,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1357,7 +1375,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1369,14 +1387,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1396,6 +1414,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.diskSettings.html b/docs/dyn/compute_alpha.diskSettings.html index 57e69e82c3..5ab8e826b7 100644 --- a/docs/dyn/compute_alpha.diskSettings.html +++ b/docs/dyn/compute_alpha.diskSettings.html @@ -284,15 +284,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -339,7 +341,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -351,14 +353,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -378,6 +380,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html index bd71fe5b50..bfad2851b7 100644 --- a/docs/dyn/compute_alpha.disks.html +++ b/docs/dyn/compute_alpha.disks.html @@ -233,15 +233,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -288,7 +290,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -300,14 +302,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -327,6 +329,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -694,7 +702,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -702,7 +711,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -724,7 +734,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -956,7 +967,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -964,7 +976,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -986,7 +999,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1039,7 +1053,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1047,7 +1062,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1069,7 +1085,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1107,7 +1124,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1115,7 +1133,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1137,7 +1156,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1379,15 +1399,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1434,7 +1456,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1446,14 +1468,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1473,6 +1495,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1693,15 +1721,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1748,7 +1778,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1760,14 +1790,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1787,6 +1817,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2006,15 +2042,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2061,7 +2099,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2073,14 +2111,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2100,6 +2138,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2391,7 +2435,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2399,7 +2444,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2421,7 +2467,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2451,7 +2498,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2459,7 +2507,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2481,7 +2530,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2517,7 +2567,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2525,7 +2576,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2547,7 +2599,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2640,15 +2693,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2695,7 +2750,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2707,14 +2762,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2734,6 +2789,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2938,15 +2999,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2993,7 +3056,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3005,14 +3068,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3032,6 +3095,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3301,7 +3370,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3309,7 +3379,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3331,7 +3402,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3563,7 +3635,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3571,7 +3644,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3593,7 +3667,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3646,7 +3721,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3654,7 +3730,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3676,7 +3753,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3714,7 +3792,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3722,7 +3801,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3744,7 +3824,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4364,7 +4445,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4372,7 +4454,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4394,7 +4477,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4626,7 +4710,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4634,7 +4719,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4656,7 +4742,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4709,7 +4796,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4717,7 +4805,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4739,7 +4828,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4777,7 +4867,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4785,7 +4876,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4807,7 +4899,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4914,15 +5007,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4969,7 +5064,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4981,14 +5076,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5008,6 +5103,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -5363,7 +5464,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5371,7 +5473,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5393,7 +5496,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5625,7 +5729,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5633,7 +5738,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5655,7 +5761,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5708,7 +5815,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5716,7 +5824,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5738,7 +5847,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5776,7 +5886,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5784,7 +5895,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5806,7 +5918,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5979,15 +6092,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6034,7 +6149,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6046,14 +6161,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6073,6 +6188,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6281,15 +6402,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6336,7 +6459,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6348,14 +6471,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6375,6 +6498,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7466,15 +7595,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7521,7 +7652,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7533,14 +7664,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7560,6 +7691,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7789,15 +7926,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7844,7 +7983,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7856,14 +7995,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7883,6 +8022,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -8084,15 +8229,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8139,7 +8286,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8151,14 +8298,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8178,6 +8325,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -8399,15 +8552,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8454,7 +8609,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8466,14 +8621,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8493,6 +8648,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -8793,7 +8954,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8801,7 +8963,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8823,7 +8986,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9055,7 +9219,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9063,7 +9228,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9085,7 +9251,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9138,7 +9305,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9146,7 +9314,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9168,7 +9337,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9206,7 +9376,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9214,7 +9385,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9236,7 +9408,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9344,15 +9517,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9399,7 +9574,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9411,14 +9586,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9438,6 +9613,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -9657,15 +9838,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9712,7 +9895,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9724,14 +9907,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9751,6 +9934,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -9959,15 +10148,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10014,7 +10205,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10026,14 +10217,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10053,6 +10244,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.externalVpnGateways.html b/docs/dyn/compute_alpha.externalVpnGateways.html index 1208f98efd..46996f6c66 100644 --- a/docs/dyn/compute_alpha.externalVpnGateways.html +++ b/docs/dyn/compute_alpha.externalVpnGateways.html @@ -171,15 +171,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -226,7 +228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -238,14 +240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -265,6 +267,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -658,15 +666,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -713,7 +723,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -725,14 +735,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -752,6 +762,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1196,15 +1212,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1251,7 +1269,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1263,14 +1281,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1290,6 +1308,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.firewallPolicies.html b/docs/dyn/compute_alpha.firewallPolicies.html index 00abbbcbe9..5c73ad648b 100644 --- a/docs/dyn/compute_alpha.firewallPolicies.html +++ b/docs/dyn/compute_alpha.firewallPolicies.html @@ -237,15 +237,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -292,7 +294,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -304,14 +306,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -331,6 +333,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -721,15 +729,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -776,7 +786,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -788,14 +798,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -815,6 +825,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1205,15 +1221,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1260,7 +1278,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1272,14 +1290,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1299,6 +1317,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1498,15 +1522,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1553,7 +1579,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1565,14 +1591,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1592,6 +1618,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1795,15 +1827,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1850,7 +1884,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1862,14 +1896,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1889,6 +1923,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2075,15 +2115,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2130,7 +2172,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2142,14 +2184,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2169,6 +2211,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4228,15 +4276,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4283,7 +4333,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4295,14 +4345,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4322,6 +4372,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -5230,15 +5286,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5285,7 +5343,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5297,14 +5355,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5324,6 +5382,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6041,15 +6105,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6096,7 +6162,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6108,14 +6174,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6135,6 +6201,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6526,15 +6598,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6581,7 +6655,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6593,14 +6667,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6620,6 +6694,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7011,15 +7091,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7066,7 +7148,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7078,14 +7160,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7105,6 +7187,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7304,15 +7392,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7359,7 +7449,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7371,14 +7461,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7398,6 +7488,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7597,15 +7693,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7652,7 +7750,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7664,14 +7762,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7691,6 +7789,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7890,15 +7994,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7945,7 +8051,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7957,14 +8063,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7984,6 +8090,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.firewalls.html b/docs/dyn/compute_alpha.firewalls.html index 3e4c1f33e5..1d1d0c0df4 100644 --- a/docs/dyn/compute_alpha.firewalls.html +++ b/docs/dyn/compute_alpha.firewalls.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -268,6 +270,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -826,15 +834,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -881,7 +891,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -893,14 +903,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -920,6 +930,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1616,15 +1632,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1671,7 +1689,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1683,14 +1701,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1710,6 +1728,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2118,15 +2142,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2173,7 +2199,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2185,14 +2211,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2212,6 +2238,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.folderGlobalVmExtensionPolicies.html b/docs/dyn/compute_alpha.folderGlobalVmExtensionPolicies.html index c27d4a9c64..b4e3547bfe 100644 --- a/docs/dyn/compute_alpha.folderGlobalVmExtensionPolicies.html +++ b/docs/dyn/compute_alpha.folderGlobalVmExtensionPolicies.html @@ -234,6 +234,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -484,15 +498,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -539,7 +555,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -551,14 +567,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -578,6 +594,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -733,6 +755,20 @@

Method Details

"extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration. # The key is the name of the extension. "a_key": { # Policy for a single extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The version pinning for the extension. # If empty, the extension will be installed with the latest version # released by the extension producer. @@ -897,6 +933,20 @@

Method Details

"extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration. # The key is the name of the extension. "a_key": { # Policy for a single extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The version pinning for the extension. # If empty, the extension will be installed with the latest version # released by the extension producer. @@ -1073,15 +1123,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1128,7 +1180,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1140,14 +1192,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1167,6 +1219,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1408,6 +1466,20 @@

Method Details

"extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration. # The key is the name of the extension. "a_key": { # Policy for a single extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The version pinning for the extension. # If empty, the extension will be installed with the latest version # released by the extension producer. @@ -1768,6 +1840,20 @@

Method Details

"extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration. # The key is the name of the extension. "a_key": { # Policy for a single extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The version pinning for the extension. # If empty, the extension will be installed with the latest version # released by the extension producer. @@ -1944,15 +2030,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1999,7 +2087,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2011,14 +2099,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2038,6 +2126,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.folderZoneVmExtensionPolicies.html b/docs/dyn/compute_alpha.folderZoneVmExtensionPolicies.html index 4892272bed..1c81a1d7d8 100644 --- a/docs/dyn/compute_alpha.folderZoneVmExtensionPolicies.html +++ b/docs/dyn/compute_alpha.folderZoneVmExtensionPolicies.html @@ -178,15 +178,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -233,7 +235,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -245,14 +247,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -272,6 +274,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -427,6 +435,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -521,6 +543,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -633,15 +669,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -688,7 +726,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -700,14 +738,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -727,6 +765,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -974,6 +1018,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -1264,6 +1322,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -1376,15 +1448,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1431,7 +1505,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1443,14 +1517,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1470,6 +1544,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.forwardingRules.html b/docs/dyn/compute_alpha.forwardingRules.html index 1b0c645e4b..ef7afb5a1f 100644 --- a/docs/dyn/compute_alpha.forwardingRules.html +++ b/docs/dyn/compute_alpha.forwardingRules.html @@ -789,15 +789,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -844,7 +846,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -856,14 +858,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -883,6 +885,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1930,15 +1938,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1985,7 +1995,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1997,14 +2007,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2024,6 +2034,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3204,15 +3220,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3259,7 +3277,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3271,14 +3289,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3298,6 +3316,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3515,15 +3539,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3570,7 +3596,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3582,14 +3608,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3609,6 +3635,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3817,15 +3849,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3872,7 +3906,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3884,14 +3918,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3911,6 +3945,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.futureReservations.html b/docs/dyn/compute_alpha.futureReservations.html index a5eca39e33..c170cc2134 100644 --- a/docs/dyn/compute_alpha.futureReservations.html +++ b/docs/dyn/compute_alpha.futureReservations.html @@ -746,15 +746,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -801,7 +803,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -813,14 +815,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -840,6 +842,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1045,15 +1053,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1100,7 +1110,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1112,14 +1122,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1139,6 +1149,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2112,15 +2128,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2167,7 +2185,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2179,14 +2197,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2206,6 +2224,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3322,15 +3346,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3377,7 +3403,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3389,14 +3415,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3416,6 +3442,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.globalAddresses.html b/docs/dyn/compute_alpha.globalAddresses.html index babd39d918..2c9ffa1e2a 100644 --- a/docs/dyn/compute_alpha.globalAddresses.html +++ b/docs/dyn/compute_alpha.globalAddresses.html @@ -177,15 +177,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -232,7 +234,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -244,14 +246,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -271,6 +273,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -442,8 +450,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -525,6 +535,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -599,8 +615,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -682,6 +700,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -761,15 +785,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -816,7 +842,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -828,14 +854,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -855,6 +881,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1111,8 +1143,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -1194,6 +1228,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -1346,15 +1386,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1401,7 +1443,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1413,14 +1455,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1440,6 +1482,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1645,15 +1693,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1700,7 +1750,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1712,14 +1762,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1739,6 +1789,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.globalFolderOperations.html b/docs/dyn/compute_alpha.globalFolderOperations.html index 02bad3ce54..2df1de7bea 100644 --- a/docs/dyn/compute_alpha.globalFolderOperations.html +++ b/docs/dyn/compute_alpha.globalFolderOperations.html @@ -146,15 +146,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -201,7 +203,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -213,14 +215,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -240,6 +242,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -513,15 +521,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -568,7 +578,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -580,14 +590,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -607,6 +617,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.globalForwardingRules.html b/docs/dyn/compute_alpha.globalForwardingRules.html index 2c4fd3fca8..9e1cf4905d 100644 --- a/docs/dyn/compute_alpha.globalForwardingRules.html +++ b/docs/dyn/compute_alpha.globalForwardingRules.html @@ -177,15 +177,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -232,7 +234,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -244,14 +246,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -271,6 +273,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1317,15 +1325,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1372,7 +1382,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1384,14 +1394,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1411,6 +1421,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2589,15 +2605,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2644,7 +2662,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2656,14 +2674,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2683,6 +2701,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2889,15 +2913,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2944,7 +2970,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2956,14 +2982,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2983,6 +3009,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3190,15 +3222,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3245,7 +3279,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3257,14 +3291,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3284,6 +3318,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html index 2ccf3bdad8..bb3f5d5820 100644 --- a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html @@ -217,15 +217,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -272,7 +274,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -284,14 +286,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -311,6 +313,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -517,15 +525,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -572,7 +582,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -584,14 +594,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -611,6 +621,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -855,15 +871,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -910,7 +928,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -922,14 +940,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -949,6 +967,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1635,15 +1659,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1690,7 +1716,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1702,14 +1728,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1729,6 +1755,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.globalOperations.html b/docs/dyn/compute_alpha.globalOperations.html index f5fc01a7d6..6c8139a7c9 100644 --- a/docs/dyn/compute_alpha.globalOperations.html +++ b/docs/dyn/compute_alpha.globalOperations.html @@ -253,15 +253,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -308,7 +310,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -320,14 +322,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -347,6 +349,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -635,15 +643,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -690,7 +700,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -702,14 +712,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -729,6 +739,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1002,15 +1018,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1057,7 +1075,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1069,14 +1087,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1096,6 +1114,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1348,15 +1372,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1403,7 +1429,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1415,14 +1441,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1442,6 +1468,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.globalOrganizationOperations.html b/docs/dyn/compute_alpha.globalOrganizationOperations.html index ba1bd5d7b2..d9338c5259 100644 --- a/docs/dyn/compute_alpha.globalOrganizationOperations.html +++ b/docs/dyn/compute_alpha.globalOrganizationOperations.html @@ -166,15 +166,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -221,7 +223,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -233,14 +235,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -260,6 +262,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -533,15 +541,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -588,7 +598,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -600,14 +610,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -627,6 +637,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html b/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html index e4e81066fc..34011ab291 100644 --- a/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html +++ b/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html @@ -168,15 +168,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -223,7 +225,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -235,14 +237,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -262,6 +264,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -704,15 +712,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -759,7 +769,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -771,14 +781,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -798,6 +808,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1377,15 +1393,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1432,7 +1450,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1444,14 +1462,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1471,6 +1489,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.globalVmExtensionPolicies.html b/docs/dyn/compute_alpha.globalVmExtensionPolicies.html index 22c7c118c2..8d720f36c2 100644 --- a/docs/dyn/compute_alpha.globalVmExtensionPolicies.html +++ b/docs/dyn/compute_alpha.globalVmExtensionPolicies.html @@ -234,6 +234,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -484,15 +498,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -539,7 +555,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -551,14 +567,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -578,6 +594,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -733,6 +755,20 @@

Method Details

"extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration. # The key is the name of the extension. "a_key": { # Policy for a single extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The version pinning for the extension. # If empty, the extension will be installed with the latest version # released by the extension producer. @@ -897,6 +933,20 @@

Method Details

"extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration. # The key is the name of the extension. "a_key": { # Policy for a single extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The version pinning for the extension. # If empty, the extension will be installed with the latest version # released by the extension producer. @@ -1073,15 +1123,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1128,7 +1180,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1140,14 +1192,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1167,6 +1219,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1408,6 +1466,20 @@

Method Details

"extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration. # The key is the name of the extension. "a_key": { # Policy for a single extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The version pinning for the extension. # If empty, the extension will be installed with the latest version # released by the extension producer. @@ -1768,6 +1840,20 @@

Method Details

"extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration. # The key is the name of the extension. "a_key": { # Policy for a single extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The version pinning for the extension. # If empty, the extension will be installed with the latest version # released by the extension producer. @@ -1944,15 +2030,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1999,7 +2087,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2011,14 +2099,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2038,6 +2126,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.haControllers.html b/docs/dyn/compute_alpha.haControllers.html index 53ff988024..c52c15ff32 100644 --- a/docs/dyn/compute_alpha.haControllers.html +++ b/docs/dyn/compute_alpha.haControllers.html @@ -285,15 +285,17 @@

Method Details

# failover. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -340,7 +342,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -352,14 +354,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -395,15 +397,17 @@

Method Details

# failover. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -450,7 +454,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -462,14 +466,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -514,15 +518,17 @@

Method Details

"errors": { # Output only. [Output Only] Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -569,7 +575,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -581,14 +587,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -800,15 +806,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -855,7 +863,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -867,14 +875,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -894,6 +902,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1092,15 +1106,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1147,7 +1163,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1159,14 +1175,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1186,6 +1202,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1401,15 +1423,17 @@

Method Details

# failover. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1456,7 +1480,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1468,14 +1492,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1511,15 +1535,17 @@

Method Details

# failover. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1566,7 +1592,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1578,14 +1604,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1630,15 +1656,17 @@

Method Details

"errors": { # Output only. [Output Only] Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1685,7 +1713,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1697,14 +1725,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1847,15 +1875,17 @@

Method Details

# failover. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1902,7 +1932,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1914,14 +1944,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1957,15 +1987,17 @@

Method Details

# failover. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2012,7 +2044,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2024,14 +2056,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2076,15 +2108,17 @@

Method Details

"errors": { # Output only. [Output Only] Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2131,7 +2165,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2143,14 +2177,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2265,15 +2299,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2320,7 +2356,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2332,14 +2368,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2359,6 +2395,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2660,15 +2702,17 @@

Method Details

# failover. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2715,7 +2759,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2727,14 +2771,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2770,15 +2814,17 @@

Method Details

# failover. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2825,7 +2871,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2837,14 +2883,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2889,15 +2935,17 @@

Method Details

"errors": { # Output only. [Output Only] Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2944,7 +2992,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2956,14 +3004,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3156,15 +3204,17 @@

Method Details

# failover. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3211,7 +3261,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3223,14 +3273,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3266,15 +3316,17 @@

Method Details

# failover. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3321,7 +3373,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3333,14 +3385,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3385,15 +3437,17 @@

Method Details

"errors": { # Output only. [Output Only] Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3440,7 +3494,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3452,14 +3506,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3575,15 +3629,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3630,7 +3686,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3642,14 +3698,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3669,6 +3725,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.healthChecks.html b/docs/dyn/compute_alpha.healthChecks.html index 7ce0f5e268..ec10b50685 100644 --- a/docs/dyn/compute_alpha.healthChecks.html +++ b/docs/dyn/compute_alpha.healthChecks.html @@ -482,7 +482,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -569,8 +569,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "udpHealthCheck": { "port": 42, # The UDP port number to which the health check prober sends packets. Valid # values are 1 through 65535. @@ -736,15 +737,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -791,7 +794,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -803,14 +806,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -830,6 +833,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1236,7 +1245,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -1323,8 +1332,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "udpHealthCheck": { "port": 42, # The UDP port number to which the health check prober sends packets. Valid # values are 1 through 65535. @@ -1608,7 +1618,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -1695,8 +1705,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "udpHealthCheck": { "port": 42, # The UDP port number to which the health check prober sends packets. Valid # values are 1 through 65535. @@ -1770,15 +1781,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1825,7 +1838,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1837,14 +1850,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1864,6 +1877,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2356,7 +2375,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -2443,8 +2462,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "udpHealthCheck": { "port": 42, # The UDP port number to which the health check prober sends packets. Valid # values are 1 through 65535. @@ -2779,7 +2799,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -2866,8 +2886,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "udpHealthCheck": { "port": 42, # The UDP port number to which the health check prober sends packets. Valid # values are 1 through 65535. @@ -2941,15 +2962,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2996,7 +3019,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3008,14 +3031,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3035,6 +3058,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3470,7 +3499,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -3557,8 +3586,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "udpHealthCheck": { "port": 42, # The UDP port number to which the health check prober sends packets. Valid # values are 1 through 65535. @@ -3632,15 +3662,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3687,7 +3719,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3699,14 +3731,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3726,6 +3758,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.hosts.html b/docs/dyn/compute_alpha.hosts.html index 3129ff3431..611794a587 100644 --- a/docs/dyn/compute_alpha.hosts.html +++ b/docs/dyn/compute_alpha.hosts.html @@ -220,15 +220,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -275,7 +277,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -287,14 +289,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -314,6 +316,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -584,7 +592,7 @@

Method Details

"zone": "A String", # Output only. The zone in which the host resides. }, ], - "kind": "compute#host", # The type of resource. Always compute#host for a list of hosts. + "kind": "compute#hostList", # The type of resource. Always compute#host for a list of hosts. "nextPageToken": "A String", # This token allows you to get the next page of results for # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for # the query parameter pageToken in the next list request. diff --git a/docs/dyn/compute_alpha.html b/docs/dyn/compute_alpha.html index 92025a9532..32c1a972fe 100644 --- a/docs/dyn/compute_alpha.html +++ b/docs/dyn/compute_alpha.html @@ -339,6 +339,11 @@

Instance Methods

Returns the machineTypes Resource.

+

+ managedRulesets() +

+

Returns the managedRulesets Resource.

+

networkAttachments()

@@ -654,6 +659,11 @@

Instance Methods

Returns the reservationBlocks Resource.

+

+ reservationConsumedInstances() +

+

Returns the reservationConsumedInstances Resource.

+

reservationSlots()

diff --git a/docs/dyn/compute_alpha.httpHealthChecks.html b/docs/dyn/compute_alpha.httpHealthChecks.html index 2ba131ee6d..ef7fe360a4 100644 --- a/docs/dyn/compute_alpha.httpHealthChecks.html +++ b/docs/dyn/compute_alpha.httpHealthChecks.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -268,6 +270,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -566,15 +574,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -621,7 +631,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -633,14 +643,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -660,6 +670,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1095,15 +1111,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1150,7 +1168,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1162,14 +1180,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1189,6 +1207,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1465,15 +1489,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1520,7 +1546,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1532,14 +1558,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1559,6 +1585,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.httpsHealthChecks.html b/docs/dyn/compute_alpha.httpsHealthChecks.html index 3838d199f6..c5020c9ae8 100644 --- a/docs/dyn/compute_alpha.httpsHealthChecks.html +++ b/docs/dyn/compute_alpha.httpsHealthChecks.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -268,6 +270,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -574,15 +582,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -629,7 +639,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -641,14 +651,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -668,6 +678,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1111,15 +1127,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1166,7 +1184,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1178,14 +1196,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1205,6 +1223,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1485,15 +1509,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1540,7 +1566,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1552,14 +1578,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1579,6 +1605,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.imageFamilyViews.html b/docs/dyn/compute_alpha.imageFamilyViews.html index a05f9ec2fb..bb6acab24e 100644 --- a/docs/dyn/compute_alpha.imageFamilyViews.html +++ b/docs/dyn/compute_alpha.imageFamilyViews.html @@ -228,7 +228,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -236,7 +237,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -258,7 +260,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -446,7 +449,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -454,7 +458,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -476,7 +481,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -519,7 +525,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -527,7 +534,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -549,7 +557,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -592,7 +601,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -600,7 +610,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -622,7 +633,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, diff --git a/docs/dyn/compute_alpha.imageViews.html b/docs/dyn/compute_alpha.imageViews.html index c685e21067..9bef2dc496 100644 --- a/docs/dyn/compute_alpha.imageViews.html +++ b/docs/dyn/compute_alpha.imageViews.html @@ -233,7 +233,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -241,7 +242,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -263,7 +265,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -451,7 +454,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -459,7 +463,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -481,7 +486,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -524,7 +530,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -532,7 +539,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -554,7 +562,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -597,7 +606,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -605,7 +615,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -627,7 +638,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -876,7 +888,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -884,7 +897,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -906,7 +920,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1094,7 +1109,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1102,7 +1118,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1124,7 +1141,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1167,7 +1185,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1175,7 +1194,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1197,7 +1217,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1240,7 +1261,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1248,7 +1270,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1270,7 +1293,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, diff --git a/docs/dyn/compute_alpha.images.html b/docs/dyn/compute_alpha.images.html index fec8d53399..f6805d8bfc 100644 --- a/docs/dyn/compute_alpha.images.html +++ b/docs/dyn/compute_alpha.images.html @@ -186,15 +186,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -241,7 +243,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -253,14 +255,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -280,6 +282,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -527,15 +535,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -582,7 +592,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -594,14 +604,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -621,6 +631,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -891,7 +907,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -899,7 +916,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -921,7 +939,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1109,7 +1128,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1117,7 +1137,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1139,7 +1160,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1182,7 +1204,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1190,7 +1213,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1212,7 +1236,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1255,7 +1280,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1263,7 +1289,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1285,7 +1312,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1447,7 +1475,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1455,7 +1484,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1477,7 +1507,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1665,7 +1696,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1673,7 +1705,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1695,7 +1728,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1738,7 +1772,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1746,7 +1781,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1768,7 +1804,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1811,7 +1848,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1819,7 +1857,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1841,7 +1880,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2363,7 +2403,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2371,7 +2412,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2393,7 +2435,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2581,7 +2624,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2589,7 +2633,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2611,7 +2656,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2654,7 +2700,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2662,7 +2709,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2684,7 +2732,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2727,7 +2776,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2735,7 +2785,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2757,7 +2808,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2838,15 +2890,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2893,7 +2947,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2905,14 +2959,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2932,6 +2986,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3294,7 +3354,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3302,7 +3363,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3324,7 +3386,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3512,7 +3575,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3520,7 +3584,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3542,7 +3607,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3585,7 +3651,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3593,7 +3660,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3615,7 +3683,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3658,7 +3727,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3666,7 +3736,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3688,7 +3759,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3892,7 +3964,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3900,7 +3973,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3922,7 +3996,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4110,7 +4185,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4118,7 +4194,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4140,7 +4217,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4183,7 +4261,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4191,7 +4270,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4213,7 +4293,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4256,7 +4337,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4264,7 +4346,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4286,7 +4369,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4366,15 +4450,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4421,7 +4507,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4433,14 +4519,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4460,6 +4546,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -5539,15 +5631,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5594,7 +5688,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5606,14 +5700,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5633,6 +5727,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html b/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html index 783459cf80..a336f75eaf 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html @@ -171,15 +171,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -226,7 +228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -238,14 +240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -265,6 +267,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -476,15 +484,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -531,7 +541,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -543,14 +553,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -570,6 +580,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -857,15 +873,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -912,7 +930,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -924,14 +942,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -962,15 +980,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1017,7 +1037,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1029,14 +1049,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1233,15 +1253,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1288,7 +1310,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1300,14 +1322,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1338,15 +1360,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1393,7 +1417,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1405,14 +1429,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1517,15 +1541,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1572,7 +1598,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1584,14 +1610,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1611,6 +1637,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1982,15 +2014,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2037,7 +2071,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2049,14 +2083,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2087,15 +2121,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2142,7 +2178,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2154,14 +2190,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html index fe511a1380..0923bb7b3c 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagers.html +++ b/docs/dyn/compute_alpha.instanceGroupManagers.html @@ -276,15 +276,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -331,7 +333,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -343,14 +345,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -370,6 +372,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -634,6 +642,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", }, @@ -864,7 +873,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -872,7 +882,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -894,7 +905,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -958,7 +970,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -1086,7 +1141,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1094,7 +1150,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1116,7 +1173,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1168,7 +1226,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1176,7 +1235,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1198,7 +1258,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1345,7 +1406,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1353,7 +1415,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1375,7 +1438,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1439,7 +1503,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -1567,7 +1674,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1575,7 +1683,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1597,7 +1706,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1649,7 +1759,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1657,7 +1768,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1679,7 +1791,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1952,15 +2065,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2007,7 +2122,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2019,14 +2134,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2062,15 +2177,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2117,7 +2234,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2129,14 +2246,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2519,7 +2636,7 @@

Method Details

The object takes the form of: { # InstanceGroupManagers.applyUpdatesToInstances - "allInstances": True or False, # Flag to update all instances instead of specified list of “instances”. + "allInstances": True or False, # Flag to update all instances instead of specified list of "instances". # If the flag is set to true then the instances may not be specified # in the request. "allowedActions": [ # Actions that are allowed to update instances within MIG. @@ -2614,15 +2731,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2669,7 +2788,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2681,14 +2800,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2708,6 +2827,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2939,15 +3064,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2994,7 +3121,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3006,14 +3133,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3033,6 +3160,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3312,15 +3445,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3367,7 +3502,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3379,14 +3514,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3406,6 +3541,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3612,15 +3753,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3667,7 +3810,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3679,14 +3822,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3706,6 +3849,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3947,15 +4096,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4002,7 +4153,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4014,14 +4165,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4041,6 +4192,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4243,15 +4400,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4298,7 +4457,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4310,14 +4469,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4337,6 +4496,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4503,6 +4668,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", }, @@ -4733,7 +4899,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4741,7 +4908,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4763,7 +4931,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4827,7 +4996,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -4955,7 +5167,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4963,7 +5176,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4985,7 +5199,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5037,7 +5252,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5045,7 +5261,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5067,7 +5284,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5214,7 +5432,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5222,7 +5441,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5244,7 +5464,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5308,7 +5529,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -5436,7 +5700,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5444,7 +5709,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5466,7 +5732,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5518,7 +5785,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5526,7 +5794,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5548,7 +5817,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5821,15 +6091,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5876,7 +6148,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5888,14 +6160,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5931,15 +6203,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5986,7 +6260,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5998,14 +6272,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6324,15 +6598,17 @@

Method Details

"error": { # Reason why the topology state change failed "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6379,7 +6655,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6391,14 +6667,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6472,6 +6748,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", }, @@ -6702,7 +6979,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6710,7 +6988,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -6732,7 +7011,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -6796,7 +7076,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -6924,7 +7247,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6932,7 +7256,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -6954,7 +7279,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7006,7 +7332,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7014,7 +7341,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7036,7 +7364,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7183,7 +7512,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7191,7 +7521,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7213,7 +7544,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7277,7 +7609,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -7405,7 +7780,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7413,7 +7789,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7435,7 +7812,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7487,7 +7865,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7495,7 +7874,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7517,7 +7897,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7790,15 +8171,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7845,7 +8228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7857,14 +8240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7900,15 +8283,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7955,7 +8340,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7967,14 +8352,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8322,15 +8707,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8377,7 +8764,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8389,14 +8776,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8416,6 +8803,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -8668,6 +9061,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", }, @@ -8898,7 +9292,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8906,7 +9301,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8928,7 +9324,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8992,7 +9389,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -9120,7 +9560,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9128,7 +9569,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9150,7 +9592,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9202,7 +9645,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9210,7 +9654,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9232,7 +9677,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9379,7 +9825,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9387,7 +9834,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9409,7 +9857,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9473,7 +9922,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -9601,7 +10093,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9609,7 +10102,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9631,7 +10125,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9683,7 +10178,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9691,7 +10187,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9713,7 +10210,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9986,15 +10484,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10041,7 +10541,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10053,14 +10553,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10096,15 +10596,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10151,7 +10653,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10163,14 +10665,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10601,7 +11103,7 @@

Method Details

An object of the form: { - "items": [ # Output only. [Output Only] The list of errors of the managed instance group. + "items": [ # Output only. The list of errors of the managed instance group. { "error": { # Output only. Contents of the error. "code": "A String", # Output only. Error code. @@ -10626,8 +11128,9 @@

Method Details

"timestamp": "A String", # Output only. The time that this error occurred. This value is in RFC3339 text format. }, ], - "nextPageToken": "A String", # Output only. [Output Only] This token allows you to get the next page of results for - # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for + "nextPageToken": "A String", # Output only. This token allows you to get the next page of results for list requests. + # If the number of results is larger than maxResults + # , then use the nextPageToken as a value for # the query parameter pageToken in the next list request. # Subsequent list requests will have their own nextPageToken to # continue paging through the results. @@ -10886,7 +11389,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10894,7 +11398,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10916,7 +11421,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10980,7 +11486,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -11108,7 +11657,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -11116,7 +11666,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -11138,7 +11689,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11190,7 +11742,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -11198,7 +11751,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -11220,7 +11774,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11319,15 +11874,17 @@

Method Details

# delete the instance. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11374,7 +11931,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11386,14 +11943,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11578,7 +12135,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -11586,7 +12144,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -11608,7 +12167,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11672,7 +12232,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -11800,7 +12403,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -11808,7 +12412,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -11830,7 +12435,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11882,7 +12488,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -11890,7 +12497,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -11912,7 +12520,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -12327,6 +12936,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", }, @@ -12557,7 +13167,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -12565,7 +13176,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -12587,7 +13199,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -12651,7 +13264,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -12779,7 +13435,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -12787,7 +13444,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -12809,7 +13467,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -12861,7 +13520,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -12869,7 +13529,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -12891,7 +13552,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -13038,7 +13700,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -13046,7 +13709,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -13068,7 +13732,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -13132,7 +13797,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -13260,7 +13968,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -13268,7 +13977,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -13290,7 +14000,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -13342,7 +14053,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -13350,7 +14062,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -13372,7 +14085,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -13645,15 +14359,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13700,7 +14416,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13712,14 +14428,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13755,15 +14471,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13810,7 +14528,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13822,14 +14540,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14177,15 +14895,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14232,7 +14952,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14244,14 +14964,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14271,6 +14991,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -14551,15 +15277,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14606,7 +15334,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14618,14 +15346,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14645,6 +15373,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -14870,15 +15604,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14925,7 +15661,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14937,14 +15673,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14964,6 +15700,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -15190,15 +15932,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15245,7 +15989,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15257,14 +16001,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15284,6 +16028,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -15530,15 +16280,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15585,7 +16337,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15597,14 +16349,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15624,6 +16376,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -15850,15 +16608,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15905,7 +16665,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15917,14 +16677,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15944,6 +16704,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -16209,15 +16975,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16264,7 +17032,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16276,14 +17044,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16303,6 +17071,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -16516,15 +17290,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16571,7 +17347,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16583,14 +17359,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16610,6 +17386,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -16834,15 +17616,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16889,7 +17673,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16901,14 +17685,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16928,6 +17712,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -17154,15 +17944,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17209,7 +18001,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17221,14 +18013,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17248,6 +18040,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -17487,15 +18285,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17542,7 +18342,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17554,14 +18354,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17581,6 +18381,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -17818,15 +18624,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17873,7 +18681,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17885,14 +18693,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17912,6 +18720,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -18118,6 +18932,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", }, @@ -18348,7 +19163,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -18356,7 +19172,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -18378,7 +19195,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -18442,7 +19260,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -18570,7 +19431,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -18578,7 +19440,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -18600,7 +19463,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -18652,7 +19516,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -18660,7 +19525,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -18682,7 +19548,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -18829,7 +19696,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -18837,7 +19705,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -18859,7 +19728,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -18923,7 +19793,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -19051,7 +19964,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -19059,7 +19973,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -19081,7 +19996,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -19133,7 +20049,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -19141,7 +20058,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -19163,7 +20081,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -19436,15 +20355,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -19491,7 +20412,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -19503,14 +20424,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -19546,15 +20467,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -19601,7 +20524,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -19613,14 +20536,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -19968,15 +20891,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -20023,7 +20948,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20035,14 +20960,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -20062,6 +20987,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -20342,15 +21273,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -20397,7 +21330,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20409,14 +21342,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -20436,6 +21369,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.instanceGroups.html b/docs/dyn/compute_alpha.instanceGroups.html index 451a243802..fafdf82617 100644 --- a/docs/dyn/compute_alpha.instanceGroups.html +++ b/docs/dyn/compute_alpha.instanceGroups.html @@ -201,15 +201,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -256,7 +258,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -268,14 +270,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -295,6 +297,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -761,15 +769,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -816,7 +826,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -828,14 +838,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -855,6 +865,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1204,15 +1220,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1259,7 +1277,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1271,14 +1289,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1298,6 +1316,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1913,15 +1937,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1968,7 +1994,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1980,14 +2006,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2007,6 +2033,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2227,15 +2259,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2282,7 +2316,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2294,14 +2328,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2321,6 +2355,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.instanceSettings.html b/docs/dyn/compute_alpha.instanceSettings.html index f399426f3d..541ce4425d 100644 --- a/docs/dyn/compute_alpha.instanceSettings.html +++ b/docs/dyn/compute_alpha.instanceSettings.html @@ -234,15 +234,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -289,7 +291,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -301,14 +303,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -328,6 +330,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html index 268cb6eab2..1067859f41 100644 --- a/docs/dyn/compute_alpha.instanceTemplates.html +++ b/docs/dyn/compute_alpha.instanceTemplates.html @@ -358,7 +358,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -366,7 +367,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -388,7 +390,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -452,7 +455,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -580,7 +626,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -588,7 +635,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -610,7 +658,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -662,7 +711,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -670,7 +720,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -692,7 +743,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1139,6 +1191,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -1229,10 +1283,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1539,15 +1592,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1594,7 +1649,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1606,14 +1661,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1633,6 +1688,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1919,7 +1980,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1927,7 +1989,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1949,7 +2012,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2013,7 +2077,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -2141,7 +2248,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2149,7 +2257,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2171,7 +2280,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2223,7 +2333,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2231,7 +2342,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2253,7 +2365,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2700,6 +2813,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -2790,10 +2905,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3465,7 +3579,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3473,7 +3588,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3495,7 +3611,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3559,7 +3676,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -3687,7 +3847,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3695,7 +3856,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3717,7 +3879,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3769,7 +3932,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3777,7 +3941,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3799,7 +3964,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4246,6 +4412,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -4336,10 +4504,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4555,15 +4722,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4610,7 +4779,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4622,14 +4791,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4649,6 +4818,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -5021,7 +5196,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5029,7 +5205,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5051,7 +5228,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5115,7 +5293,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -5243,7 +5464,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5251,7 +5473,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5273,7 +5496,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5325,7 +5549,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5333,7 +5558,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5355,7 +5581,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5802,6 +6029,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -5892,10 +6121,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html index 0e2a43db60..27a09d9633 100644 --- a/docs/dyn/compute_alpha.instances.html +++ b/docs/dyn/compute_alpha.instances.html @@ -384,15 +384,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -439,7 +441,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -451,14 +453,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -478,6 +480,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -925,15 +933,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -980,7 +990,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -992,14 +1002,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1019,6 +1029,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1230,15 +1246,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1285,7 +1303,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1297,14 +1315,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1324,6 +1342,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1679,7 +1703,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1687,7 +1712,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1709,7 +1735,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1773,7 +1800,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -1901,7 +1971,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1909,7 +1980,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1931,7 +2003,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1983,7 +2056,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1991,7 +2065,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2013,7 +2088,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2145,7 +2221,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2153,7 +2230,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2175,7 +2253,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2645,6 +2724,12 @@

Method Details

# the location ID of the topologies. "a_key": "A String", }, + "networkTopologyIds": { # Output only. Key-value store for arbitrary network topology identifiers + # defined by the underlying infrastructure. + # The key will be the topology label and the value will be the location + # ID for the topology. + "a_key": "A String", + }, }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. @@ -2756,6 +2841,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -2846,10 +2933,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2969,7 +3055,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2977,7 +3064,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2999,7 +3087,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3222,7 +3311,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3230,7 +3320,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3252,7 +3343,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3316,7 +3408,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -3444,7 +3579,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3452,7 +3588,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3474,7 +3611,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3526,7 +3664,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3534,7 +3673,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3556,7 +3696,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3692,15 +3833,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3747,7 +3890,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3759,14 +3902,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3786,6 +3929,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4010,7 +4159,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4018,7 +4168,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4040,7 +4191,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4104,7 +4256,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -4232,7 +4427,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4240,7 +4436,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4262,7 +4459,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4314,7 +4512,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4322,7 +4521,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4344,7 +4544,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4536,7 +4737,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4544,7 +4746,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4566,7 +4769,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4630,7 +4834,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -4758,7 +5005,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4766,7 +5014,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4788,7 +5037,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4840,7 +5090,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4848,7 +5099,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4870,7 +5122,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5317,6 +5570,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -5407,10 +5662,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5659,15 +5913,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5714,7 +5970,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5726,14 +5982,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5753,6 +6009,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -5960,15 +6222,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6015,7 +6279,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6027,14 +6291,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6054,6 +6318,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6256,15 +6526,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6311,7 +6583,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6323,14 +6595,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6350,6 +6622,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6556,15 +6834,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6611,7 +6891,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6623,14 +6903,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6650,6 +6930,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6852,15 +7138,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6907,7 +7195,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6919,14 +7207,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6946,6 +7234,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7204,7 +7498,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7212,7 +7507,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7234,7 +7530,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7298,7 +7595,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -7426,7 +7766,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7434,7 +7775,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7456,7 +7798,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7508,7 +7851,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7516,7 +7860,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7538,7 +7883,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7670,7 +8016,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7678,7 +8025,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7700,7 +8048,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8170,6 +8519,12 @@

Method Details

# the location ID of the topologies. "a_key": "A String", }, + "networkTopologyIds": { # Output only. Key-value store for arbitrary network topology identifiers + # defined by the underlying infrastructure. + # The key will be the topology label and the value will be the location + # ID for the topology. + "a_key": "A String", + }, }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. @@ -8281,6 +8636,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -8371,10 +8728,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8494,7 +8850,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8502,7 +8859,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8524,7 +8882,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10425,7 +10784,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10433,7 +10793,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10455,7 +10816,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10519,7 +10881,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -10647,7 +11052,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10655,7 +11061,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10677,7 +11084,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10729,7 +11137,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10737,7 +11146,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10759,7 +11169,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10891,7 +11302,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10899,7 +11311,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10921,7 +11334,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11391,6 +11805,12 @@

Method Details

# the location ID of the topologies. "a_key": "A String", }, + "networkTopologyIds": { # Output only. Key-value store for arbitrary network topology identifiers + # defined by the underlying infrastructure. + # The key will be the topology label and the value will be the location + # ID for the topology. + "a_key": "A String", + }, }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. @@ -11502,6 +11922,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -11592,10 +12014,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -11715,7 +12136,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -11723,7 +12145,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -11745,7 +12168,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11894,15 +12318,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11949,7 +12375,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11961,14 +12387,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11988,6 +12414,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -12332,7 +12764,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -12340,7 +12773,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -12362,7 +12796,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -12426,7 +12861,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -12554,7 +13032,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -12562,7 +13041,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -12584,7 +13064,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -12636,7 +13117,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -12644,7 +13126,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -12666,7 +13149,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -12798,7 +13282,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -12806,7 +13291,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -12828,7 +13314,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -13298,6 +13785,12 @@

Method Details

# the location ID of the topologies. "a_key": "A String", }, + "networkTopologyIds": { # Output only. Key-value store for arbitrary network topology identifiers + # defined by the underlying infrastructure. + # The key will be the topology label and the value will be the location + # ID for the topology. + "a_key": "A String", + }, }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. @@ -13409,6 +13902,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -13499,10 +13994,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13622,7 +14116,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -13630,7 +14125,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -13652,7 +14148,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -14205,15 +14702,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14260,7 +14759,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14272,14 +14771,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14299,6 +14798,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -14499,15 +15004,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14554,7 +15061,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14566,14 +15073,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14593,6 +15100,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -14802,15 +15315,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14857,7 +15372,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14869,14 +15384,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14896,6 +15411,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -15110,15 +15631,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15165,7 +15688,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15177,14 +15700,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15204,6 +15727,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -15406,15 +15935,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15461,7 +15992,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15473,14 +16004,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15500,6 +16031,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -15673,7 +16210,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -15681,7 +16219,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -15703,7 +16242,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -15738,7 +16278,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -15746,7 +16287,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -15768,7 +16310,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -15834,15 +16377,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15889,7 +16434,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15901,14 +16446,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15928,6 +16473,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -16144,15 +16695,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16199,7 +16752,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16211,14 +16764,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16238,6 +16791,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -16441,15 +17000,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16496,7 +17057,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16508,14 +17069,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16535,6 +17096,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -17623,15 +18190,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17678,7 +18247,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17690,14 +18259,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17717,6 +18286,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -17936,15 +18511,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17991,7 +18568,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -18003,14 +18580,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -18030,6 +18607,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -18239,15 +18822,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -18294,7 +18879,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -18306,14 +18891,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -18333,6 +18918,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -18565,15 +19156,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -18620,7 +19213,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -18632,14 +19225,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -18659,6 +19252,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -18869,15 +19468,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -18924,7 +19525,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -18936,14 +19537,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -18963,6 +19564,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -19172,15 +19779,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -19227,7 +19836,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -19239,14 +19848,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -19266,6 +19875,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -19428,6 +20043,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -19518,10 +20135,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -19627,15 +20243,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -19682,7 +20300,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -19694,14 +20312,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -19721,6 +20339,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -19938,15 +20562,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -19993,7 +20619,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20005,14 +20631,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -20032,6 +20658,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -20244,15 +20876,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -20299,7 +20933,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20311,14 +20945,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -20338,6 +20972,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -20550,15 +21190,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -20605,7 +21247,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20617,14 +21259,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -20644,6 +21286,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -20856,15 +21504,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -20911,7 +21561,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20923,14 +21573,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -20950,6 +21600,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -21169,15 +21825,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -21224,7 +21882,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -21236,14 +21894,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -21263,6 +21921,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -21466,15 +22130,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -21521,7 +22187,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -21533,14 +22199,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -21560,6 +22226,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -21762,15 +22434,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -21817,7 +22491,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -21829,14 +22503,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -21856,6 +22530,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -22030,7 +22710,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -22038,7 +22719,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -22060,7 +22742,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -22095,7 +22778,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -22103,7 +22787,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -22125,7 +22810,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -22191,15 +22877,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -22246,7 +22934,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -22258,14 +22946,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -22285,6 +22973,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -22494,15 +23188,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -22549,7 +23245,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -22561,14 +23257,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -22588,6 +23284,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -22798,15 +23500,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -22853,7 +23557,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -22865,14 +23569,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -22892,6 +23596,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -23177,7 +23887,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -23185,7 +23896,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -23207,7 +23919,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -23271,7 +23984,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -23399,7 +24155,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -23407,7 +24164,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -23429,7 +24187,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -23481,7 +24240,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -23489,7 +24249,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -23511,7 +24272,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -23643,7 +24405,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -23651,7 +24414,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -23673,7 +24437,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -24143,6 +24908,12 @@

Method Details

# the location ID of the topologies. "a_key": "A String", }, + "networkTopologyIds": { # Output only. Key-value store for arbitrary network topology identifiers + # defined by the underlying infrastructure. + # The key will be the topology label and the value will be the location + # ID for the topology. + "a_key": "A String", + }, }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. @@ -24254,6 +25025,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -24344,10 +25117,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -24467,7 +25239,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -24475,7 +25248,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -24497,7 +25271,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -24652,15 +25427,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -24707,7 +25484,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -24719,14 +25496,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -24746,6 +25523,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -25001,15 +25784,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -25056,7 +25841,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -25068,14 +25853,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -25095,6 +25880,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -25305,15 +26096,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -25360,7 +26153,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -25372,14 +26165,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -25399,6 +26192,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -25851,15 +26650,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -25906,7 +26707,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -25918,14 +26719,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -25945,6 +26746,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -26160,15 +26967,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -26215,7 +27024,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -26227,14 +27036,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -26254,6 +27063,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -26466,15 +27281,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -26521,7 +27338,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -26533,14 +27350,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -26560,6 +27377,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.instantSnapshotGroups.html b/docs/dyn/compute_alpha.instantSnapshotGroups.html index 99ad981714..edf02bc922 100644 --- a/docs/dyn/compute_alpha.instantSnapshotGroups.html +++ b/docs/dyn/compute_alpha.instantSnapshotGroups.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -269,6 +271,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -934,15 +942,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -989,7 +999,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1001,14 +1011,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1028,6 +1038,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.instantSnapshots.html b/docs/dyn/compute_alpha.instantSnapshots.html index 2c4478039f..37f6f4b978 100644 --- a/docs/dyn/compute_alpha.instantSnapshots.html +++ b/docs/dyn/compute_alpha.instantSnapshots.html @@ -483,15 +483,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -538,7 +540,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -550,14 +552,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -577,6 +579,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1359,15 +1367,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1414,7 +1424,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1426,14 +1436,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1453,6 +1463,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2793,15 +2809,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2848,7 +2866,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2860,14 +2878,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2887,6 +2905,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.interconnectAttachmentGroups.html b/docs/dyn/compute_alpha.interconnectAttachmentGroups.html index fce5350e67..87fac67eaa 100644 --- a/docs/dyn/compute_alpha.interconnectAttachmentGroups.html +++ b/docs/dyn/compute_alpha.interconnectAttachmentGroups.html @@ -681,15 +681,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -736,7 +738,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -748,14 +750,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -775,6 +777,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -975,15 +983,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1030,7 +1040,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1042,14 +1052,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1069,6 +1079,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2005,15 +2021,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2060,7 +2078,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2072,14 +2090,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2099,6 +2117,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2689,15 +2713,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2744,7 +2770,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2756,14 +2782,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2783,6 +2809,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.interconnectAttachments.html b/docs/dyn/compute_alpha.interconnectAttachments.html index b098adf645..c58b44b379 100644 --- a/docs/dyn/compute_alpha.interconnectAttachments.html +++ b/docs/dyn/compute_alpha.interconnectAttachments.html @@ -763,15 +763,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -818,7 +820,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -830,14 +832,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -857,6 +859,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2209,15 +2217,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2264,7 +2274,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2276,14 +2286,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2303,6 +2313,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3424,15 +3440,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3479,7 +3497,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3491,14 +3509,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3518,6 +3536,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4610,15 +4634,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4665,7 +4691,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4677,14 +4703,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4704,6 +4730,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.interconnectGroups.html b/docs/dyn/compute_alpha.interconnectGroups.html index a0bcad2070..3489ffa993 100644 --- a/docs/dyn/compute_alpha.interconnectGroups.html +++ b/docs/dyn/compute_alpha.interconnectGroups.html @@ -305,15 +305,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -360,7 +362,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -372,14 +374,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -399,6 +401,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -599,15 +607,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -654,7 +664,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -666,14 +676,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -693,6 +703,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1701,15 +1717,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1756,7 +1774,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1768,14 +1786,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1795,6 +1813,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2372,15 +2396,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2427,7 +2453,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2439,14 +2465,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2466,6 +2492,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.interconnects.html b/docs/dyn/compute_alpha.interconnects.html index 59d348beed..d5ee7f60d9 100644 --- a/docs/dyn/compute_alpha.interconnects.html +++ b/docs/dyn/compute_alpha.interconnects.html @@ -110,6 +110,9 @@

Instance Methods

setLabels(project, resource, body=None, x__xgafv=None)

Sets the labels on an Interconnect. To learn more about labels,

+

+ setName(project, interconnect, body=None, requestId=None, x__xgafv=None)

+

Sets name of an interconnect.

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

Returns permissions that a caller has on the specified resource.

@@ -186,15 +189,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -241,7 +246,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -253,14 +258,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -280,6 +285,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1592,15 +1603,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1647,7 +1660,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1659,14 +1672,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1686,6 +1699,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2612,15 +2631,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2667,7 +2688,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2679,14 +2700,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2706,6 +2727,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3786,15 +3813,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3841,7 +3870,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3853,14 +3882,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3880,6 +3909,323 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other + # appropriate identifiers. + "a_key": "A String", + }, + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate + # identifiers. + "a_key": "A String", + }, + }, + }, + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error + # message that was returned, such as `NOT FOUND`. + "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error + # status code that was returned. For example, a `404` means the + # resource was not found. + "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is + # defined by the server. + "insertTime": "A String", # [Output Only] The time that this operation was requested. + # This value is inRFC3339 + # text format. + "instancesBulkInsertOperationMetadata": { + "perLocationStatus": { # Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. + "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an + # error. + "status": "A String", # [Output Only] Creation status of BulkInsert operation - information + # if the flow is rolling forward or rolling back. + "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. + }, + }, + }, + "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for + # Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a + # group of operations results from a `bulkInsert` API request. + "operationType": "A String", # [Output Only] The type of operation, such as `insert`, + # `update`, or `delete`, and so on. + "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. + # There is no requirement that this be linear or support any granularity of + # operations. This should not be used to guess when the operation will be + # complete. This number should monotonically increase as the operation + # progresses. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only + # applicable when performing regional operations. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. + "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, + # this field will contain information on all underlying zonal actions and + # their state. + "clientOperationId": "A String", # [Output Only] The client operation id. + "perLocationOperations": { # [Output Only] Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is + # populated. + # different programming environments, including REST APIs and RPC APIs. It is + # used by [gRPC](https://github.com/grpc). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + }, + "state": "A String", # [Output Only] Status of the action, which can be one of the following: + # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + }, + }, + }, + "startTime": "A String", # [Output Only] The time that this operation was started by the server. + # This value is inRFC3339 + # text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the + # following: + # `PENDING`, `RUNNING`, or `DONE`. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the + # operation. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation + # of the target resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For + # operations related to creating a snapshot, this points to the disk + # that the snapshot was created from. + "user": "A String", # [Output Only] User who requested the operation, for example: + # `user@example.com` or + # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. + "warnings": [ # [Output Only] If warning messages are generated during processing of the + # operation, this field will be populated. + { + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, + ], + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only + # applicable when performing per-zone operations. +}
+
+ +
+ setName(project, interconnect, body=None, requestId=None, x__xgafv=None) +
Sets name of an interconnect.
+
+Args:
+  project: string, Project ID for this request. (required)
+  interconnect: string, Name of the interconnect to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to rename an interconnect.
+  "currentName": "A String", # The current name of the interconnect.
+      # The name must be 1-63 characters long, and comply with RFC1035.
+  "name": "A String", # The new name of the interconnect.
+      # The name must be 1-63 characters long, and comply with RFC1035.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID
+so that if you must retry your request, the server will know to ignore
+the request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      { # Represents a single error encountered during the processing of an
+          # operation.
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          { # Container for structured error details providing additional context
+              # specific to the encountered error code.
+            "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users.
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the
+      # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule
+      # methods if not explicitly provided by the user.
+    "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query
+        # parameters specified minPriority/maxPriority.
+  },
   "getVersionOperationMetadata": {
     "inlineSbomInfo": {
       "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
diff --git a/docs/dyn/compute_alpha.licenses.html b/docs/dyn/compute_alpha.licenses.html
index 504fa5c6c9..0f922c3187 100644
--- a/docs/dyn/compute_alpha.licenses.html
+++ b/docs/dyn/compute_alpha.licenses.html
@@ -180,15 +180,17 @@ 

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -235,7 +237,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -247,14 +249,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -274,6 +276,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1030,15 +1038,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1085,7 +1095,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1097,14 +1107,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1124,6 +1134,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2561,15 +2577,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2616,7 +2634,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2628,14 +2646,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2655,6 +2673,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html index f6c0422113..cc09740cbd 100644 --- a/docs/dyn/compute_alpha.machineImages.html +++ b/docs/dyn/compute_alpha.machineImages.html @@ -178,15 +178,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -233,7 +235,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -245,14 +247,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -272,6 +274,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -536,7 +544,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -544,7 +553,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -566,7 +576,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -630,7 +641,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -758,7 +812,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -766,7 +821,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -788,7 +844,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -840,7 +897,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -848,7 +906,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -870,7 +929,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1317,6 +1377,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -1407,10 +1469,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1562,7 +1623,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1570,7 +1632,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1592,7 +1655,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1667,7 +1731,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1675,7 +1740,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1697,7 +1763,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1758,7 +1825,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1766,7 +1834,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1788,7 +1857,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2159,6 +2229,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -2249,10 +2321,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2833,7 +2904,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2841,7 +2913,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2863,7 +2936,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2927,7 +3001,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -3055,7 +3172,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3063,7 +3181,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3085,7 +3204,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3137,7 +3257,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3145,7 +3266,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3167,7 +3289,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3614,6 +3737,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -3704,10 +3829,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3859,7 +3983,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3867,7 +3992,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3889,7 +4015,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3964,7 +4091,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3972,7 +4100,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3994,7 +4123,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4055,7 +4185,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4063,7 +4194,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4085,7 +4217,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4456,6 +4589,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -4546,10 +4681,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4692,15 +4826,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4747,7 +4883,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4759,14 +4895,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4786,6 +4922,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -5136,7 +5278,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5144,7 +5287,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5166,7 +5310,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5230,7 +5375,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -5358,7 +5546,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5366,7 +5555,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5388,7 +5578,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5440,7 +5631,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5448,7 +5640,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5470,7 +5663,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5917,6 +6111,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -6007,10 +6203,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -6162,7 +6357,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6170,7 +6366,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -6192,7 +6389,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -6267,7 +6465,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6275,7 +6474,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -6297,7 +6497,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -6358,7 +6559,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6366,7 +6568,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -6388,7 +6591,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -6759,6 +6963,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -6849,10 +7055,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7930,15 +8135,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7985,7 +8192,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7997,14 +8204,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8024,6 +8231,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.managedRulesets.html b/docs/dyn/compute_alpha.managedRulesets.html new file mode 100644 index 0000000000..0716b336c4 --- /dev/null +++ b/docs/dyn/compute_alpha.managedRulesets.html @@ -0,0 +1,308 @@ + + + +

Compute Engine API . managedRulesets

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, managedRuleset, x__xgafv=None)

+

Gets the details for the specified managed ruleset name.

+

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

+

Retrieves the list of all the managed rulesets available.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(project, managedRuleset, x__xgafv=None) +
Gets the details for the specified managed ruleset name.
+
+Args:
+  project: string, Project ID for this request. (required)
+  managedRuleset: string, Name of the managed ruleset to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a ManagedRuleset resource.
+    #
+    # Managed internally by Cloud Armor CLH for Managed Rules features.
+    # Customers can only view these resources to modify their Security Policies.
+    # For more information, see
+    # https://cloud.google.com/armor/docs/.
+  "changeLog": "A String", # Output only. [Output Only] The change log for this managed ruleset.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # [Output Only] An optional description of this resource.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "name": "A String", # Name of the resource. Generated internally when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must
+      # be a dash, lowercase letter, or digit, except the last character, which
+      # cannot be a dash.
+  "ruleIds": [ # Output only. [Output Only] The list of managed rule IDs that are included in
+      # this managed ruleset.
+    "A String",
+  ],
+  "rulesetId": "A String", # Output only. [Output Only] The managed ruleset identifier that can be configured in
+      # Security Policy rules.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+}
+
+ +
+ list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Retrieves the list of all the managed rulesets available.
+
+Args:
+  project: string, Project ID for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "id": "A String",
+  "items": [
+    { # Represents a ManagedRuleset resource.
+        #
+        # Managed internally by Cloud Armor CLH for Managed Rules features.
+        # Customers can only view these resources to modify their Security Policies.
+        # For more information, see
+        # https://cloud.google.com/armor/docs/.
+      "changeLog": "A String", # Output only. [Output Only] The change log for this managed ruleset.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339 text format.
+      "description": "A String", # [Output Only] An optional description of this resource.
+      "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "name": "A String", # Name of the resource. Generated internally when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+          # character must be a lowercase letter, and all following characters must
+          # be a dash, lowercase letter, or digit, except the last character, which
+          # cannot be a dash.
+      "ruleIds": [ # Output only. [Output Only] The list of managed rule IDs that are included in
+          # this managed ruleset.
+        "A String",
+      ],
+      "rulesetId": "A String", # Output only. [Output Only] The managed ruleset identifier that can be configured in
+          # Security Policy rules.
+      "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+    },
+  ],
+  "nextPageToken": "A String",
+  "warning": {
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.networkAttachments.html b/docs/dyn/compute_alpha.networkAttachments.html index f4ecf53c5f..50f58aa7c1 100644 --- a/docs/dyn/compute_alpha.networkAttachments.html +++ b/docs/dyn/compute_alpha.networkAttachments.html @@ -446,15 +446,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -501,7 +503,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -513,14 +515,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -540,6 +542,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1268,15 +1276,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1323,7 +1333,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1335,14 +1345,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1362,6 +1372,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1857,15 +1873,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1912,7 +1930,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1924,14 +1942,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1951,6 +1969,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.networkEdgeSecurityServices.html b/docs/dyn/compute_alpha.networkEdgeSecurityServices.html index fbc1685624..e1face686a 100644 --- a/docs/dyn/compute_alpha.networkEdgeSecurityServices.html +++ b/docs/dyn/compute_alpha.networkEdgeSecurityServices.html @@ -399,15 +399,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -454,7 +456,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -466,14 +468,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -493,6 +495,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -780,15 +788,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -835,7 +845,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -847,14 +857,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -874,6 +884,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1112,15 +1128,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1167,7 +1185,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1179,14 +1197,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1206,6 +1224,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.networkEndpointGroups.html b/docs/dyn/compute_alpha.networkEndpointGroups.html index d4527c1c4a..1f2c1233f9 100644 --- a/docs/dyn/compute_alpha.networkEndpointGroups.html +++ b/docs/dyn/compute_alpha.networkEndpointGroups.html @@ -651,15 +651,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -706,7 +708,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -718,14 +720,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -745,6 +747,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -955,15 +963,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1010,7 +1020,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1022,14 +1032,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1049,6 +1059,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1296,15 +1312,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1351,7 +1369,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1363,14 +1381,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1390,6 +1408,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2081,15 +2105,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2136,7 +2162,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2148,14 +2174,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2175,6 +2201,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.networkFirewallPolicies.html b/docs/dyn/compute_alpha.networkFirewallPolicies.html index 59cbaf5f33..8f58e5eca7 100644 --- a/docs/dyn/compute_alpha.networkFirewallPolicies.html +++ b/docs/dyn/compute_alpha.networkFirewallPolicies.html @@ -241,15 +241,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -296,7 +298,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -308,14 +310,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -335,6 +337,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -730,15 +738,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -785,7 +795,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -797,14 +807,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -824,6 +834,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1219,15 +1235,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1274,7 +1292,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1286,14 +1304,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1313,6 +1331,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2226,15 +2250,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2281,7 +2307,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2293,14 +2319,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2320,6 +2346,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2524,15 +2556,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2579,7 +2613,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2591,14 +2625,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2618,6 +2652,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4680,15 +4720,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4735,7 +4777,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4747,14 +4789,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4774,6 +4816,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6156,15 +6204,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6211,7 +6261,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6223,14 +6273,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6250,6 +6300,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6467,15 +6523,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6522,7 +6580,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6534,14 +6592,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6561,6 +6619,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6953,15 +7017,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7008,7 +7074,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7020,14 +7086,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7047,6 +7113,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7439,15 +7511,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7494,7 +7568,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7506,14 +7580,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7533,6 +7607,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7733,15 +7813,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7788,7 +7870,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7800,14 +7882,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7827,6 +7909,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -8027,15 +8115,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8082,7 +8172,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8094,14 +8184,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8121,6 +8211,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -8321,15 +8417,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8376,7 +8474,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8388,14 +8486,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8415,6 +8513,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.networks.html b/docs/dyn/compute_alpha.networks.html index dc64ce096f..fe44f4c0d8 100644 --- a/docs/dyn/compute_alpha.networks.html +++ b/docs/dyn/compute_alpha.networks.html @@ -303,15 +303,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -358,7 +360,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -370,14 +372,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -397,6 +399,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -605,15 +613,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -660,7 +670,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -672,14 +682,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -699,6 +709,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -903,15 +919,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -958,7 +976,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -970,14 +988,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -997,6 +1015,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2675,15 +2699,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2730,7 +2756,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2742,14 +2768,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2769,6 +2795,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3990,15 +4022,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4045,7 +4079,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4057,14 +4091,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4084,6 +4118,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4290,15 +4330,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4345,7 +4387,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4357,14 +4399,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4384,6 +4426,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4591,15 +4639,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4646,7 +4696,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4658,14 +4708,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4685,6 +4735,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4884,15 +4940,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4939,7 +4997,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4951,14 +5009,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4978,6 +5036,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -5289,15 +5353,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5344,7 +5410,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5356,14 +5422,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5383,6 +5449,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.nodeGroups.html b/docs/dyn/compute_alpha.nodeGroups.html index 8c5c4ddb5e..778145ce8c 100644 --- a/docs/dyn/compute_alpha.nodeGroups.html +++ b/docs/dyn/compute_alpha.nodeGroups.html @@ -207,15 +207,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -262,7 +264,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -274,14 +276,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -301,6 +303,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -799,15 +807,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -854,7 +864,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -866,14 +876,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -893,6 +903,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1102,15 +1118,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1157,7 +1175,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1169,14 +1187,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1196,6 +1214,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1983,15 +2007,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2038,7 +2064,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2050,14 +2076,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2077,6 +2103,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2875,15 +2907,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2930,7 +2964,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2942,14 +2976,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2969,6 +3003,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3179,15 +3219,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3234,7 +3276,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3246,14 +3288,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3273,6 +3315,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4356,15 +4404,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4411,7 +4461,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4423,14 +4473,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4450,6 +4500,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4660,15 +4716,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4715,7 +4773,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4727,14 +4785,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4754,6 +4812,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.nodeTemplates.html b/docs/dyn/compute_alpha.nodeTemplates.html index 70f805dbc8..2b07d00484 100644 --- a/docs/dyn/compute_alpha.nodeTemplates.html +++ b/docs/dyn/compute_alpha.nodeTemplates.html @@ -450,15 +450,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -505,7 +507,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -517,14 +519,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -544,6 +546,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1281,15 +1289,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1336,7 +1346,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1348,14 +1358,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1375,6 +1385,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.orgVmExtensionPolicies.html b/docs/dyn/compute_alpha.orgVmExtensionPolicies.html index cc10a14e71..ba524327e2 100644 --- a/docs/dyn/compute_alpha.orgVmExtensionPolicies.html +++ b/docs/dyn/compute_alpha.orgVmExtensionPolicies.html @@ -154,15 +154,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -209,7 +211,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -221,14 +223,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -248,6 +250,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.organizationGlobalVmExtensionPolicies.html b/docs/dyn/compute_alpha.organizationGlobalVmExtensionPolicies.html index 98441b9361..22494af556 100644 --- a/docs/dyn/compute_alpha.organizationGlobalVmExtensionPolicies.html +++ b/docs/dyn/compute_alpha.organizationGlobalVmExtensionPolicies.html @@ -234,6 +234,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -484,15 +498,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -539,7 +555,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -551,14 +567,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -578,6 +594,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -733,6 +755,20 @@

Method Details

"extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration. # The key is the name of the extension. "a_key": { # Policy for a single extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The version pinning for the extension. # If empty, the extension will be installed with the latest version # released by the extension producer. @@ -897,6 +933,20 @@

Method Details

"extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration. # The key is the name of the extension. "a_key": { # Policy for a single extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The version pinning for the extension. # If empty, the extension will be installed with the latest version # released by the extension producer. @@ -1073,15 +1123,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1128,7 +1180,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1140,14 +1192,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1167,6 +1219,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1408,6 +1466,20 @@

Method Details

"extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration. # The key is the name of the extension. "a_key": { # Policy for a single extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The version pinning for the extension. # If empty, the extension will be installed with the latest version # released by the extension producer. @@ -1768,6 +1840,20 @@

Method Details

"extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration. # The key is the name of the extension. "a_key": { # Policy for a single extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The version pinning for the extension. # If empty, the extension will be installed with the latest version # released by the extension producer. @@ -1944,15 +2030,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1999,7 +2087,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2011,14 +2099,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2038,6 +2126,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.organizationRolloutPlans.html b/docs/dyn/compute_alpha.organizationRolloutPlans.html index 610096509c..c53c938f4c 100644 --- a/docs/dyn/compute_alpha.organizationRolloutPlans.html +++ b/docs/dyn/compute_alpha.organizationRolloutPlans.html @@ -165,15 +165,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -220,7 +222,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -232,14 +234,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -259,6 +261,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -668,15 +676,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -723,7 +733,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -735,14 +745,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -762,6 +772,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.organizationRollouts.html b/docs/dyn/compute_alpha.organizationRollouts.html index 77795513d9..c719d0db69 100644 --- a/docs/dyn/compute_alpha.organizationRollouts.html +++ b/docs/dyn/compute_alpha.organizationRollouts.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -264,6 +266,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -467,15 +475,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -522,7 +532,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -534,14 +544,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -561,6 +571,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -765,15 +781,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -820,7 +838,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -832,14 +850,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -859,6 +877,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1402,15 +1426,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1457,7 +1483,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1469,14 +1495,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1496,6 +1522,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1698,15 +1730,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1753,7 +1787,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1765,14 +1799,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1792,6 +1826,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.organizationSecurityPolicies.html b/docs/dyn/compute_alpha.organizationSecurityPolicies.html index 47e899dcf5..dee9641d8c 100644 --- a/docs/dyn/compute_alpha.organizationSecurityPolicies.html +++ b/docs/dyn/compute_alpha.organizationSecurityPolicies.html @@ -224,15 +224,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -279,7 +281,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -291,14 +293,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -318,6 +320,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1023,15 +1031,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1078,7 +1088,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1090,14 +1100,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1117,6 +1127,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1326,15 +1342,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1381,7 +1399,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1393,14 +1411,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1420,6 +1438,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1622,15 +1646,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1677,7 +1703,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1689,14 +1715,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1716,6 +1742,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3998,15 +4030,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4053,7 +4087,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4065,14 +4099,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4092,6 +4126,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -5378,15 +5418,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5433,7 +5475,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5445,14 +5487,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5472,6 +5514,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6428,15 +6476,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6483,7 +6533,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6495,14 +6545,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6522,6 +6572,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7230,15 +7286,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7285,7 +7343,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7297,14 +7355,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7324,6 +7382,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7528,15 +7592,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7583,7 +7649,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7595,14 +7661,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7622,6 +7688,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7826,15 +7898,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7881,7 +7955,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7893,14 +7967,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7920,6 +7994,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html b/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html index 2332d736a7..7d6eb8ad66 100644 --- a/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html +++ b/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html @@ -241,15 +241,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -296,7 +298,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -308,14 +310,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -335,6 +337,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.organizationZoneVmExtensionPolicies.html b/docs/dyn/compute_alpha.organizationZoneVmExtensionPolicies.html index 39b6c50a02..49d8511e53 100644 --- a/docs/dyn/compute_alpha.organizationZoneVmExtensionPolicies.html +++ b/docs/dyn/compute_alpha.organizationZoneVmExtensionPolicies.html @@ -131,6 +131,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -225,6 +239,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -337,15 +365,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -392,7 +422,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -404,14 +434,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -431,6 +461,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -678,6 +714,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -968,6 +1018,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -1080,15 +1144,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1135,7 +1201,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1147,14 +1213,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1174,6 +1240,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.packetMirrorings.html b/docs/dyn/compute_alpha.packetMirrorings.html index f32955591e..322f51cd97 100644 --- a/docs/dyn/compute_alpha.packetMirrorings.html +++ b/docs/dyn/compute_alpha.packetMirrorings.html @@ -476,15 +476,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -531,7 +533,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -543,14 +545,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -570,6 +572,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -998,15 +1006,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1053,7 +1063,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1065,14 +1075,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1092,6 +1102,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1658,15 +1674,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1713,7 +1731,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1725,14 +1743,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1752,6 +1770,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.previewFeatures.html b/docs/dyn/compute_alpha.previewFeatures.html index e0b4ff442a..123947222f 100644 --- a/docs/dyn/compute_alpha.previewFeatures.html +++ b/docs/dyn/compute_alpha.previewFeatures.html @@ -503,15 +503,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -558,7 +560,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -570,14 +572,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -597,6 +599,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.projectViews.html b/docs/dyn/compute_alpha.projectViews.html index b97cc84256..573d26a29e 100644 --- a/docs/dyn/compute_alpha.projectViews.html +++ b/docs/dyn/compute_alpha.projectViews.html @@ -90,6 +90,12 @@

Method Details

get(project, region, x__xgafv=None)
Returns the specified global ProjectViews resource, with a regional
 context.
+This regional API endpoint reads resource metadata from regional
+read-only replicas. Because changes are copied to these regional replicas
+asynchronously, for real-time resource reads or any write operations
+(creating, updating, or deleting resources), use the global
+[projects.get](https://cloud.google.com/compute/docs/reference/rest/v1/projects/get)
+endpoint.
 
 Args:
   project: string, Required. Project ID for this request. This is part of the URL path. (required)
@@ -107,6 +113,11 @@ 

Method Details

# A ProjectView resource contains read-only project data which is available # globally. "project": { # Represents a Project resource. # The project data. + # The returned Project data does not contain regional or zonal quota + # usage data. Global quota limits are present. For accurate, real-time quota + # usage numbers, query the global + # [projects.get](https://cloud.google.com/compute/docs/reference/rest/v1/projects/get) + # endpoint. # # A project is used to organize resources in a Google Cloud Platform # environment. For more information, read about the diff --git a/docs/dyn/compute_alpha.projects.html b/docs/dyn/compute_alpha.projects.html index 73c80f7a5a..e06b9756b8 100644 --- a/docs/dyn/compute_alpha.projects.html +++ b/docs/dyn/compute_alpha.projects.html @@ -203,15 +203,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -258,7 +260,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -270,14 +272,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -297,6 +299,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -508,15 +516,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -563,7 +573,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -575,14 +585,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -602,6 +612,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -800,15 +816,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -855,7 +873,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -867,14 +885,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -894,6 +912,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1106,15 +1130,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1161,7 +1187,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1173,14 +1199,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1200,6 +1226,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2028,15 +2060,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2083,7 +2117,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2095,14 +2129,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2122,6 +2156,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2344,15 +2384,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2399,7 +2441,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2411,14 +2453,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2438,6 +2480,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2646,15 +2694,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2701,7 +2751,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2713,14 +2763,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2740,6 +2790,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2970,15 +3026,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3025,7 +3083,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3037,14 +3095,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3064,6 +3122,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3271,15 +3335,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3326,7 +3392,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3338,14 +3404,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3365,6 +3431,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3572,15 +3644,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3627,7 +3701,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3639,14 +3713,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3666,6 +3740,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3874,15 +3954,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3929,7 +4011,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3941,14 +4023,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3968,6 +4050,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4183,15 +4271,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4238,7 +4328,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4250,14 +4340,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4277,6 +4367,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html b/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html index c58cecb77c..317601270a 100644 --- a/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html +++ b/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html @@ -169,15 +169,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -224,7 +226,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -236,14 +238,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -263,6 +265,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -467,15 +475,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -522,7 +532,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -534,14 +544,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -561,6 +571,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -927,15 +943,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -982,7 +1000,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -994,14 +1012,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1021,6 +1039,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1523,15 +1547,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1578,7 +1604,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1590,14 +1616,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1617,6 +1643,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1816,15 +1848,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1871,7 +1905,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1883,14 +1917,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1910,6 +1944,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.publicDelegatedPrefixes.html b/docs/dyn/compute_alpha.publicDelegatedPrefixes.html index f7b7cfaf8d..7fcbc1d370 100644 --- a/docs/dyn/compute_alpha.publicDelegatedPrefixes.html +++ b/docs/dyn/compute_alpha.publicDelegatedPrefixes.html @@ -486,15 +486,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -541,7 +543,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -553,14 +555,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -580,6 +582,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -785,15 +793,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -840,7 +850,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -852,14 +862,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -879,6 +889,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1323,15 +1339,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1378,7 +1396,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1390,14 +1408,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1417,6 +1435,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1998,15 +2022,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2053,7 +2079,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2065,14 +2091,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2092,6 +2118,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2293,15 +2325,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2348,7 +2382,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2360,14 +2394,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2387,6 +2421,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.recoverableSnapshots.html b/docs/dyn/compute_alpha.recoverableSnapshots.html index fea02ac029..d3f0632ca1 100644 --- a/docs/dyn/compute_alpha.recoverableSnapshots.html +++ b/docs/dyn/compute_alpha.recoverableSnapshots.html @@ -355,7 +355,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -363,7 +364,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -385,7 +387,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -415,7 +418,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -423,7 +427,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -445,7 +450,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -472,7 +478,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -480,7 +487,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -502,7 +510,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -694,15 +703,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -749,7 +760,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -761,14 +772,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -788,6 +799,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1068,7 +1085,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1076,7 +1094,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1098,7 +1117,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1128,7 +1148,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1136,7 +1157,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1158,7 +1180,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1185,7 +1208,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1193,7 +1217,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1215,7 +1240,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1854,7 +1880,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1862,7 +1889,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1884,7 +1912,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1914,7 +1943,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1922,7 +1952,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1944,7 +1975,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1971,7 +2003,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1979,7 +2012,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2001,7 +2035,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2165,15 +2200,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2220,7 +2257,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2232,14 +2269,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2259,6 +2296,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionAutoscalers.html b/docs/dyn/compute_alpha.regionAutoscalers.html index bb178e1f84..3ec32de8c6 100644 --- a/docs/dyn/compute_alpha.regionAutoscalers.html +++ b/docs/dyn/compute_alpha.regionAutoscalers.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -269,6 +271,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1221,15 +1229,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1276,7 +1286,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1288,14 +1298,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1315,6 +1325,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2404,15 +2420,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2459,7 +2477,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2471,14 +2489,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2498,6 +2516,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3102,15 +3126,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3157,7 +3183,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3169,14 +3195,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3196,6 +3222,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionBackendBuckets.html b/docs/dyn/compute_alpha.regionBackendBuckets.html index ec0410a235..ad9b7c6b06 100644 --- a/docs/dyn/compute_alpha.regionBackendBuckets.html +++ b/docs/dyn/compute_alpha.regionBackendBuckets.html @@ -188,15 +188,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -243,7 +245,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -255,14 +257,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -282,6 +284,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1257,15 +1265,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1312,7 +1322,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1324,14 +1334,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1351,6 +1361,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2441,15 +2457,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2496,7 +2514,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2508,14 +2526,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2535,6 +2553,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index 68dbff8243..8aaef1a28d 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -193,15 +193,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -248,7 +250,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -260,14 +262,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -287,6 +289,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2055,7 +2063,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -4254,7 +4266,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -4455,15 +4471,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4510,7 +4528,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4522,14 +4540,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4549,6 +4567,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6403,7 +6427,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -8304,7 +8332,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -10144,7 +10176,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -10345,15 +10381,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10400,7 +10438,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10412,14 +10450,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10439,6 +10477,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -11524,15 +11568,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11579,7 +11625,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11591,14 +11637,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11618,6 +11664,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -13418,7 +13470,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -13619,15 +13675,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13674,7 +13732,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13686,14 +13744,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13713,6 +13771,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionCommitments.html b/docs/dyn/compute_alpha.regionCommitments.html index 1fd940eaca..94762f1c38 100644 --- a/docs/dyn/compute_alpha.regionCommitments.html +++ b/docs/dyn/compute_alpha.regionCommitments.html @@ -842,15 +842,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -897,7 +899,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -909,14 +911,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -936,6 +938,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1136,15 +1144,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1191,7 +1201,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1203,14 +1213,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1230,6 +1240,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2391,15 +2407,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2446,7 +2464,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2458,14 +2476,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2485,6 +2503,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3814,15 +3838,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3869,7 +3895,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3881,14 +3907,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3908,6 +3934,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4391,15 +4423,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4446,7 +4480,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4458,14 +4492,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4485,6 +4519,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionCompositeHealthChecks.html b/docs/dyn/compute_alpha.regionCompositeHealthChecks.html index 7bca47a14a..55022a33db 100644 --- a/docs/dyn/compute_alpha.regionCompositeHealthChecks.html +++ b/docs/dyn/compute_alpha.regionCompositeHealthChecks.html @@ -419,15 +419,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -474,7 +476,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -486,14 +488,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -513,6 +515,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -849,15 +857,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -904,7 +914,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -916,14 +926,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -943,6 +953,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1386,15 +1402,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1441,7 +1459,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1453,14 +1471,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1480,6 +1498,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionDiskSettings.html b/docs/dyn/compute_alpha.regionDiskSettings.html index 67a301258a..834ff9af91 100644 --- a/docs/dyn/compute_alpha.regionDiskSettings.html +++ b/docs/dyn/compute_alpha.regionDiskSettings.html @@ -284,15 +284,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -339,7 +341,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -351,14 +353,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -378,6 +380,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionDisks.html b/docs/dyn/compute_alpha.regionDisks.html index bab4bd7ab1..f5958cfb6d 100644 --- a/docs/dyn/compute_alpha.regionDisks.html +++ b/docs/dyn/compute_alpha.regionDisks.html @@ -220,15 +220,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -275,7 +277,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -287,14 +289,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -314,6 +316,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -561,15 +569,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -616,7 +626,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -628,14 +638,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -655,6 +665,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -951,7 +967,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -959,7 +976,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -981,7 +999,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1011,7 +1030,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1019,7 +1039,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1041,7 +1062,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1077,7 +1099,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1085,7 +1108,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1107,7 +1131,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1200,15 +1225,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1255,7 +1282,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1267,14 +1294,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1294,6 +1321,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1498,15 +1531,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1553,7 +1588,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1565,14 +1600,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1592,6 +1627,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1861,7 +1902,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1869,7 +1911,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1891,7 +1934,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2123,7 +2167,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2131,7 +2176,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2153,7 +2199,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2206,7 +2253,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2214,7 +2262,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2236,7 +2285,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2274,7 +2324,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2282,7 +2333,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2304,7 +2356,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2921,7 +2974,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2929,7 +2983,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2951,7 +3006,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3183,7 +3239,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3191,7 +3248,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3213,7 +3271,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3266,7 +3325,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3274,7 +3334,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3296,7 +3357,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3334,7 +3396,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3342,7 +3405,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3364,7 +3428,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3471,15 +3536,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3526,7 +3593,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3538,14 +3605,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3565,6 +3632,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3920,7 +3993,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3928,7 +4002,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3950,7 +4025,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4182,7 +4258,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4190,7 +4267,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4212,7 +4290,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4265,7 +4344,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4273,7 +4353,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4295,7 +4376,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4333,7 +4415,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4341,7 +4424,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4363,7 +4447,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4536,15 +4621,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4591,7 +4678,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4603,14 +4690,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4630,6 +4717,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4837,15 +4930,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4892,7 +4987,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4904,14 +4999,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4931,6 +5026,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6021,15 +6122,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6076,7 +6179,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6088,14 +6191,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6115,6 +6218,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6344,15 +6453,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6399,7 +6510,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6411,14 +6522,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6438,6 +6549,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6639,15 +6756,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6694,7 +6813,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6706,14 +6825,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6733,6 +6852,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6954,15 +7079,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7009,7 +7136,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7021,14 +7148,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7048,6 +7175,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7347,7 +7480,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7355,7 +7489,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7377,7 +7512,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7609,7 +7745,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7617,7 +7754,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7639,7 +7777,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7692,7 +7831,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7700,7 +7840,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7722,7 +7863,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7760,7 +7902,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7768,7 +7911,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7790,7 +7934,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7898,15 +8043,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7953,7 +8100,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7965,14 +8112,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7992,6 +8139,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -8211,15 +8364,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8266,7 +8421,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8278,14 +8433,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8305,6 +8460,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -8513,15 +8674,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8568,7 +8731,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8580,14 +8743,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8607,6 +8770,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionHealthAggregationPolicies.html b/docs/dyn/compute_alpha.regionHealthAggregationPolicies.html index e0a1456f08..f279ed32d0 100644 --- a/docs/dyn/compute_alpha.regionHealthAggregationPolicies.html +++ b/docs/dyn/compute_alpha.regionHealthAggregationPolicies.html @@ -432,15 +432,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -487,7 +489,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -499,14 +501,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -526,6 +528,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -864,15 +872,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -919,7 +929,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -931,14 +941,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -958,6 +968,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1434,15 +1450,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1489,7 +1507,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1501,14 +1519,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1528,6 +1546,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionHealthCheckServices.html b/docs/dyn/compute_alpha.regionHealthCheckServices.html index b45ecba6ab..865399508f 100644 --- a/docs/dyn/compute_alpha.regionHealthCheckServices.html +++ b/docs/dyn/compute_alpha.regionHealthCheckServices.html @@ -450,15 +450,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -505,7 +507,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -517,14 +519,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -544,6 +546,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -917,15 +925,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -972,7 +982,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -984,14 +994,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1011,6 +1021,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1522,15 +1538,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1577,7 +1595,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1589,14 +1607,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1616,6 +1634,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionHealthChecks.html b/docs/dyn/compute_alpha.regionHealthChecks.html index 0af68de80f..dbda6a1920 100644 --- a/docs/dyn/compute_alpha.regionHealthChecks.html +++ b/docs/dyn/compute_alpha.regionHealthChecks.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -269,6 +271,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -676,7 +684,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -763,8 +771,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "udpHealthCheck": { "port": 42, # The UDP port number to which the health check prober sends packets. Valid # values are 1 through 65535. @@ -1049,7 +1058,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -1136,8 +1145,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "udpHealthCheck": { "port": 42, # The UDP port number to which the health check prober sends packets. Valid # values are 1 through 65535. @@ -1211,15 +1221,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1266,7 +1278,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1278,14 +1290,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1305,6 +1317,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1798,7 +1816,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -1885,8 +1903,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "udpHealthCheck": { "port": 42, # The UDP port number to which the health check prober sends packets. Valid # values are 1 through 65535. @@ -2222,7 +2241,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -2309,8 +2328,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "udpHealthCheck": { "port": 42, # The UDP port number to which the health check prober sends packets. Valid # values are 1 through 65535. @@ -2384,15 +2404,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2439,7 +2461,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2451,14 +2473,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2478,6 +2500,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2915,7 +2943,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -3002,8 +3030,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "udpHealthCheck": { "port": 42, # The UDP port number to which the health check prober sends packets. Valid # values are 1 through 65535. @@ -3077,15 +3106,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3132,7 +3163,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3144,14 +3175,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3171,6 +3202,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionHealthSources.html b/docs/dyn/compute_alpha.regionHealthSources.html index 3b89345c5b..1e811a9abc 100644 --- a/docs/dyn/compute_alpha.regionHealthSources.html +++ b/docs/dyn/compute_alpha.regionHealthSources.html @@ -422,15 +422,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -477,7 +479,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -489,14 +491,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -516,6 +518,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -871,15 +879,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -926,7 +936,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -938,14 +948,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -965,6 +975,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1414,15 +1430,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1469,7 +1487,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1481,14 +1499,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1508,6 +1526,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html b/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html index 2eeb8c9ca3..17f22e2a5d 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html @@ -171,15 +171,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -226,7 +228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -238,14 +240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -265,6 +267,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -476,15 +484,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -531,7 +541,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -543,14 +553,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -570,6 +580,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -857,15 +873,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -912,7 +930,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -924,14 +942,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -962,15 +980,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1017,7 +1037,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1029,14 +1049,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1231,15 +1251,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1286,7 +1308,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1298,14 +1320,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1336,15 +1358,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1391,7 +1415,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1403,14 +1427,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1515,15 +1539,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1570,7 +1596,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1582,14 +1608,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1609,6 +1635,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1981,15 +2013,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2036,7 +2070,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2048,14 +2082,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2086,15 +2120,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2141,7 +2177,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2153,14 +2189,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html index 162346d217..1eed9a5b2a 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html @@ -266,15 +266,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -321,7 +323,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -333,14 +335,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -360,6 +362,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -642,15 +650,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -697,7 +707,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -709,14 +719,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -736,6 +746,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -880,7 +896,7 @@

Method Details

The object takes the form of: { # RegionInstanceGroupManagers.applyUpdatesToInstances - "allInstances": True or False, # Flag to update all instances instead of specified list of “instances”. + "allInstances": True or False, # Flag to update all instances instead of specified list of "instances". # If the flag is set to true then the instances may not be specified # in the request. "allowedActions": [ # Actions that are allowed to update instances within MIG. @@ -975,15 +991,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1030,7 +1048,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1042,14 +1060,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1069,6 +1087,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1355,15 +1379,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1410,7 +1436,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1422,14 +1448,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1449,6 +1475,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1652,15 +1684,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1707,7 +1741,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1719,14 +1753,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1746,6 +1780,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1979,15 +2019,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2034,7 +2076,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2046,14 +2088,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2073,6 +2115,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2271,15 +2319,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2326,7 +2376,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2338,14 +2388,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2365,6 +2415,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2530,6 +2586,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", }, @@ -2760,7 +2817,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2768,7 +2826,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2790,7 +2849,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2854,7 +2914,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -2982,7 +3085,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2990,7 +3094,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3012,7 +3117,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3064,7 +3170,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3072,7 +3179,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3094,7 +3202,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3241,7 +3350,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3249,7 +3359,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3271,7 +3382,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3335,7 +3447,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -3463,7 +3618,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3471,7 +3627,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3493,7 +3650,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3545,7 +3703,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3553,7 +3712,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3575,7 +3735,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3848,15 +4009,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3903,7 +4066,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3915,14 +4078,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3958,15 +4121,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4013,7 +4178,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4025,14 +4190,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4356,6 +4521,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", }, @@ -4586,7 +4752,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4594,7 +4761,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4616,7 +4784,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4680,7 +4849,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -4808,7 +5020,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4816,7 +5029,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4838,7 +5052,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4890,7 +5105,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4898,7 +5114,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4920,7 +5137,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5067,7 +5285,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5075,7 +5294,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5097,7 +5317,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5161,7 +5382,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -5289,7 +5553,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5297,7 +5562,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5319,7 +5585,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5371,7 +5638,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5379,7 +5647,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5401,7 +5670,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5674,15 +5944,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5729,7 +6001,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5741,14 +6013,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5784,15 +6056,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5839,7 +6113,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5851,14 +6125,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6206,15 +6480,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6261,7 +6537,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6273,14 +6549,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6300,6 +6576,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6551,6 +6833,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", }, @@ -6781,7 +7064,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6789,7 +7073,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -6811,7 +7096,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -6875,7 +7161,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -7003,7 +7332,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7011,7 +7341,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7033,7 +7364,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7085,7 +7417,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7093,7 +7426,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7115,7 +7449,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7262,7 +7597,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7270,7 +7606,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7292,7 +7629,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7356,7 +7694,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -7484,7 +7865,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7492,7 +7874,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7514,7 +7897,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7566,7 +7950,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7574,7 +7959,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7596,7 +7982,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7869,15 +8256,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7924,7 +8313,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7936,14 +8325,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7979,15 +8368,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8034,7 +8425,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8046,14 +8437,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8763,7 +9154,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8771,7 +9163,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8793,7 +9186,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8857,7 +9251,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -8985,7 +9422,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8993,7 +9431,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9015,7 +9454,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9067,7 +9507,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9075,7 +9516,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9097,7 +9539,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9196,15 +9639,17 @@

Method Details

# delete the instance. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9251,7 +9696,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9263,14 +9708,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9455,7 +9900,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9463,7 +9909,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9485,7 +9932,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9549,7 +9997,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -9677,7 +10168,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9685,7 +10177,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9707,7 +10200,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9759,7 +10253,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9767,7 +10262,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9789,7 +10285,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10201,6 +10698,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", }, @@ -10431,7 +10929,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10439,7 +10938,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10461,7 +10961,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10525,7 +11026,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -10653,7 +11197,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10661,7 +11206,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10683,7 +11229,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10735,7 +11282,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10743,7 +11291,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10765,7 +11314,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10912,7 +11462,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10920,7 +11471,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10942,7 +11494,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11006,7 +11559,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -11134,7 +11730,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -11142,7 +11739,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -11164,7 +11762,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11216,7 +11815,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -11224,7 +11824,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -11246,7 +11847,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11519,15 +12121,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11574,7 +12178,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11586,14 +12190,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11629,15 +12233,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11684,7 +12290,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11696,14 +12302,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12051,15 +12657,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12106,7 +12714,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12118,14 +12726,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12145,6 +12753,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -12423,15 +13037,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12478,7 +13094,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12490,14 +13106,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12517,6 +13133,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -12741,15 +13363,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12796,7 +13420,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12808,14 +13432,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12835,6 +13459,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -13049,15 +13679,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13104,7 +13736,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13116,14 +13748,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13143,6 +13775,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -13390,15 +14028,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13445,7 +14085,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13457,14 +14097,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13484,6 +14124,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -13709,15 +14355,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13764,7 +14412,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13776,14 +14424,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13803,6 +14451,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -14067,15 +14721,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14122,7 +14778,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14134,14 +14790,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14161,6 +14817,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -14370,15 +15032,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14425,7 +15089,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14437,14 +15101,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14464,6 +15128,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -14678,15 +15348,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14733,7 +15405,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14745,14 +15417,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14772,6 +15444,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -14997,15 +15675,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15052,7 +15732,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15064,14 +15744,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15091,6 +15771,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -15329,15 +16015,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15384,7 +16072,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15396,14 +16084,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15423,6 +16111,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -15659,15 +16353,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15714,7 +16410,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15726,14 +16422,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15753,6 +16449,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -15958,6 +16660,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", }, @@ -16188,7 +16891,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -16196,7 +16900,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -16218,7 +16923,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -16282,7 +16988,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -16410,7 +17159,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -16418,7 +17168,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -16440,7 +17191,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -16492,7 +17244,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -16500,7 +17253,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -16522,7 +17276,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -16669,7 +17424,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -16677,7 +17433,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -16699,7 +17456,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -16763,7 +17521,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -16891,7 +17692,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -16899,7 +17701,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -16921,7 +17724,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -16973,7 +17777,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -16981,7 +17786,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -17003,7 +17809,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -17276,15 +18083,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17331,7 +18140,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17343,14 +18152,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17386,15 +18195,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17441,7 +18252,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17453,14 +18264,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17808,15 +18619,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17863,7 +18676,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17875,14 +18688,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17902,6 +18715,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -18180,15 +18999,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -18235,7 +19056,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -18247,14 +19068,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -18274,6 +19095,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionInstanceGroups.html b/docs/dyn/compute_alpha.regionInstanceGroups.html index 02b53cc36b..3519649719 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroups.html +++ b/docs/dyn/compute_alpha.regionInstanceGroups.html @@ -660,15 +660,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -715,7 +717,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -727,14 +729,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -754,6 +756,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionInstanceTemplates.html b/docs/dyn/compute_alpha.regionInstanceTemplates.html index 912ed35472..c606434d41 100644 --- a/docs/dyn/compute_alpha.regionInstanceTemplates.html +++ b/docs/dyn/compute_alpha.regionInstanceTemplates.html @@ -167,15 +167,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -222,7 +224,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -234,14 +236,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -261,6 +263,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -548,7 +556,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -556,7 +565,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -578,7 +588,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -642,7 +653,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -770,7 +824,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -778,7 +833,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -800,7 +856,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -852,7 +909,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -860,7 +918,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -882,7 +941,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1329,6 +1389,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -1419,10 +1481,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1724,7 +1785,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1732,7 +1794,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1754,7 +1817,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1818,7 +1882,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -1946,7 +2053,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1954,7 +2062,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1976,7 +2085,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2028,7 +2138,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2036,7 +2147,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2058,7 +2170,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2505,6 +2618,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -2595,10 +2710,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2814,15 +2928,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2869,7 +2985,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2881,14 +2997,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2908,6 +3024,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3281,7 +3403,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3289,7 +3412,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3311,7 +3435,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3375,7 +3500,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -3503,7 +3671,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3511,7 +3680,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3533,7 +3703,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3585,7 +3756,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3593,7 +3765,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3615,7 +3788,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4062,6 +4236,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -4152,10 +4328,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. diff --git a/docs/dyn/compute_alpha.regionInstances.html b/docs/dyn/compute_alpha.regionInstances.html index 291e012664..d4ad851ace 100644 --- a/docs/dyn/compute_alpha.regionInstances.html +++ b/docs/dyn/compute_alpha.regionInstances.html @@ -172,7 +172,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -180,7 +181,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -202,7 +204,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -266,7 +269,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -394,7 +440,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -402,7 +449,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -424,7 +472,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -476,7 +525,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -484,7 +534,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -506,7 +557,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -698,7 +750,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -706,7 +759,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -728,7 +782,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -792,7 +847,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -920,7 +1018,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -928,7 +1027,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -950,7 +1050,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1002,7 +1103,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1010,7 +1112,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1032,7 +1135,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1479,6 +1583,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -1569,10 +1675,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1821,15 +1926,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1876,7 +1983,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1888,14 +1995,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1915,6 +2022,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html b/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html index 7dff3188dc..98d3cfa1ad 100644 --- a/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html +++ b/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -269,6 +271,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -935,15 +943,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -990,7 +1000,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1002,14 +1012,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1029,6 +1039,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionInstantSnapshots.html b/docs/dyn/compute_alpha.regionInstantSnapshots.html index d8cce0450d..ab064cbd5b 100644 --- a/docs/dyn/compute_alpha.regionInstantSnapshots.html +++ b/docs/dyn/compute_alpha.regionInstantSnapshots.html @@ -185,15 +185,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -240,7 +242,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -252,14 +254,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -279,6 +281,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1061,15 +1069,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1116,7 +1126,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1128,14 +1138,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1155,6 +1165,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2495,15 +2511,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2550,7 +2568,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2562,14 +2580,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2589,6 +2607,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionMultiMigs.html b/docs/dyn/compute_alpha.regionMultiMigs.html index 7d055c0645..7dba8bd3c0 100644 --- a/docs/dyn/compute_alpha.regionMultiMigs.html +++ b/docs/dyn/compute_alpha.regionMultiMigs.html @@ -166,15 +166,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -221,7 +223,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -233,14 +235,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -260,6 +262,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -449,15 +457,17 @@

Method Details

"error": { # Output only. [Output Only] Encountered errors on the last state check. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -504,7 +514,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -516,14 +526,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -609,15 +619,17 @@

Method Details

"error": { # Output only. [Output Only] Encountered errors on the last state check. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -664,7 +676,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -676,14 +688,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -777,15 +789,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -832,7 +846,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -844,14 +858,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -871,6 +885,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1145,15 +1165,17 @@

Method Details

"error": { # Output only. [Output Only] Encountered errors on the last state check. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1200,7 +1222,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1212,14 +1234,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html index 19ba5e72c7..a5ad283d82 100644 --- a/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html @@ -220,15 +220,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -275,7 +277,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -287,14 +289,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -314,6 +316,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -522,15 +530,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -577,7 +587,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -589,14 +599,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -616,6 +626,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -864,15 +880,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -919,7 +937,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -931,14 +949,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -958,6 +976,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1649,15 +1673,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1704,7 +1730,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1716,14 +1742,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1743,6 +1769,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html index dc139b87f5..1a95385f31 100644 --- a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html @@ -227,15 +227,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -282,7 +284,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -294,14 +296,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -321,6 +323,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -717,15 +725,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -772,7 +782,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -784,14 +794,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -811,6 +821,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1012,15 +1028,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1067,7 +1085,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1079,14 +1097,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1106,6 +1124,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1311,15 +1335,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1366,7 +1392,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1378,14 +1404,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1405,6 +1431,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3849,15 +3881,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3904,7 +3938,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3916,14 +3950,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3943,6 +3977,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -5328,15 +5368,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5383,7 +5425,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5395,14 +5437,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5422,6 +5464,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -5640,15 +5688,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5695,7 +5745,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5707,14 +5757,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5734,6 +5784,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6127,15 +6183,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6182,7 +6240,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6194,14 +6252,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6221,6 +6279,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6422,15 +6486,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6477,7 +6543,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6489,14 +6555,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6516,6 +6582,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6717,15 +6789,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6772,7 +6846,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6784,14 +6858,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6811,6 +6885,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionNetworkPolicies.html b/docs/dyn/compute_alpha.regionNetworkPolicies.html index f58251207a..7488496b87 100644 --- a/docs/dyn/compute_alpha.regionNetworkPolicies.html +++ b/docs/dyn/compute_alpha.regionNetworkPolicies.html @@ -199,15 +199,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -254,7 +256,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -266,14 +268,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -293,6 +295,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -456,6 +464,12 @@

Method Details

"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against. # If it evaluates to true, the corresponding 'action' is enforced. # Exactly one field must be specified. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. + # Maximum number of destination address groups is 10. + # Example: + # projects//locations//addressGroups/. + "A String", + ], "destIpRanges": [ # CIDR IP address range. # Maximum number of destination CIDR IP ranges allowed is 5000. "A String", @@ -574,15 +588,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -629,7 +645,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -641,14 +657,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -668,6 +684,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -958,6 +980,12 @@

Method Details

"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against. # If it evaluates to true, the corresponding 'action' is enforced. # Exactly one field must be specified. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. + # Maximum number of destination address groups is 10. + # Example: + # projects//locations//addressGroups/. + "A String", + ], "destIpRanges": [ # CIDR IP address range. # Maximum number of destination CIDR IP ranges allowed is 5000. "A String", @@ -1172,15 +1200,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1227,7 +1257,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1239,14 +1269,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1266,6 +1296,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1458,6 +1494,12 @@

Method Details

"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against. # If it evaluates to true, the corresponding 'action' is enforced. # Exactly one field must be specified. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. + # Maximum number of destination address groups is 10. + # Example: + # projects//locations//addressGroups/. + "A String", + ], "destIpRanges": [ # CIDR IP address range. # Maximum number of destination CIDR IP ranges allowed is 5000. "A String", @@ -1579,6 +1621,12 @@

Method Details

"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against. # If it evaluates to true, the corresponding 'action' is enforced. # Exactly one field must be specified. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. + # Maximum number of destination address groups is 10. + # Example: + # projects//locations//addressGroups/. + "A String", + ], "destIpRanges": [ # CIDR IP address range. # Maximum number of destination CIDR IP ranges allowed is 5000. "A String", @@ -1693,6 +1741,12 @@

Method Details

"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against. # If it evaluates to true, the corresponding 'action' is enforced. # Exactly one field must be specified. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. + # Maximum number of destination address groups is 10. + # Example: + # projects//locations//addressGroups/. + "A String", + ], "destIpRanges": [ # CIDR IP address range. # Maximum number of destination CIDR IP ranges allowed is 5000. "A String", @@ -1813,15 +1867,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1868,7 +1924,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1880,14 +1936,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1907,6 +1963,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2185,6 +2247,12 @@

Method Details

"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against. # If it evaluates to true, the corresponding 'action' is enforced. # Exactly one field must be specified. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. + # Maximum number of destination address groups is 10. + # Example: + # projects//locations//addressGroups/. + "A String", + ], "destIpRanges": [ # CIDR IP address range. # Maximum number of destination CIDR IP ranges allowed is 5000. "A String", @@ -2349,6 +2417,12 @@

Method Details

"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against. # If it evaluates to true, the corresponding 'action' is enforced. # Exactly one field must be specified. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. + # Maximum number of destination address groups is 10. + # Example: + # projects//locations//addressGroups/. + "A String", + ], "destIpRanges": [ # CIDR IP address range. # Maximum number of destination CIDR IP ranges allowed is 5000. "A String", @@ -2469,15 +2543,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2524,7 +2600,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2536,14 +2612,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2563,6 +2639,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2726,6 +2808,12 @@

Method Details

"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against. # If it evaluates to true, the corresponding 'action' is enforced. # Exactly one field must be specified. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. + # Maximum number of destination address groups is 10. + # Example: + # projects//locations//addressGroups/. + "A String", + ], "destIpRanges": [ # CIDR IP address range. # Maximum number of destination CIDR IP ranges allowed is 5000. "A String", @@ -2846,15 +2934,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2901,7 +2991,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2913,14 +3003,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2940,6 +3030,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3141,15 +3237,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3196,7 +3294,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3208,14 +3306,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3235,6 +3333,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3436,15 +3540,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3491,7 +3597,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3503,14 +3609,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3530,6 +3636,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionNotificationEndpoints.html b/docs/dyn/compute_alpha.regionNotificationEndpoints.html index 39c16e22f4..1b2a581d88 100644 --- a/docs/dyn/compute_alpha.regionNotificationEndpoints.html +++ b/docs/dyn/compute_alpha.regionNotificationEndpoints.html @@ -426,15 +426,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -481,7 +483,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -493,14 +495,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -520,6 +522,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -858,15 +866,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -913,7 +923,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -925,14 +935,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -952,6 +962,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionOperations.html b/docs/dyn/compute_alpha.regionOperations.html index 1199b6030a..4945531893 100644 --- a/docs/dyn/compute_alpha.regionOperations.html +++ b/docs/dyn/compute_alpha.regionOperations.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -264,6 +266,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -538,15 +546,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -593,7 +603,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -605,14 +615,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -632,6 +642,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -885,15 +901,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -940,7 +958,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -952,14 +970,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -979,6 +997,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionRecoverableSnapshots.html b/docs/dyn/compute_alpha.regionRecoverableSnapshots.html index 1dc34ffd89..b211611cbd 100644 --- a/docs/dyn/compute_alpha.regionRecoverableSnapshots.html +++ b/docs/dyn/compute_alpha.regionRecoverableSnapshots.html @@ -176,15 +176,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -231,7 +233,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -243,14 +245,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -270,6 +272,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -551,7 +559,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -559,7 +568,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -581,7 +591,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -611,7 +622,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -619,7 +631,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -641,7 +654,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -668,7 +682,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -676,7 +691,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -698,7 +714,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1340,7 +1357,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1348,7 +1366,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1370,7 +1389,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1400,7 +1420,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1408,7 +1429,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1430,7 +1452,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1457,7 +1480,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1465,7 +1489,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1487,7 +1512,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1652,15 +1678,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1707,7 +1735,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1719,14 +1747,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1746,6 +1774,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionSecurityPolicies.html b/docs/dyn/compute_alpha.regionSecurityPolicies.html index 2e3ce3d6f2..c9a6228264 100644 --- a/docs/dyn/compute_alpha.regionSecurityPolicies.html +++ b/docs/dyn/compute_alpha.regionSecurityPolicies.html @@ -670,15 +670,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -725,7 +727,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -737,14 +739,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -764,6 +766,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -969,15 +977,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1024,7 +1034,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1036,14 +1046,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1063,6 +1073,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3302,15 +3318,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3357,7 +3375,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3369,14 +3387,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3396,6 +3414,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -5259,15 +5283,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5314,7 +5340,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5326,14 +5352,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5353,6 +5379,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6047,15 +6079,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6102,7 +6136,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6114,14 +6148,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6141,6 +6175,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6329,15 +6369,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6384,7 +6426,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6396,14 +6438,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6423,6 +6465,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6640,15 +6688,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6695,7 +6745,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6707,14 +6757,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6734,6 +6784,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionSnapshotSettings.html b/docs/dyn/compute_alpha.regionSnapshotSettings.html index ceb4450202..a766393717 100644 --- a/docs/dyn/compute_alpha.regionSnapshotSettings.html +++ b/docs/dyn/compute_alpha.regionSnapshotSettings.html @@ -226,15 +226,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -281,7 +283,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -293,14 +295,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -320,6 +322,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionSnapshots.html b/docs/dyn/compute_alpha.regionSnapshots.html index 607da5ed41..7152fec70b 100644 --- a/docs/dyn/compute_alpha.regionSnapshots.html +++ b/docs/dyn/compute_alpha.regionSnapshots.html @@ -188,15 +188,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -243,7 +245,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -255,14 +257,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -282,6 +284,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -575,7 +583,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -583,7 +592,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -605,7 +615,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -635,7 +646,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -643,7 +655,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -665,7 +678,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -701,7 +715,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -709,7 +724,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -731,7 +747,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1288,7 +1305,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1296,7 +1314,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1318,7 +1337,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1348,7 +1368,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1356,7 +1377,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1378,7 +1400,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1414,7 +1437,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1422,7 +1446,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1444,7 +1469,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1535,15 +1561,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1590,7 +1618,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1602,14 +1630,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1629,6 +1657,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2008,7 +2042,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2016,7 +2051,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2038,7 +2074,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2068,7 +2105,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2076,7 +2114,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2098,7 +2137,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2134,7 +2174,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2142,7 +2183,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2164,7 +2206,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3204,15 +3247,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3259,7 +3304,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3271,14 +3316,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3298,6 +3343,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3547,15 +3598,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3602,7 +3655,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3614,14 +3667,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3641,6 +3694,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionSslCertificates.html b/docs/dyn/compute_alpha.regionSslCertificates.html index 12e5654daa..4c3e1e2ed3 100644 --- a/docs/dyn/compute_alpha.regionSslCertificates.html +++ b/docs/dyn/compute_alpha.regionSslCertificates.html @@ -169,15 +169,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -224,7 +226,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -236,14 +238,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -263,6 +265,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -657,15 +665,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -712,7 +722,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -724,14 +734,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -751,6 +761,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionSslPolicies.html b/docs/dyn/compute_alpha.regionSslPolicies.html index dfcb08e705..245127683d 100644 --- a/docs/dyn/compute_alpha.regionSslPolicies.html +++ b/docs/dyn/compute_alpha.regionSslPolicies.html @@ -178,15 +178,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -233,7 +235,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -245,14 +247,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -272,6 +274,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -885,15 +893,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -940,7 +950,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -952,14 +962,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -979,6 +989,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1832,15 +1848,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1887,7 +1905,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1899,14 +1917,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1926,6 +1944,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionTargetHttpProxies.html b/docs/dyn/compute_alpha.regionTargetHttpProxies.html index 8a6a387f08..0127eb1eb3 100644 --- a/docs/dyn/compute_alpha.regionTargetHttpProxies.html +++ b/docs/dyn/compute_alpha.regionTargetHttpProxies.html @@ -172,15 +172,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -227,7 +229,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -239,14 +241,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -266,6 +268,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -650,15 +658,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -705,7 +715,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -717,14 +727,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -744,6 +754,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1185,15 +1201,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1240,7 +1258,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1252,14 +1270,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1279,6 +1297,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionTargetHttpsProxies.html b/docs/dyn/compute_alpha.regionTargetHttpsProxies.html index 5623828da6..abb2cb964b 100644 --- a/docs/dyn/compute_alpha.regionTargetHttpsProxies.html +++ b/docs/dyn/compute_alpha.regionTargetHttpsProxies.html @@ -178,15 +178,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -233,7 +235,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -245,14 +247,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -272,6 +274,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -852,15 +860,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -907,7 +917,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -919,14 +929,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -946,6 +956,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1664,15 +1680,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1719,7 +1737,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1731,14 +1749,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1758,6 +1776,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1969,15 +1993,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2024,7 +2050,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2036,14 +2062,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2063,6 +2089,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2270,15 +2302,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2325,7 +2359,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2337,14 +2371,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2364,6 +2398,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionTargetTcpProxies.html b/docs/dyn/compute_alpha.regionTargetTcpProxies.html index 211f417853..6419246e62 100644 --- a/docs/dyn/compute_alpha.regionTargetTcpProxies.html +++ b/docs/dyn/compute_alpha.regionTargetTcpProxies.html @@ -169,15 +169,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -224,7 +226,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -236,14 +238,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -263,6 +265,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -565,15 +573,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -620,7 +630,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -632,14 +642,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -659,6 +669,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.regionUrlMaps.html b/docs/dyn/compute_alpha.regionUrlMaps.html index d37eb67357..917c47d3db 100644 --- a/docs/dyn/compute_alpha.regionUrlMaps.html +++ b/docs/dyn/compute_alpha.regionUrlMaps.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -264,6 +266,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7989,15 +7997,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8044,7 +8054,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8056,14 +8066,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8083,6 +8093,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -8310,15 +8326,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8365,7 +8383,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8377,14 +8395,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8404,6 +8422,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -16266,15 +16290,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16321,7 +16347,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16333,14 +16359,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16360,6 +16386,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -20345,15 +20377,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -20400,7 +20434,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20412,14 +20446,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -20439,6 +20473,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.reliabilityRisks.html b/docs/dyn/compute_alpha.reliabilityRisks.html index 0f6e8fff3f..72d74b1156 100644 --- a/docs/dyn/compute_alpha.reliabilityRisks.html +++ b/docs/dyn/compute_alpha.reliabilityRisks.html @@ -238,7 +238,7 @@

Method Details

An object of the form: { # Response message for the List method of ReliabilityRisksService. - "etag": "A String", + "etag": "A String", # [Output Only] An ETag of the resource. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of ReliabilityRisk resources. { # Represents a ReliabilityRisk resource. diff --git a/docs/dyn/compute_alpha.reservationBlocks.html b/docs/dyn/compute_alpha.reservationBlocks.html index 11c34d6814..7891bc4bd0 100644 --- a/docs/dyn/compute_alpha.reservationBlocks.html +++ b/docs/dyn/compute_alpha.reservationBlocks.html @@ -544,15 +544,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -599,7 +601,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -611,14 +613,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -638,6 +640,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.reservationConsumedInstances.html b/docs/dyn/compute_alpha.reservationConsumedInstances.html new file mode 100644 index 0000000000..f39abfab6a --- /dev/null +++ b/docs/dyn/compute_alpha.reservationConsumedInstances.html @@ -0,0 +1,347 @@ + + + +

Compute Engine API . reservationConsumedInstances

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the instances consuming capacity from a specific reservation.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists the instances consuming capacity from a specific reservation.
+
+Args:
+  project: string, Required. Project ID for this request. (required)
+  zone: string, Required. Zone name for this request. (required)
+  reservation: string, Required. The name of the reservation to list consumed instances for. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for listing reservation consumed instances.
+  "id": "A String", # Uniquely identifies the type of this resource.
+  "items": [ # A list of ReservationConsumedInstance resources.
+    { # ReservationConsumedInstance represents a consumed instance.
+      "instance": "A String", # The full URI of the instance resource.
+      "service": "A String", # The service to which the instance belongs. Typically "COMPUTE".
+      "status": { # Status information for the instance's consumption of the reservation. # Output only. [Output Only] The status of the consumed instance.
+        "linkageErrors": { # A list of issues related to this instance's linkage to the reservation.
+          "errors": [ # [Output Only] The array of errors encountered while processing this
+              # operation.
+            { # Represents a single error encountered during the processing of an
+                # operation.
+              "code": "A String", # [Output Only] The error type identifier for this error.
+              "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+                  # details. There is a set of defined message types to use for providing
+                  # details.The syntax depends on the error code. For example,
+                  # QuotaExceededInfo will have details when the error code is
+                  # QUOTA_EXCEEDED.
+                { # Container for structured error details providing additional context
+                    # specific to the encountered error code.
+                  "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata.
+                      #
+                      # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                      # is not enabled:
+                      #
+                      #     { "reason": "API_DISABLED"
+                      #       "domain": "googleapis.com"
+                      #       "metadata": {
+                      #         "resource": "projects/123",
+                      #         "service": "pubsub.googleapis.com"
+                      #       }
+                      #     }
+                      #
+                      # This response indicates that the pubsub.googleapis.com API is not enabled.
+                      #
+                      # Example of an error that is returned when attempting to create a Spanner
+                      # instance in a region that is out of stock:
+                      #
+                      #     { "reason": "STOCKOUT"
+                      #       "domain": "spanner.googleapis.com",
+                      #       "metadata": {
+                      #         "availableRegions": "us-central1,us-east2"
+                      #       }
+                      #     }
+                    "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                        # is typically the registered service name of the tool or product that
+                        # generates the error. Example: "pubsub.googleapis.com". If the error is
+                        # generated by some common infrastructure, the error domain must be a
+                        # globally unique value that identifies the infrastructure. For Google API
+                        # infrastructure, the error domain is "googleapis.com".
+                    "metadatas": { # Additional structured details about this error.
+                        #
+                        # Keys must match a regular expression of `a-z+` but should
+                        # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                        # length. When identifying the current value of an exceeded limit, the units
+                        # should be contained in the key, not the value.  For example, rather than
+                        # `{"instanceLimit": "100/request"}`, should be returned as,
+                        # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                        # instances that can be created in a single (batch) request.
+                      "a_key": "A String",
+                    },
+                    "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                        # proximate cause of the error. Error reasons are unique within a particular
+                        # domain of errors. This should be at most 63 characters and match a
+                        # regular expression of `A-Z+[A-Z0-9]`, which represents
+                        # UPPER_SNAKE_CASE.
+                  },
+                  "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error.
+                      #
+                      # For example, if a quota check failed with an error indicating the calling
+                      # project hasn't enabled the accessed service, this can contain a URL pointing
+                      # directly to the right place in the developer console to flip the bit.
+                    "links": [ # URL(s) pointing to additional information on handling the current error.
+                      { # Describes a URL link.
+                        "description": "A String", # Describes what the link offers.
+                        "url": "A String", # The URL of the link.
+                      },
+                    ],
+                  },
+                  "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users.
+                      # which can be attached to an RPC error.
+                    "locale": "A String", # The locale used following the specification defined at
+                        # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                        # Examples are: "en-US", "fr-CH", "es-MX"
+                    "message": "A String", # The localized error message in the above locale.
+                  },
+                  "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded.
+                    "dimensions": { # The map holding related quota dimensions.
+                      "a_key": "A String",
+                    },
+                    "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                        #  type or metric.
+                    "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                        # or metric.
+                    "limitName": "A String", # The name of the quota limit.
+                    "metricName": "A String", # The Compute Engine quota metric name.
+                    "rolloutStatus": "A String", # Rollout status of the future quota limit.
+                  },
+                },
+              ],
+              "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+                  # This property is optional.
+              "message": "A String", # [Output Only] An optional, human-readable error message.
+            },
+          ],
+        },
+      },
+    },
+  ],
+  "kind": "A String", # Identifies the resource as a list of reservation consumed instances.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "warning": { # [Output Only] Informational warning which replaces the result in some
+      # cases.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.reservationSlots.html b/docs/dyn/compute_alpha.reservationSlots.html index 52e4f8ed25..9a4f1ca98b 100644 --- a/docs/dyn/compute_alpha.reservationSlots.html +++ b/docs/dyn/compute_alpha.reservationSlots.html @@ -260,15 +260,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -315,7 +317,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -327,14 +329,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -354,6 +356,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -819,15 +827,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -874,7 +884,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -886,14 +896,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -913,6 +923,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.reservationSubBlocks.html b/docs/dyn/compute_alpha.reservationSubBlocks.html index f840ba7b01..637f3de0b1 100644 --- a/docs/dyn/compute_alpha.reservationSubBlocks.html +++ b/docs/dyn/compute_alpha.reservationSubBlocks.html @@ -309,15 +309,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -364,7 +366,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -376,14 +378,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -403,6 +405,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -857,15 +865,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -912,7 +922,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -924,14 +934,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -951,6 +961,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1168,15 +1184,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1223,7 +1241,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1235,14 +1253,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1262,6 +1280,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1556,15 +1580,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1611,7 +1637,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1623,14 +1649,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1650,6 +1676,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.reservations.html b/docs/dyn/compute_alpha.reservations.html index ddc5dd5a76..a2c1b9f60b 100644 --- a/docs/dyn/compute_alpha.reservations.html +++ b/docs/dyn/compute_alpha.reservations.html @@ -659,15 +659,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -714,7 +716,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -726,14 +728,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -753,6 +755,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1892,15 +1900,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1947,7 +1957,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1959,14 +1969,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1986,6 +1996,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2622,15 +2638,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2677,7 +2695,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2689,14 +2707,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2716,6 +2734,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2926,15 +2950,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2981,7 +3007,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2993,14 +3019,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3020,6 +3046,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4409,15 +4441,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4464,7 +4498,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4476,14 +4510,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4503,6 +4537,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.resourcePolicies.html b/docs/dyn/compute_alpha.resourcePolicies.html index c06f2aac92..2a13a0dbca 100644 --- a/docs/dyn/compute_alpha.resourcePolicies.html +++ b/docs/dyn/compute_alpha.resourcePolicies.html @@ -540,15 +540,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -595,7 +597,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -607,14 +609,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -634,6 +636,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1544,15 +1552,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1599,7 +1609,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1611,14 +1621,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1638,6 +1648,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2318,15 +2334,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2373,7 +2391,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2385,14 +2403,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2412,6 +2430,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.rolloutPlans.html b/docs/dyn/compute_alpha.rolloutPlans.html index d92ce84bc3..b51f32ddc7 100644 --- a/docs/dyn/compute_alpha.rolloutPlans.html +++ b/docs/dyn/compute_alpha.rolloutPlans.html @@ -165,15 +165,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -220,7 +222,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -232,14 +234,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -259,6 +261,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -668,15 +676,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -723,7 +733,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -735,14 +745,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -762,6 +772,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.rollouts.html b/docs/dyn/compute_alpha.rollouts.html index 0aa390e2c5..d82fa263e2 100644 --- a/docs/dyn/compute_alpha.rollouts.html +++ b/docs/dyn/compute_alpha.rollouts.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -264,6 +266,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -467,15 +475,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -522,7 +532,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -534,14 +544,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -561,6 +571,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -765,15 +781,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -820,7 +838,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -832,14 +850,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -859,6 +877,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1402,15 +1426,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1457,7 +1483,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1469,14 +1495,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1496,6 +1522,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1698,15 +1730,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1753,7 +1787,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1765,14 +1799,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1792,6 +1826,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.routers.html b/docs/dyn/compute_alpha.routers.html index 0c72ba7a0e..786e657483 100644 --- a/docs/dyn/compute_alpha.routers.html +++ b/docs/dyn/compute_alpha.routers.html @@ -977,15 +977,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1032,7 +1034,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1044,14 +1046,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1071,6 +1073,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1272,15 +1280,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1327,7 +1337,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1339,14 +1349,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1366,6 +1376,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1567,15 +1583,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1622,7 +1640,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1634,14 +1652,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1661,6 +1679,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4189,15 +4213,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4244,7 +4270,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4256,14 +4282,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4283,6 +4309,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6417,15 +6449,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6472,7 +6506,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6484,14 +6518,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6511,6 +6545,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6774,15 +6814,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6829,7 +6871,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6841,14 +6883,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6868,6 +6910,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7181,15 +7229,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7236,7 +7286,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7248,14 +7298,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7275,6 +7325,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -9173,15 +9229,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9228,7 +9286,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9240,14 +9298,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9267,6 +9325,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -9530,15 +9594,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9585,7 +9651,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9597,14 +9663,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9624,6 +9690,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -9937,15 +10009,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9992,7 +10066,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10004,14 +10078,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10031,6 +10105,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.routes.html b/docs/dyn/compute_alpha.routes.html index 4a8ddb5bc1..d74af4b733 100644 --- a/docs/dyn/compute_alpha.routes.html +++ b/docs/dyn/compute_alpha.routes.html @@ -168,15 +168,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -223,7 +225,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -235,14 +237,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -262,6 +264,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -822,15 +830,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -877,7 +887,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -889,14 +899,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -916,6 +926,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.securityPolicies.html b/docs/dyn/compute_alpha.securityPolicies.html index dcf486ebfd..3a3cfde812 100644 --- a/docs/dyn/compute_alpha.securityPolicies.html +++ b/docs/dyn/compute_alpha.securityPolicies.html @@ -681,15 +681,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -736,7 +738,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -748,14 +750,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -775,6 +777,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1926,15 +1934,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1981,7 +1991,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1993,14 +2003,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2020,6 +2030,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4256,15 +4272,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4311,7 +4329,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4323,14 +4341,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4350,6 +4368,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6345,15 +6369,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6400,7 +6426,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6412,14 +6438,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6439,6 +6465,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7132,15 +7164,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7187,7 +7221,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7199,14 +7233,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7226,6 +7260,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7413,15 +7453,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7468,7 +7510,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7480,14 +7522,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7507,6 +7549,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -7713,15 +7761,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7768,7 +7818,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7780,14 +7830,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7807,6 +7857,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.serviceAttachments.html b/docs/dyn/compute_alpha.serviceAttachments.html index 247aa26f1c..dd7c9f4901 100644 --- a/docs/dyn/compute_alpha.serviceAttachments.html +++ b/docs/dyn/compute_alpha.serviceAttachments.html @@ -526,15 +526,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -581,7 +583,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -593,14 +595,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -620,6 +622,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1504,15 +1512,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1559,7 +1569,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1571,14 +1581,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1598,6 +1608,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2249,15 +2265,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2304,7 +2322,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2316,14 +2334,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2343,6 +2361,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.snapshotGroups.html b/docs/dyn/compute_alpha.snapshotGroups.html index 4158cfde49..9288926b81 100644 --- a/docs/dyn/compute_alpha.snapshotGroups.html +++ b/docs/dyn/compute_alpha.snapshotGroups.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -268,6 +270,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -920,15 +928,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -975,7 +985,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -987,14 +997,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1014,6 +1024,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.snapshotRecycleBinPolicy.html b/docs/dyn/compute_alpha.snapshotRecycleBinPolicy.html index 7a94d16cff..fe22a00b82 100644 --- a/docs/dyn/compute_alpha.snapshotRecycleBinPolicy.html +++ b/docs/dyn/compute_alpha.snapshotRecycleBinPolicy.html @@ -241,15 +241,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -296,7 +298,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -308,14 +310,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -335,6 +337,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.snapshotSettings.html b/docs/dyn/compute_alpha.snapshotSettings.html index 0d8026ba1e..ee2b13f1df 100644 --- a/docs/dyn/compute_alpha.snapshotSettings.html +++ b/docs/dyn/compute_alpha.snapshotSettings.html @@ -224,15 +224,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -279,7 +281,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -291,14 +293,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -318,6 +320,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.snapshots.html b/docs/dyn/compute_alpha.snapshots.html index b9b3eeeda6..1a35359dfd 100644 --- a/docs/dyn/compute_alpha.snapshots.html +++ b/docs/dyn/compute_alpha.snapshots.html @@ -378,7 +378,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -386,7 +387,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -408,7 +410,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -438,7 +441,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -446,7 +450,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -468,7 +473,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -504,7 +510,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -512,7 +519,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -534,7 +542,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -725,15 +734,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -780,7 +791,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -792,14 +803,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -819,6 +830,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1111,7 +1128,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1119,7 +1137,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1141,7 +1160,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1171,7 +1191,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1179,7 +1200,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1201,7 +1223,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1237,7 +1260,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1245,7 +1269,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1267,7 +1292,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1847,7 +1873,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1855,7 +1882,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1877,7 +1905,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1907,7 +1936,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1915,7 +1945,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1937,7 +1968,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1973,7 +2005,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1981,7 +2014,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2003,7 +2037,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2094,15 +2129,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2149,7 +2186,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2161,14 +2198,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2188,6 +2225,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2566,7 +2609,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2574,7 +2618,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2596,7 +2641,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2626,7 +2672,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2634,7 +2681,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2656,7 +2704,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2692,7 +2741,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2700,7 +2750,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2722,7 +2773,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3749,15 +3801,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3804,7 +3858,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3816,14 +3870,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3843,6 +3897,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4090,15 +4150,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4145,7 +4207,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4157,14 +4219,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4184,6 +4246,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.sslCertificates.html b/docs/dyn/compute_alpha.sslCertificates.html index 784e67f0b0..3ad8835c9c 100644 --- a/docs/dyn/compute_alpha.sslCertificates.html +++ b/docs/dyn/compute_alpha.sslCertificates.html @@ -456,15 +456,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -511,7 +513,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -523,14 +525,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -550,6 +552,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -940,15 +948,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -995,7 +1005,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1007,14 +1017,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1034,6 +1044,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.sslPolicies.html b/docs/dyn/compute_alpha.sslPolicies.html index 7690c1758a..a9f6effbd2 100644 --- a/docs/dyn/compute_alpha.sslPolicies.html +++ b/docs/dyn/compute_alpha.sslPolicies.html @@ -575,15 +575,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -630,7 +632,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -642,14 +644,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -669,6 +671,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1279,15 +1287,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1334,7 +1344,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1346,14 +1356,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1373,6 +1383,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2223,15 +2239,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2278,7 +2296,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2290,14 +2308,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2317,6 +2335,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.storagePools.html b/docs/dyn/compute_alpha.storagePools.html index 0e37b9fe8e..f613c95743 100644 --- a/docs/dyn/compute_alpha.storagePools.html +++ b/docs/dyn/compute_alpha.storagePools.html @@ -241,7 +241,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -545,15 +545,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -600,7 +602,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -612,14 +614,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -639,6 +641,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -794,7 +802,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -1327,7 +1335,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -1533,15 +1541,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1588,7 +1598,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1600,14 +1610,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1627,6 +1637,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1868,7 +1884,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -3204,15 +3220,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3259,7 +3277,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3271,14 +3289,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3298,6 +3316,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3485,7 +3509,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -3692,15 +3716,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3747,7 +3773,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3759,14 +3785,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3786,6 +3812,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.subnetworks.html b/docs/dyn/compute_alpha.subnetworks.html index e0296cd5ef..fb313fe84f 100644 --- a/docs/dyn/compute_alpha.subnetworks.html +++ b/docs/dyn/compute_alpha.subnetworks.html @@ -691,15 +691,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -746,7 +748,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -758,14 +760,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -785,6 +787,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -995,15 +1003,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1050,7 +1060,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1062,14 +1072,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1089,6 +1099,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2270,15 +2286,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2325,7 +2343,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2337,14 +2355,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2364,6 +2382,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3549,15 +3573,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3604,7 +3630,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3616,14 +3642,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3643,6 +3669,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -4726,15 +4758,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4781,7 +4815,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4793,14 +4827,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4820,6 +4854,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.targetGrpcProxies.html b/docs/dyn/compute_alpha.targetGrpcProxies.html index c7cc65f2f5..8c9d94631f 100644 --- a/docs/dyn/compute_alpha.targetGrpcProxies.html +++ b/docs/dyn/compute_alpha.targetGrpcProxies.html @@ -171,15 +171,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -226,7 +228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -238,14 +240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -265,6 +267,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -573,15 +581,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -628,7 +638,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -640,14 +650,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -667,6 +677,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1111,15 +1127,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1166,7 +1184,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1178,14 +1196,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1205,6 +1223,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.targetHttpProxies.html b/docs/dyn/compute_alpha.targetHttpProxies.html index b553d5e89e..540ed6b1d9 100644 --- a/docs/dyn/compute_alpha.targetHttpProxies.html +++ b/docs/dyn/compute_alpha.targetHttpProxies.html @@ -458,15 +458,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -513,7 +515,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -525,14 +527,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -552,6 +554,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -934,15 +942,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -989,7 +999,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1001,14 +1011,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1028,6 +1038,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1548,15 +1564,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1603,7 +1621,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1615,14 +1633,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1642,6 +1660,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1848,15 +1872,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1903,7 +1929,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1915,14 +1941,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1942,6 +1968,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.targetHttpsProxies.html b/docs/dyn/compute_alpha.targetHttpsProxies.html index b51a69a366..226e3de1b1 100644 --- a/docs/dyn/compute_alpha.targetHttpsProxies.html +++ b/docs/dyn/compute_alpha.targetHttpsProxies.html @@ -568,15 +568,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -623,7 +625,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -635,14 +637,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -662,6 +664,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1240,15 +1248,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1295,7 +1305,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1307,14 +1317,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1334,6 +1344,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2050,15 +2066,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2105,7 +2123,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2117,14 +2135,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2144,6 +2162,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2353,15 +2377,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2408,7 +2434,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2420,14 +2446,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2447,6 +2473,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2654,15 +2686,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2709,7 +2743,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2721,14 +2755,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2748,6 +2782,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2960,15 +3000,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3015,7 +3057,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3027,14 +3069,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3054,6 +3096,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3264,15 +3312,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3319,7 +3369,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3331,14 +3381,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3358,6 +3408,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3565,15 +3621,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3620,7 +3678,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3632,14 +3690,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3659,6 +3717,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.targetInstances.html b/docs/dyn/compute_alpha.targetInstances.html index bc3ad3e9ba..44e20e8e2f 100644 --- a/docs/dyn/compute_alpha.targetInstances.html +++ b/docs/dyn/compute_alpha.targetInstances.html @@ -416,15 +416,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -471,7 +473,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -483,14 +485,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -510,6 +512,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -818,15 +826,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -873,7 +883,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -885,14 +895,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -912,6 +922,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1317,15 +1333,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1372,7 +1390,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1384,14 +1402,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1411,6 +1429,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.targetPools.html b/docs/dyn/compute_alpha.targetPools.html index 3a4f1c52ad..a190b16555 100644 --- a/docs/dyn/compute_alpha.targetPools.html +++ b/docs/dyn/compute_alpha.targetPools.html @@ -207,15 +207,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -262,7 +264,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -274,14 +276,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -301,6 +303,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -518,15 +526,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -573,7 +583,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -585,14 +595,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -612,6 +622,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1087,15 +1103,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1142,7 +1160,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1154,14 +1172,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1181,6 +1199,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1603,15 +1627,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1658,7 +1684,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1670,14 +1696,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1697,6 +1723,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2145,15 +2177,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2200,7 +2234,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2212,14 +2246,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2239,6 +2273,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2451,15 +2491,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2506,7 +2548,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2518,14 +2560,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2545,6 +2587,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2753,15 +2801,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2808,7 +2858,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2820,14 +2870,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2847,6 +2897,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -3057,15 +3113,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3112,7 +3170,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3124,14 +3182,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3151,6 +3209,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.targetSslProxies.html b/docs/dyn/compute_alpha.targetSslProxies.html index fc59885b4e..b310f92e2b 100644 --- a/docs/dyn/compute_alpha.targetSslProxies.html +++ b/docs/dyn/compute_alpha.targetSslProxies.html @@ -183,15 +183,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -238,7 +240,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -250,14 +252,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -277,6 +279,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -581,15 +589,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -636,7 +646,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -648,14 +658,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -675,6 +685,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1075,15 +1091,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1130,7 +1148,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1142,14 +1160,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1169,6 +1187,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1378,15 +1402,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1433,7 +1459,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1445,14 +1471,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1472,6 +1498,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1679,15 +1711,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1734,7 +1768,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1746,14 +1780,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1773,6 +1807,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1984,15 +2024,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2039,7 +2081,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2051,14 +2093,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2078,6 +2120,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2288,15 +2336,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2343,7 +2393,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2355,14 +2405,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2382,6 +2432,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.targetTcpProxies.html b/docs/dyn/compute_alpha.targetTcpProxies.html index 8f60946ae6..13073eda93 100644 --- a/docs/dyn/compute_alpha.targetTcpProxies.html +++ b/docs/dyn/compute_alpha.targetTcpProxies.html @@ -417,15 +417,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -472,7 +474,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -484,14 +486,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -511,6 +513,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -811,15 +819,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -866,7 +876,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -878,14 +888,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -905,6 +915,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1303,15 +1319,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1358,7 +1376,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1370,14 +1388,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1397,6 +1415,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1604,15 +1628,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1659,7 +1685,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1671,14 +1697,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1698,6 +1724,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.targetVpnGateways.html b/docs/dyn/compute_alpha.targetVpnGateways.html index 1dd658eb01..c7d8aea500 100644 --- a/docs/dyn/compute_alpha.targetVpnGateways.html +++ b/docs/dyn/compute_alpha.targetVpnGateways.html @@ -443,15 +443,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -498,7 +500,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -510,14 +512,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -537,6 +539,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -899,15 +907,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -954,7 +964,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -966,14 +976,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -993,6 +1003,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1431,15 +1447,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1486,7 +1504,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1498,14 +1516,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1525,6 +1543,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.urlMaps.html b/docs/dyn/compute_alpha.urlMaps.html index d759bfedda..ccd3d9e9b4 100644 --- a/docs/dyn/compute_alpha.urlMaps.html +++ b/docs/dyn/compute_alpha.urlMaps.html @@ -4139,15 +4139,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4194,7 +4196,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4206,14 +4208,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4233,6 +4235,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -11967,15 +11975,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12022,7 +12032,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12034,14 +12044,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12061,6 +12071,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -12298,15 +12314,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12353,7 +12371,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12365,14 +12383,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12392,6 +12410,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -20263,15 +20287,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -20318,7 +20344,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20330,14 +20356,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -20357,6 +20383,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -24351,15 +24383,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -24406,7 +24440,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -24418,14 +24452,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -24445,6 +24479,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.vpnGateways.html b/docs/dyn/compute_alpha.vpnGateways.html index 9ff8e00246..8b046c9ba6 100644 --- a/docs/dyn/compute_alpha.vpnGateways.html +++ b/docs/dyn/compute_alpha.vpnGateways.html @@ -466,15 +466,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -521,7 +523,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -533,14 +535,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -560,6 +562,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1011,15 +1019,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1066,7 +1076,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1078,14 +1088,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1105,6 +1115,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1563,15 +1579,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1618,7 +1636,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1630,14 +1648,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1657,6 +1675,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.vpnTunnels.html b/docs/dyn/compute_alpha.vpnTunnels.html index 8a0054638b..ae9585c92b 100644 --- a/docs/dyn/compute_alpha.vpnTunnels.html +++ b/docs/dyn/compute_alpha.vpnTunnels.html @@ -540,15 +540,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -595,7 +597,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -607,14 +609,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -634,6 +636,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1188,15 +1196,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1243,7 +1253,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1255,14 +1265,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1282,6 +1292,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1817,15 +1833,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1872,7 +1890,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1884,14 +1902,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1911,6 +1929,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.wireGroups.html b/docs/dyn/compute_alpha.wireGroups.html index 4a154250f6..49a3ee92ad 100644 --- a/docs/dyn/compute_alpha.wireGroups.html +++ b/docs/dyn/compute_alpha.wireGroups.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -264,6 +266,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -936,15 +944,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -991,7 +1001,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1003,14 +1013,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1030,6 +1040,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -1844,15 +1860,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1899,7 +1917,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1911,14 +1929,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1938,6 +1956,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.zoneFolderOperations.html b/docs/dyn/compute_alpha.zoneFolderOperations.html index c37a311c0a..9d55523964 100644 --- a/docs/dyn/compute_alpha.zoneFolderOperations.html +++ b/docs/dyn/compute_alpha.zoneFolderOperations.html @@ -147,15 +147,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -202,7 +204,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -214,14 +216,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -241,6 +243,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -515,15 +523,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -570,7 +580,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -582,14 +592,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -609,6 +619,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.zoneOperations.html b/docs/dyn/compute_alpha.zoneOperations.html index 98568ceec7..9204be8075 100644 --- a/docs/dyn/compute_alpha.zoneOperations.html +++ b/docs/dyn/compute_alpha.zoneOperations.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -264,6 +266,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -538,15 +546,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -593,7 +603,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -605,14 +615,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -632,6 +642,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -884,15 +900,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -939,7 +957,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -951,14 +969,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -978,6 +996,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.zoneOrganizationOperations.html b/docs/dyn/compute_alpha.zoneOrganizationOperations.html index 8be18c1734..c54d258411 100644 --- a/docs/dyn/compute_alpha.zoneOrganizationOperations.html +++ b/docs/dyn/compute_alpha.zoneOrganizationOperations.html @@ -148,15 +148,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -203,7 +205,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -215,14 +217,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -242,6 +244,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -516,15 +524,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -571,7 +581,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -583,14 +593,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -610,6 +620,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_alpha.zoneQueuedResources.html b/docs/dyn/compute_alpha.zoneQueuedResources.html index 2a0f626cf3..eedba3e41f 100644 --- a/docs/dyn/compute_alpha.zoneQueuedResources.html +++ b/docs/dyn/compute_alpha.zoneQueuedResources.html @@ -300,7 +300,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -308,7 +309,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -330,7 +332,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -394,7 +397,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -522,7 +568,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -530,7 +577,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -552,7 +600,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -604,7 +653,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -612,7 +662,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -634,7 +685,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -826,7 +878,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -834,7 +887,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -856,7 +910,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -920,7 +975,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -1048,7 +1146,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1056,7 +1155,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1078,7 +1178,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1130,7 +1231,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1138,7 +1240,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1160,7 +1263,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1607,6 +1711,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -1697,10 +1803,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1928,15 +2033,17 @@

Method Details

"error": { # The error(s) that caused the QueuedResource to enter the FAILED state. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1983,7 +2090,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1995,14 +2102,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2201,15 +2308,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2256,7 +2365,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2268,14 +2377,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2295,6 +2404,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2504,15 +2619,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2559,7 +2676,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2571,14 +2688,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2598,6 +2715,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -2829,7 +2952,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2837,7 +2961,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2859,7 +2984,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2923,7 +3049,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -3051,7 +3220,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3059,7 +3229,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3081,7 +3252,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3133,7 +3305,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3141,7 +3314,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3163,7 +3337,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3355,7 +3530,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3363,7 +3539,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3385,7 +3562,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3449,7 +3627,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -3577,7 +3798,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3585,7 +3807,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3607,7 +3830,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3659,7 +3883,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3667,7 +3892,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3689,7 +3915,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4136,6 +4363,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -4226,10 +4455,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4457,15 +4685,17 @@

Method Details

"error": { # The error(s) that caused the QueuedResource to enter the FAILED state. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4512,7 +4742,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4524,14 +4754,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4674,7 +4904,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4682,7 +4913,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4704,7 +4936,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4768,7 +5001,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -4896,7 +5172,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4904,7 +5181,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4926,7 +5204,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4978,7 +5257,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4986,7 +5266,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5008,7 +5289,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5200,7 +5482,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5208,7 +5491,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5230,7 +5514,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5294,7 +5579,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -5422,7 +5750,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5430,7 +5759,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5452,7 +5782,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5504,7 +5835,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5512,7 +5844,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5534,7 +5867,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5981,6 +6315,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -6071,10 +6407,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -6302,15 +6637,17 @@

Method Details

"error": { # The error(s) that caused the QueuedResource to enter the FAILED state. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6357,7 +6694,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6369,14 +6706,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6485,15 +6822,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6540,7 +6879,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6552,14 +6891,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6579,6 +6918,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -6895,7 +7240,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6903,7 +7249,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -6925,7 +7272,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -6989,7 +7337,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -7117,7 +7508,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7125,7 +7517,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7147,7 +7540,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7199,7 +7593,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7207,7 +7602,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7229,7 +7625,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7421,7 +7818,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7429,7 +7827,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7451,7 +7850,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7515,7 +7915,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -7643,7 +8086,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7651,7 +8095,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7673,7 +8118,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7725,7 +8171,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7733,7 +8180,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7755,7 +8203,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8202,6 +8651,8 @@

Method Details

# 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. # 0 or unset means default amount of memory of the current machine type. + "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 @@ -8292,10 +8743,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8523,15 +8973,17 @@

Method Details

"error": { # The error(s) that caused the QueuedResource to enter the FAILED state. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8578,7 +9030,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8590,14 +9042,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_alpha.zoneVmExtensionPolicies.html b/docs/dyn/compute_alpha.zoneVmExtensionPolicies.html index 272ebdf2dc..bfa9b2b301 100644 --- a/docs/dyn/compute_alpha.zoneVmExtensionPolicies.html +++ b/docs/dyn/compute_alpha.zoneVmExtensionPolicies.html @@ -178,15 +178,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -233,7 +235,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -245,14 +247,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -272,6 +274,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -427,6 +435,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -521,6 +543,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -633,15 +669,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -688,7 +726,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -700,14 +738,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -727,6 +765,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other @@ -974,6 +1018,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -1264,6 +1322,20 @@

Method Details

"extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding # policy configurations. "a_key": { # Configuration for a specific VM extension. + "installedSoftwareSelector": { # Defines the software requirements for a VM extension policy. # Optional. Only deploy this extension if the specified software is detected on the + # VM. For a live list of valid software values, see: + # https://cloud.google.com/compute/docs/vm-extensions/supported-software + "anyOfSelectors": { # Optional. If any of these SelectorSets are satisfied, the condition + # is met (OR logic). + # The key is a user-provided name for this set. + "a_key": { + "allOfSelectors": [ # Optional. All software in this list must be detected (AND logic). + # Valid software names (e.g. "Apache Web Server"). + "A String", + ], + }, + }, + }, "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. "stringConfig": "A String", # Optional. String-based configuration data for the extension. @@ -1376,15 +1448,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1431,7 +1505,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1443,14 +1517,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1470,6 +1544,12 @@

Method Details

}, ], }, + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the + # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule + # methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query + # parameters specified minPriority/maxPriority. + }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other diff --git a/docs/dyn/compute_beta.addresses.html b/docs/dyn/compute_beta.addresses.html index f6afae3c2c..7a97e28d54 100644 --- a/docs/dyn/compute_beta.addresses.html +++ b/docs/dyn/compute_beta.addresses.html @@ -246,8 +246,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -329,6 +331,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -501,15 +509,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -556,7 +566,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -568,14 +578,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -766,8 +776,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -849,6 +861,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -903,8 +921,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -986,6 +1006,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -1064,15 +1090,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1119,7 +1147,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1131,14 +1159,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1415,8 +1443,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -1498,6 +1528,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -1650,15 +1686,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1705,7 +1743,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1717,14 +1755,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1959,15 +1997,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2014,7 +2054,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2026,14 +2066,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.autoscalers.html b/docs/dyn/compute_beta.autoscalers.html index 033f5b9c80..78c5e366cc 100644 --- a/docs/dyn/compute_beta.autoscalers.html +++ b/docs/dyn/compute_beta.autoscalers.html @@ -742,15 +742,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -797,7 +799,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -809,14 +811,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1785,15 +1787,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1840,7 +1844,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1852,14 +1856,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2966,15 +2970,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3021,7 +3027,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3033,14 +3039,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3662,15 +3668,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3717,7 +3725,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3729,14 +3737,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.backendBuckets.html b/docs/dyn/compute_beta.backendBuckets.html index 717894b69c..6694b1ba95 100644 --- a/docs/dyn/compute_beta.backendBuckets.html +++ b/docs/dyn/compute_beta.backendBuckets.html @@ -212,15 +212,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -267,7 +269,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -279,14 +281,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -893,15 +895,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -948,7 +952,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -960,14 +964,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1188,15 +1192,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1243,7 +1249,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1255,14 +1261,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2251,15 +2257,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2306,7 +2314,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2318,14 +2326,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3425,15 +3433,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3480,7 +3490,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3492,14 +3502,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3725,15 +3735,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3780,7 +3792,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3792,14 +3804,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5120,15 +5132,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5175,7 +5189,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5187,14 +5201,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.backendServices.html b/docs/dyn/compute_beta.backendServices.html index e2839c9565..738c052fdd 100644 --- a/docs/dyn/compute_beta.backendServices.html +++ b/docs/dyn/compute_beta.backendServices.html @@ -221,15 +221,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -276,7 +278,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -288,14 +290,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1776,7 +1778,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -2069,15 +2075,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2124,7 +2132,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2136,14 +2144,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2364,15 +2372,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2419,7 +2429,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2431,14 +2441,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3819,7 +3829,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -6350,7 +6364,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -6551,15 +6569,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6606,7 +6626,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6618,14 +6638,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8092,7 +8112,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -9586,7 +9610,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -11020,7 +11048,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -11221,15 +11253,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11276,7 +11310,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11288,14 +11322,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11521,15 +11555,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11576,7 +11612,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11588,14 +11624,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12697,15 +12733,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12752,7 +12790,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12764,14 +12802,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14182,7 +14220,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -14383,15 +14425,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14438,7 +14482,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14450,14 +14494,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.crossSiteNetworks.html b/docs/dyn/compute_beta.crossSiteNetworks.html index 125ae067f2..742554c789 100644 --- a/docs/dyn/compute_beta.crossSiteNetworks.html +++ b/docs/dyn/compute_beta.crossSiteNetworks.html @@ -169,15 +169,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -224,7 +226,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -236,14 +238,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -522,15 +524,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -577,7 +581,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -589,14 +593,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1017,15 +1021,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1072,7 +1078,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1084,14 +1090,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.diskSettings.html b/docs/dyn/compute_beta.diskSettings.html index 522ccd35fb..487069f47a 100644 --- a/docs/dyn/compute_beta.diskSettings.html +++ b/docs/dyn/compute_beta.diskSettings.html @@ -230,15 +230,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -285,7 +287,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -297,14 +299,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.disks.html b/docs/dyn/compute_beta.disks.html index c236489e4b..e76d4683a4 100644 --- a/docs/dyn/compute_beta.disks.html +++ b/docs/dyn/compute_beta.disks.html @@ -224,15 +224,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -279,7 +281,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -291,14 +293,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -684,7 +686,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -692,7 +695,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -714,7 +718,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -943,7 +948,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -951,7 +957,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -973,7 +980,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1026,7 +1034,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1034,7 +1043,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1056,7 +1066,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1094,7 +1105,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1102,7 +1114,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1124,7 +1137,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1366,15 +1380,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1421,7 +1437,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1433,14 +1449,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1679,15 +1695,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1734,7 +1752,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1746,14 +1764,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2061,7 +2079,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2069,7 +2088,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2091,7 +2111,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2121,7 +2142,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2129,7 +2151,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2151,7 +2174,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2187,7 +2211,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2195,7 +2220,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2217,7 +2243,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2310,15 +2337,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2365,7 +2394,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2377,14 +2406,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2607,15 +2636,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2662,7 +2693,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2674,14 +2705,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2969,7 +3000,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2977,7 +3009,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2999,7 +3032,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3228,7 +3262,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3236,7 +3271,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3258,7 +3294,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3311,7 +3348,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3319,7 +3357,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3341,7 +3380,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3379,7 +3419,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3387,7 +3428,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3409,7 +3451,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3960,7 +4003,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3968,7 +4012,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3990,7 +4035,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4219,7 +4265,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4227,7 +4274,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4249,7 +4297,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4302,7 +4351,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4310,7 +4360,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4332,7 +4383,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4370,7 +4422,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4378,7 +4431,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4400,7 +4454,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4507,15 +4562,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4562,7 +4619,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4574,14 +4631,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4955,7 +5012,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4963,7 +5021,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4985,7 +5044,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5214,7 +5274,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5222,7 +5283,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5244,7 +5306,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5297,7 +5360,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5305,7 +5369,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5327,7 +5392,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5365,7 +5431,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5373,7 +5440,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5395,7 +5463,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5568,15 +5637,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5623,7 +5694,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5635,14 +5706,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5869,15 +5940,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5924,7 +5997,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5936,14 +6009,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7053,15 +7126,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7108,7 +7183,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7120,14 +7195,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7375,15 +7450,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7430,7 +7507,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7442,14 +7519,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7669,15 +7746,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7724,7 +7803,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7736,14 +7815,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7983,15 +8062,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8038,7 +8119,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8050,14 +8131,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8376,7 +8457,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8384,7 +8466,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8406,7 +8489,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8635,7 +8719,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8643,7 +8728,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8665,7 +8751,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8718,7 +8805,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8726,7 +8814,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8748,7 +8837,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8786,7 +8876,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8794,7 +8885,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8816,7 +8908,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8924,15 +9017,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8979,7 +9074,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8991,14 +9086,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9236,15 +9331,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9291,7 +9388,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9303,14 +9400,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.externalVpnGateways.html b/docs/dyn/compute_beta.externalVpnGateways.html index 3e78d44842..316f642647 100644 --- a/docs/dyn/compute_beta.externalVpnGateways.html +++ b/docs/dyn/compute_beta.externalVpnGateways.html @@ -171,15 +171,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -226,7 +228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -238,14 +240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -657,15 +659,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -712,7 +716,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -724,14 +728,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1194,15 +1198,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1249,7 +1255,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1261,14 +1267,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.firewallPolicies.html b/docs/dyn/compute_beta.firewallPolicies.html index 3a71f73b93..3e508a0e76 100644 --- a/docs/dyn/compute_beta.firewallPolicies.html +++ b/docs/dyn/compute_beta.firewallPolicies.html @@ -234,15 +234,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -289,7 +291,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -301,14 +303,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -717,15 +719,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -772,7 +776,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -784,14 +788,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1200,15 +1204,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1255,7 +1261,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1267,14 +1273,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1492,15 +1498,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1547,7 +1555,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1559,14 +1567,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1788,15 +1796,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1843,7 +1853,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1855,14 +1865,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3840,15 +3850,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3895,7 +3907,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3907,14 +3919,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4791,15 +4803,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4846,7 +4860,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4858,14 +4872,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5551,15 +5565,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5606,7 +5622,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5618,14 +5634,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6035,15 +6051,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6090,7 +6108,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6102,14 +6120,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6519,15 +6537,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6574,7 +6594,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6586,14 +6606,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6811,15 +6831,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6866,7 +6888,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6878,14 +6900,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7103,15 +7125,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7158,7 +7182,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7170,14 +7194,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7395,15 +7419,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7450,7 +7476,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7462,14 +7488,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.firewalls.html b/docs/dyn/compute_beta.firewalls.html index 284b74e1bd..f79d672d0f 100644 --- a/docs/dyn/compute_beta.firewalls.html +++ b/docs/dyn/compute_beta.firewalls.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -823,15 +825,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -878,7 +882,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -890,14 +894,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1610,15 +1614,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1665,7 +1671,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1677,14 +1683,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2110,15 +2116,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2165,7 +2173,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2177,14 +2185,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.forwardingRules.html b/docs/dyn/compute_beta.forwardingRules.html index 0b271bce9e..c54471da99 100644 --- a/docs/dyn/compute_beta.forwardingRules.html +++ b/docs/dyn/compute_beta.forwardingRules.html @@ -789,15 +789,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -844,7 +846,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -856,14 +858,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1928,15 +1930,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1983,7 +1987,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1995,14 +1999,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3201,15 +3205,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3256,7 +3262,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3268,14 +3274,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3511,15 +3517,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3566,7 +3574,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3578,14 +3586,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3812,15 +3820,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3867,7 +3877,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3879,14 +3889,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.futureReservations.html b/docs/dyn/compute_beta.futureReservations.html index 3f26cac34d..90f8c5ba43 100644 --- a/docs/dyn/compute_beta.futureReservations.html +++ b/docs/dyn/compute_beta.futureReservations.html @@ -713,15 +713,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -768,7 +770,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -780,14 +782,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1011,15 +1013,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1066,7 +1070,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1078,14 +1082,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2011,15 +2015,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2066,7 +2072,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2078,14 +2084,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3153,15 +3159,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3208,7 +3216,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3220,14 +3228,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.globalAddresses.html b/docs/dyn/compute_beta.globalAddresses.html index f6c5747b4d..a4951b928d 100644 --- a/docs/dyn/compute_beta.globalAddresses.html +++ b/docs/dyn/compute_beta.globalAddresses.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -438,8 +440,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -521,6 +525,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -574,8 +584,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -657,6 +669,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -735,15 +753,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -790,7 +810,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -802,14 +822,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1084,8 +1104,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -1167,6 +1189,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -1318,15 +1346,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1373,7 +1403,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1385,14 +1415,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1616,15 +1646,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1671,7 +1703,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1683,14 +1715,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.globalForwardingRules.html b/docs/dyn/compute_beta.globalForwardingRules.html index b21bde087d..c1d05d91b6 100644 --- a/docs/dyn/compute_beta.globalForwardingRules.html +++ b/docs/dyn/compute_beta.globalForwardingRules.html @@ -177,15 +177,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -232,7 +234,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -244,14 +246,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1315,15 +1317,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1370,7 +1374,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1382,14 +1386,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2586,15 +2590,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2641,7 +2647,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2653,14 +2659,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2885,15 +2891,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2940,7 +2948,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2952,14 +2960,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3185,15 +3193,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3240,7 +3250,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3252,14 +3262,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.globalNetworkEndpointGroups.html b/docs/dyn/compute_beta.globalNetworkEndpointGroups.html index 9c772eb22f..6d735eba7e 100644 --- a/docs/dyn/compute_beta.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_beta.globalNetworkEndpointGroups.html @@ -217,15 +217,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -272,7 +274,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -284,14 +286,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -516,15 +518,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -571,7 +575,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -583,14 +587,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -853,15 +857,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -908,7 +914,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -920,14 +926,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1628,15 +1634,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1683,7 +1691,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1695,14 +1703,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.globalOperations.html b/docs/dyn/compute_beta.globalOperations.html index fe94d5e932..2069049cbf 100644 --- a/docs/dyn/compute_beta.globalOperations.html +++ b/docs/dyn/compute_beta.globalOperations.html @@ -253,15 +253,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -308,7 +310,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -320,14 +322,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -634,15 +636,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -689,7 +693,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -701,14 +705,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1000,15 +1004,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1055,7 +1061,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1067,14 +1073,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1345,15 +1351,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1400,7 +1408,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1412,14 +1420,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.globalOrganizationOperations.html b/docs/dyn/compute_beta.globalOrganizationOperations.html index 765370e4c2..1b3dd7453e 100644 --- a/docs/dyn/compute_beta.globalOrganizationOperations.html +++ b/docs/dyn/compute_beta.globalOrganizationOperations.html @@ -166,15 +166,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -221,7 +223,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -233,14 +235,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -532,15 +534,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -587,7 +591,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -599,14 +603,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html b/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html index 1eefa6aa15..0547ce1387 100644 --- a/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html +++ b/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html @@ -168,15 +168,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -223,7 +225,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -235,14 +237,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -447,6 +449,9 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -566,6 +571,9 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -695,15 +703,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -750,7 +760,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -762,14 +772,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1059,6 +1069,9 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -1230,6 +1243,9 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -1359,15 +1375,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1414,7 +1432,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1426,14 +1444,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.globalVmExtensionPolicies.html b/docs/dyn/compute_beta.globalVmExtensionPolicies.html index 63a5b01b2d..c7878ba05d 100644 --- a/docs/dyn/compute_beta.globalVmExtensionPolicies.html +++ b/docs/dyn/compute_beta.globalVmExtensionPolicies.html @@ -475,15 +475,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -530,7 +532,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -542,14 +544,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1033,15 +1035,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1088,7 +1092,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1100,14 +1104,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1729,15 +1733,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1784,7 +1790,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1796,14 +1802,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.healthChecks.html b/docs/dyn/compute_beta.healthChecks.html index 97886aed50..3374c55e14 100644 --- a/docs/dyn/compute_beta.healthChecks.html +++ b/docs/dyn/compute_beta.healthChecks.html @@ -478,7 +478,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -565,8 +565,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. }, @@ -723,15 +724,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -778,7 +781,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -790,14 +793,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1218,7 +1221,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -1305,8 +1308,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. }
@@ -1577,7 +1581,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -1664,8 +1668,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. } @@ -1730,15 +1735,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1785,7 +1792,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1797,14 +1804,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2311,7 +2318,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -2398,8 +2405,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. }, @@ -2721,7 +2729,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -2808,8 +2816,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. } @@ -2874,15 +2883,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2929,7 +2940,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2941,14 +2952,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3398,7 +3409,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -3485,8 +3496,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. } @@ -3551,15 +3563,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3606,7 +3620,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3618,14 +3632,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.hosts.html b/docs/dyn/compute_beta.hosts.html index 37a682ef0d..ddd7305cba 100644 --- a/docs/dyn/compute_beta.hosts.html +++ b/docs/dyn/compute_beta.hosts.html @@ -220,15 +220,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -275,7 +277,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -287,14 +289,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -583,7 +585,7 @@

Method Details

"zone": "A String", # Output only. The zone in which the host resides. }, ], - "kind": "compute#host", # The type of resource. Always compute#host for a list of hosts. + "kind": "compute#hostList", # The type of resource. Always compute#host for a list of hosts. "nextPageToken": "A String", # This token allows you to get the next page of results for # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for # the query parameter pageToken in the next list request. diff --git a/docs/dyn/compute_beta.httpHealthChecks.html b/docs/dyn/compute_beta.httpHealthChecks.html index 6d0acfd7a6..a65daff544 100644 --- a/docs/dyn/compute_beta.httpHealthChecks.html +++ b/docs/dyn/compute_beta.httpHealthChecks.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -563,15 +565,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -618,7 +622,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -630,14 +634,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1089,15 +1093,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1144,7 +1150,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1156,14 +1162,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1457,15 +1463,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1512,7 +1520,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1524,14 +1532,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.httpsHealthChecks.html b/docs/dyn/compute_beta.httpsHealthChecks.html index 3edf8f6b86..33153d4f51 100644 --- a/docs/dyn/compute_beta.httpsHealthChecks.html +++ b/docs/dyn/compute_beta.httpsHealthChecks.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -571,15 +573,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -626,7 +630,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -638,14 +642,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1105,15 +1109,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1160,7 +1166,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1172,14 +1178,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1477,15 +1483,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1532,7 +1540,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1544,14 +1552,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.imageFamilyViews.html b/docs/dyn/compute_beta.imageFamilyViews.html index 1efbdf3460..1b7fc202b0 100644 --- a/docs/dyn/compute_beta.imageFamilyViews.html +++ b/docs/dyn/compute_beta.imageFamilyViews.html @@ -228,7 +228,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -236,7 +237,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -258,7 +260,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -445,7 +448,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -453,7 +457,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -475,7 +480,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -518,7 +524,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -526,7 +533,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -548,7 +556,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -591,7 +600,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -599,7 +609,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -621,7 +632,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, diff --git a/docs/dyn/compute_beta.imageViews.html b/docs/dyn/compute_beta.imageViews.html index 2cd2dbe1b9..f6291eca2c 100644 --- a/docs/dyn/compute_beta.imageViews.html +++ b/docs/dyn/compute_beta.imageViews.html @@ -227,7 +227,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -235,7 +236,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -257,7 +259,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -444,7 +447,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -452,7 +456,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -474,7 +479,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -517,7 +523,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -525,7 +532,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -547,7 +555,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -590,7 +599,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -598,7 +608,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -620,7 +631,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, diff --git a/docs/dyn/compute_beta.images.html b/docs/dyn/compute_beta.images.html index aa03ddbfb1..f03d670486 100644 --- a/docs/dyn/compute_beta.images.html +++ b/docs/dyn/compute_beta.images.html @@ -186,15 +186,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -241,7 +243,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -253,14 +255,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -526,15 +528,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -581,7 +585,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -593,14 +597,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -889,7 +893,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -897,7 +902,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -919,7 +925,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1106,7 +1113,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1114,7 +1122,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1136,7 +1145,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1179,7 +1189,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1187,7 +1198,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1209,7 +1221,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1252,7 +1265,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1260,7 +1274,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1282,7 +1297,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1444,7 +1460,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1452,7 +1469,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1474,7 +1492,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1661,7 +1680,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1669,7 +1689,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1691,7 +1712,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1734,7 +1756,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1742,7 +1765,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1764,7 +1788,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1807,7 +1832,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1815,7 +1841,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1837,7 +1864,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2359,7 +2387,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2367,7 +2396,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2389,7 +2419,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2576,7 +2607,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2584,7 +2616,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2606,7 +2639,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2649,7 +2683,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2657,7 +2692,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2679,7 +2715,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2722,7 +2759,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2730,7 +2768,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2752,7 +2791,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2833,15 +2873,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2888,7 +2930,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2900,14 +2942,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3288,7 +3330,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3296,7 +3339,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3318,7 +3362,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3505,7 +3550,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3513,7 +3559,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3535,7 +3582,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3578,7 +3626,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3586,7 +3635,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3608,7 +3658,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3651,7 +3702,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3659,7 +3711,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3681,7 +3734,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3885,7 +3939,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3893,7 +3948,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3915,7 +3971,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4102,7 +4159,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4110,7 +4168,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4132,7 +4191,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4175,7 +4235,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4183,7 +4244,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4205,7 +4267,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4248,7 +4311,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4256,7 +4320,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4278,7 +4343,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4358,15 +4424,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4413,7 +4481,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4425,14 +4493,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5530,15 +5598,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5585,7 +5655,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5597,14 +5667,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.instanceGroupManagerResizeRequests.html b/docs/dyn/compute_beta.instanceGroupManagerResizeRequests.html index 0f35a57b62..efe6e8229f 100644 --- a/docs/dyn/compute_beta.instanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_beta.instanceGroupManagerResizeRequests.html @@ -171,15 +171,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -226,7 +228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -238,14 +240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -475,15 +477,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -530,7 +534,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -542,14 +546,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -835,15 +839,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -890,7 +896,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -902,14 +908,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -940,15 +946,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -995,7 +1003,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1007,14 +1015,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1173,15 +1181,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1228,7 +1238,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1240,14 +1250,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1278,15 +1288,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1333,7 +1345,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1345,14 +1357,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1439,15 +1451,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1494,7 +1508,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1506,14 +1520,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1883,15 +1897,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1938,7 +1954,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1950,14 +1966,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1988,15 +2004,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2043,7 +2061,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2055,14 +2073,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html index b507fd031d..671fb79d88 100644 --- a/docs/dyn/compute_beta.instanceGroupManagers.html +++ b/docs/dyn/compute_beta.instanceGroupManagers.html @@ -276,15 +276,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -331,7 +333,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -343,14 +345,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -814,7 +816,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -822,7 +825,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -844,7 +848,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -908,7 +913,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -1030,7 +1078,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1038,7 +1087,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1060,7 +1110,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1112,7 +1163,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1120,7 +1172,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1142,7 +1195,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1397,15 +1451,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1452,7 +1508,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1464,14 +1520,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1507,15 +1563,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1562,7 +1620,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1574,14 +1632,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1959,7 +2017,7 @@

Method Details

The object takes the form of: { # InstanceGroupManagers.applyUpdatesToInstances - "allInstances": True or False, # Flag to update all instances instead of specified list of “instances”. + "allInstances": True or False, # Flag to update all instances instead of specified list of "instances". # If the flag is set to true then the instances may not be specified # in the request. "allowedActions": [ # Actions that are allowed to update instances within MIG. @@ -2050,15 +2108,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2105,7 +2165,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2117,14 +2177,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2374,15 +2434,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2429,7 +2491,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2441,14 +2503,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2746,15 +2808,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2801,7 +2865,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2813,14 +2877,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3045,15 +3109,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3100,7 +3166,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3112,14 +3178,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3374,15 +3440,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3429,7 +3497,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3441,14 +3509,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3669,15 +3737,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3724,7 +3794,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3736,14 +3806,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4109,7 +4179,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4117,7 +4188,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4139,7 +4211,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4203,7 +4276,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -4325,7 +4441,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4333,7 +4450,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4355,7 +4473,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4407,7 +4526,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4415,7 +4535,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4437,7 +4558,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4692,15 +4814,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4747,7 +4871,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4759,14 +4883,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4802,15 +4926,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4857,7 +4983,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4869,14 +4995,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5190,15 +5316,17 @@

Method Details

"error": { # Reason why the topology state change failed "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5245,7 +5373,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5257,14 +5385,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5519,7 +5647,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5527,7 +5656,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5549,7 +5679,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5613,7 +5744,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -5735,7 +5909,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5743,7 +5918,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5765,7 +5941,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5817,7 +5994,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5825,7 +6003,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5847,7 +6026,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -6102,15 +6282,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6157,7 +6339,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6169,14 +6351,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6212,15 +6394,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6267,7 +6451,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6279,14 +6463,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6629,15 +6813,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6684,7 +6870,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6696,14 +6882,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7155,7 +7341,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7163,7 +7350,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7185,7 +7373,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7249,7 +7438,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -7371,7 +7603,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7379,7 +7612,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7401,7 +7635,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7453,7 +7688,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7461,7 +7697,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7483,7 +7720,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7738,15 +7976,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7793,7 +8033,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7805,14 +8045,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7848,15 +8088,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7903,7 +8145,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7915,14 +8157,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8348,7 +8590,7 @@

Method Details

An object of the form: { - "items": [ # Output only. [Output Only] The list of errors of the managed instance group. + "items": [ # Output only. The list of errors of the managed instance group. { "error": { # Output only. Contents of the error. "code": "A String", # Output only. Error code. @@ -8373,8 +8615,9 @@

Method Details

"timestamp": "A String", # Output only. The time that this error occurred. This value is in RFC3339 text format. }, ], - "nextPageToken": "A String", # Output only. [Output Only] This token allows you to get the next page of results for - # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for + "nextPageToken": "A String", # Output only. This token allows you to get the next page of results for list requests. + # If the number of results is larger than maxResults + # , then use the nextPageToken as a value for # the query parameter pageToken in the next list request. # Subsequent list requests will have their own nextPageToken to # continue paging through the results. @@ -8556,15 +8799,17 @@

Method Details

# delete the instance. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8611,7 +8856,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8623,14 +8868,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8815,7 +9060,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8823,7 +9069,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8845,7 +9092,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8909,7 +9157,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -9031,7 +9322,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9039,7 +9331,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9061,7 +9354,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9113,7 +9407,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9121,7 +9416,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9143,7 +9439,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9735,7 +10032,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9743,7 +10041,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9765,7 +10064,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9829,7 +10129,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -9951,7 +10294,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9959,7 +10303,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9981,7 +10326,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10033,7 +10379,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10041,7 +10388,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10063,7 +10411,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10318,15 +10667,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10373,7 +10724,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10385,14 +10736,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10428,15 +10779,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10483,7 +10836,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10495,14 +10848,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10845,15 +11198,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10900,7 +11255,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10912,14 +11267,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11218,15 +11573,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11273,7 +11630,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11285,14 +11642,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11536,15 +11893,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11591,7 +11950,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11603,14 +11962,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11855,15 +12214,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11910,7 +12271,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11922,14 +12283,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12192,15 +12553,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12247,7 +12610,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12259,14 +12622,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12511,15 +12874,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12566,7 +12931,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12578,14 +12943,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12826,15 +13191,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12881,7 +13248,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12893,14 +13260,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13132,15 +13499,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13187,7 +13556,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13199,14 +13568,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13449,15 +13818,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13504,7 +13875,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13516,14 +13887,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13768,15 +14139,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13823,7 +14196,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13835,14 +14208,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14100,15 +14473,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14155,7 +14530,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14167,14 +14542,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14430,15 +14805,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14485,7 +14862,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14497,14 +14874,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14910,7 +15287,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -14918,7 +15296,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -14940,7 +15319,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -15004,7 +15384,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -15126,7 +15549,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -15134,7 +15558,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -15156,7 +15581,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -15208,7 +15634,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -15216,7 +15643,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -15238,7 +15666,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -15493,15 +15922,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15548,7 +15979,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15560,14 +15991,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15603,15 +16034,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15658,7 +16091,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15670,14 +16103,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16020,15 +16453,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16075,7 +16510,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16087,14 +16522,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16393,15 +16828,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16448,7 +16885,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16460,14 +16897,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.instanceGroups.html b/docs/dyn/compute_beta.instanceGroups.html index 8cfdea9fd9..bfddf09941 100644 --- a/docs/dyn/compute_beta.instanceGroups.html +++ b/docs/dyn/compute_beta.instanceGroups.html @@ -201,15 +201,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -256,7 +258,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -268,14 +270,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -759,15 +761,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -814,7 +818,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -826,14 +830,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1199,15 +1203,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1254,7 +1260,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1266,14 +1272,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1906,15 +1912,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1961,7 +1969,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1973,14 +1981,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2219,15 +2227,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2274,7 +2284,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2286,14 +2296,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.instanceSettings.html b/docs/dyn/compute_beta.instanceSettings.html index 7b8d0b6cc8..3dc1ceb7f4 100644 --- a/docs/dyn/compute_beta.instanceSettings.html +++ b/docs/dyn/compute_beta.instanceSettings.html @@ -232,15 +232,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -287,7 +289,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -299,14 +301,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.instanceTemplates.html b/docs/dyn/compute_beta.instanceTemplates.html index fc6fd60b71..2ecb3c897e 100644 --- a/docs/dyn/compute_beta.instanceTemplates.html +++ b/docs/dyn/compute_beta.instanceTemplates.html @@ -352,7 +352,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -360,7 +361,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -382,7 +384,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -446,7 +449,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -568,7 +614,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -576,7 +623,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -598,7 +646,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -650,7 +699,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -658,7 +708,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -680,7 +731,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1156,10 +1208,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1423,15 +1474,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1478,7 +1531,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1490,14 +1543,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1796,7 +1849,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1804,7 +1858,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1826,7 +1881,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1890,7 +1946,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -2012,7 +2111,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2020,7 +2120,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2042,7 +2143,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2094,7 +2196,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2102,7 +2205,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2124,7 +2228,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2600,10 +2705,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3226,7 +3330,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3234,7 +3339,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3256,7 +3362,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3320,7 +3427,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -3442,7 +3592,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3450,7 +3601,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3472,7 +3624,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3524,7 +3677,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3532,7 +3686,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3554,7 +3709,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4030,10 +4186,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4206,15 +4361,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4261,7 +4418,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4273,14 +4430,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4665,7 +4822,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4673,7 +4831,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4695,7 +4854,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4759,7 +4919,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -4881,7 +5084,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4889,7 +5093,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4911,7 +5116,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4963,7 +5169,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4971,7 +5178,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4993,7 +5201,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5469,10 +5678,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html index 620c4145e1..98ae233f73 100644 --- a/docs/dyn/compute_beta.instances.html +++ b/docs/dyn/compute_beta.instances.html @@ -372,15 +372,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -427,7 +429,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -439,14 +441,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -862,15 +864,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -917,7 +921,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -929,14 +933,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1166,15 +1170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1221,7 +1227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1233,14 +1239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1608,7 +1614,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1616,7 +1623,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1638,7 +1646,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1702,7 +1711,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -1824,7 +1876,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1832,7 +1885,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1854,7 +1908,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1906,7 +1961,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1914,7 +1970,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1936,7 +1993,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2066,7 +2124,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2074,7 +2133,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2096,7 +2156,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2470,6 +2531,12 @@

Method Details

# the location ID of the topologies. "a_key": "A String", }, + "networkTopologyIds": { # Output only. Key-value store for arbitrary network topology identifiers + # defined by the underlying infrastructure. + # The key will be the topology label and the value will be the location + # ID for the topology. + "a_key": "A String", + }, }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. @@ -2494,6 +2561,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. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. }, "shutdownDetails": { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state. @@ -2630,10 +2699,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2710,7 +2778,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2718,7 +2787,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2740,7 +2810,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2930,7 +3001,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2938,7 +3010,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2960,7 +3033,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3024,7 +3098,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -3146,7 +3263,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3154,7 +3272,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3176,7 +3295,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3228,7 +3348,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3236,7 +3357,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3258,7 +3380,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3394,15 +3517,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3449,7 +3574,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3461,14 +3586,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3711,7 +3836,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3719,7 +3845,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3741,7 +3868,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3805,7 +3933,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -3927,7 +4098,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3935,7 +4107,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3957,7 +4130,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4009,7 +4183,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4017,7 +4192,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4039,7 +4215,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4223,7 +4400,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4231,7 +4409,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4253,7 +4432,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4317,7 +4497,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -4439,7 +4662,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4447,7 +4671,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4469,7 +4694,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4521,7 +4747,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4529,7 +4756,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4551,7 +4779,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5027,10 +5256,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5232,15 +5460,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5287,7 +5517,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5299,14 +5529,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5532,15 +5762,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5587,7 +5819,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5599,14 +5831,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5827,15 +6059,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5882,7 +6116,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5894,14 +6128,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6126,15 +6360,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6181,7 +6417,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6193,14 +6429,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6421,15 +6657,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6476,7 +6714,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6488,14 +6726,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6766,7 +7004,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6774,7 +7013,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -6796,7 +7036,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -6860,7 +7101,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -6982,7 +7266,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6990,7 +7275,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7012,7 +7298,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7064,7 +7351,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7072,7 +7360,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7094,7 +7383,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7224,7 +7514,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7232,7 +7523,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7254,7 +7546,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7628,6 +7921,12 @@

Method Details

# the location ID of the topologies. "a_key": "A String", }, + "networkTopologyIds": { # Output only. Key-value store for arbitrary network topology identifiers + # defined by the underlying infrastructure. + # The key will be the topology label and the value will be the location + # ID for the topology. + "a_key": "A String", + }, }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. @@ -7652,6 +7951,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. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. }, "shutdownDetails": { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state. @@ -7788,10 +8089,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7868,7 +8168,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7876,7 +8177,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7898,7 +8200,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9695,7 +9998,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9703,7 +10007,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9725,7 +10030,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9789,7 +10095,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -9911,7 +10260,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9919,7 +10269,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9941,7 +10292,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9993,7 +10345,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10001,7 +10354,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10023,7 +10377,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10153,7 +10508,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10161,7 +10517,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10183,7 +10540,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10557,6 +10915,12 @@

Method Details

# the location ID of the topologies. "a_key": "A String", }, + "networkTopologyIds": { # Output only. Key-value store for arbitrary network topology identifiers + # defined by the underlying infrastructure. + # The key will be the topology label and the value will be the location + # ID for the topology. + "a_key": "A String", + }, }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. @@ -10581,6 +10945,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. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. }, "shutdownDetails": { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state. @@ -10717,10 +11083,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -10797,7 +11162,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10805,7 +11171,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10827,7 +11194,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10943,15 +11311,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10998,7 +11368,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11010,14 +11380,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11374,7 +11744,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -11382,7 +11753,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -11404,7 +11776,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11468,7 +11841,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -11590,7 +12006,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -11598,7 +12015,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -11620,7 +12038,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11672,7 +12091,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -11680,7 +12100,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -11702,7 +12123,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11832,7 +12254,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -11840,7 +12263,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -11862,7 +12286,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -12236,6 +12661,12 @@

Method Details

# the location ID of the topologies. "a_key": "A String", }, + "networkTopologyIds": { # Output only. Key-value store for arbitrary network topology identifiers + # defined by the underlying infrastructure. + # The key will be the topology label and the value will be the location + # ID for the topology. + "a_key": "A String", + }, }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. @@ -12260,6 +12691,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. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. }, "shutdownDetails": { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state. @@ -12396,10 +12829,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12476,7 +12908,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -12484,7 +12917,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -12506,7 +12940,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -12852,15 +13287,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12907,7 +13344,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12919,14 +13356,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13145,15 +13582,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13200,7 +13639,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13212,14 +13651,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13447,15 +13886,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13502,7 +13943,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13514,14 +13955,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13753,15 +14194,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13808,7 +14251,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13820,14 +14263,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14048,15 +14491,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14103,7 +14548,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14115,14 +14560,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14314,7 +14759,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -14322,7 +14768,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -14344,7 +14791,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -14379,7 +14827,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -14387,7 +14836,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -14409,7 +14859,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -14475,15 +14926,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14530,7 +14983,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14542,14 +14995,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14784,15 +15237,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14839,7 +15294,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14851,14 +15306,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15080,15 +15535,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15135,7 +15592,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15147,14 +15604,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16261,15 +16718,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16316,7 +16775,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16328,14 +16787,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16573,15 +17032,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16628,7 +17089,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16640,14 +17101,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16875,15 +17336,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16930,7 +17393,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16942,14 +17405,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17200,15 +17663,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17255,7 +17720,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17267,14 +17732,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17503,15 +17968,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17558,7 +18025,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17570,14 +18037,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17805,15 +18272,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17860,7 +18329,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17872,14 +18341,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -18142,10 +18611,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -18225,15 +18693,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -18280,7 +18750,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -18292,14 +18762,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -18535,15 +19005,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -18590,7 +19062,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -18602,14 +19074,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -18840,15 +19312,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -18895,7 +19369,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -18907,14 +19381,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -19145,15 +19619,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -19200,7 +19676,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -19212,14 +19688,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -19450,15 +19926,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -19505,7 +19983,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -19517,14 +19995,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -19762,15 +20240,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -19817,7 +20297,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -19829,14 +20309,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -20058,15 +20538,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -20113,7 +20595,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20125,14 +20607,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -20353,15 +20835,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -20408,7 +20892,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20420,14 +20904,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -20620,7 +21104,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -20628,7 +21113,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -20650,7 +21136,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -20724,15 +21211,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -20779,7 +21268,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20791,14 +21280,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -21026,15 +21515,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -21081,7 +21572,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -21093,14 +21584,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -21329,15 +21820,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -21384,7 +21877,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -21396,14 +21889,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -21701,7 +22194,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -21709,7 +22203,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -21731,7 +22226,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -21795,7 +22291,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -21917,7 +22456,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -21925,7 +22465,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -21947,7 +22488,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -21999,7 +22541,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -22007,7 +22550,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -22029,7 +22573,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -22159,7 +22704,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -22167,7 +22713,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -22189,7 +22736,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -22563,6 +23111,12 @@

Method Details

# the location ID of the topologies. "a_key": "A String", }, + "networkTopologyIds": { # Output only. Key-value store for arbitrary network topology identifiers + # defined by the underlying infrastructure. + # The key will be the topology label and the value will be the location + # ID for the topology. + "a_key": "A String", + }, }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. @@ -22587,6 +23141,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. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. }, "shutdownDetails": { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state. @@ -22723,10 +23279,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -22803,7 +23358,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -22811,7 +23367,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -22833,7 +23390,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -22952,15 +23510,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -23007,7 +23567,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -23019,14 +23579,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -23297,15 +23857,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -23352,7 +23914,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -23364,14 +23926,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -23600,15 +24162,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -23655,7 +24219,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -23667,14 +24231,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -24095,15 +24659,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -24150,7 +24716,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -24162,14 +24728,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -24403,15 +24969,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -24458,7 +25026,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -24470,14 +25038,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -24708,15 +25276,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -24763,7 +25333,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -24775,14 +25345,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.instantSnapshotGroups.html b/docs/dyn/compute_beta.instantSnapshotGroups.html index fd169a9126..76fcf48a6f 100644 --- a/docs/dyn/compute_beta.instantSnapshotGroups.html +++ b/docs/dyn/compute_beta.instantSnapshotGroups.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -933,15 +935,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -988,7 +992,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1000,14 +1004,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.instantSnapshots.html b/docs/dyn/compute_beta.instantSnapshots.html index 98947ba5a9..9cf643d144 100644 --- a/docs/dyn/compute_beta.instantSnapshots.html +++ b/docs/dyn/compute_beta.instantSnapshots.html @@ -481,15 +481,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -536,7 +538,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -548,14 +550,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1352,15 +1354,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1407,7 +1411,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1419,14 +1423,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2783,15 +2787,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2838,7 +2844,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2850,14 +2856,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.interconnectAttachmentGroups.html b/docs/dyn/compute_beta.interconnectAttachmentGroups.html index 35d1d156d1..0bd8ec8ddc 100644 --- a/docs/dyn/compute_beta.interconnectAttachmentGroups.html +++ b/docs/dyn/compute_beta.interconnectAttachmentGroups.html @@ -181,15 +181,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -236,7 +238,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -248,14 +250,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1210,15 +1212,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1265,7 +1269,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1277,14 +1281,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1893,15 +1897,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1948,7 +1954,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1960,14 +1966,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.interconnectAttachments.html b/docs/dyn/compute_beta.interconnectAttachments.html index 9466040018..6ee398d844 100644 --- a/docs/dyn/compute_beta.interconnectAttachments.html +++ b/docs/dyn/compute_beta.interconnectAttachments.html @@ -754,15 +754,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -809,7 +811,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -821,14 +823,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1824,15 +1826,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1879,7 +1883,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1891,14 +1895,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3032,15 +3036,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3087,7 +3093,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3099,14 +3105,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3342,15 +3348,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3397,7 +3405,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3409,14 +3417,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.interconnectGroups.html b/docs/dyn/compute_beta.interconnectGroups.html index c440fc9eeb..336625ecab 100644 --- a/docs/dyn/compute_beta.interconnectGroups.html +++ b/docs/dyn/compute_beta.interconnectGroups.html @@ -305,15 +305,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -360,7 +362,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -372,14 +374,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -598,15 +600,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -653,7 +657,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -665,14 +669,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1699,15 +1703,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1754,7 +1760,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1766,14 +1772,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2369,15 +2375,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2424,7 +2432,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2436,14 +2444,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.interconnects.html b/docs/dyn/compute_beta.interconnects.html index 3400b16e1c..838c0b7fca 100644 --- a/docs/dyn/compute_beta.interconnects.html +++ b/docs/dyn/compute_beta.interconnects.html @@ -180,15 +180,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -235,7 +237,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -247,14 +249,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1209,15 +1211,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1264,7 +1268,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1276,14 +1280,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2220,15 +2224,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2275,7 +2281,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2287,14 +2293,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2519,15 +2525,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2574,7 +2582,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2586,14 +2594,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.licenses.html b/docs/dyn/compute_beta.licenses.html index 933d0d1211..9f2cc77740 100644 --- a/docs/dyn/compute_beta.licenses.html +++ b/docs/dyn/compute_beta.licenses.html @@ -180,15 +180,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -235,7 +237,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -247,14 +249,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1029,15 +1031,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1084,7 +1088,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1096,14 +1100,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2559,15 +2563,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2614,7 +2620,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2626,14 +2632,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.machineImages.html b/docs/dyn/compute_beta.machineImages.html index 8352e66c2c..74499df5d1 100644 --- a/docs/dyn/compute_beta.machineImages.html +++ b/docs/dyn/compute_beta.machineImages.html @@ -178,15 +178,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -233,7 +235,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -245,14 +247,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -529,7 +531,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -537,7 +540,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -559,7 +563,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -623,7 +628,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -745,7 +793,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -753,7 +802,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -775,7 +825,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -827,7 +878,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -835,7 +887,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -857,7 +910,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1333,10 +1387,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1446,7 +1499,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1454,7 +1508,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1476,7 +1531,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1550,7 +1606,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1558,7 +1615,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1580,7 +1638,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1641,7 +1700,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1649,7 +1709,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1671,7 +1732,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2074,10 +2136,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2626,7 +2687,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2634,7 +2696,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2656,7 +2719,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2720,7 +2784,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -2842,7 +2949,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2850,7 +2958,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2872,7 +2981,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2924,7 +3034,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2932,7 +3043,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2954,7 +3066,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3430,10 +3543,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3543,7 +3655,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3551,7 +3664,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3573,7 +3687,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3647,7 +3762,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3655,7 +3771,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3677,7 +3794,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3738,7 +3856,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3746,7 +3865,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3768,7 +3888,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4171,10 +4292,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4291,15 +4411,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4346,7 +4468,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4358,14 +4480,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4728,7 +4850,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4736,7 +4859,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4758,7 +4882,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4822,7 +4947,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -4944,7 +5112,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4952,7 +5121,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4974,7 +5144,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5026,7 +5197,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5034,7 +5206,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5056,7 +5229,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5532,10 +5706,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5645,7 +5818,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5653,7 +5827,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5675,7 +5850,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5749,7 +5925,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5757,7 +5934,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5779,7 +5957,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5840,7 +6019,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5848,7 +6028,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5870,7 +6051,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -6273,10 +6455,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7328,15 +7509,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7383,7 +7566,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7395,14 +7578,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.networkAttachments.html b/docs/dyn/compute_beta.networkAttachments.html index 08fd18b9d7..6b3fec0fdb 100644 --- a/docs/dyn/compute_beta.networkAttachments.html +++ b/docs/dyn/compute_beta.networkAttachments.html @@ -446,15 +446,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -501,7 +503,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -513,14 +515,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1267,15 +1269,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1322,7 +1326,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1334,14 +1338,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1855,15 +1859,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1910,7 +1916,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1922,14 +1928,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.networkEdgeSecurityServices.html b/docs/dyn/compute_beta.networkEdgeSecurityServices.html index 380ce02f0f..58aab152b8 100644 --- a/docs/dyn/compute_beta.networkEdgeSecurityServices.html +++ b/docs/dyn/compute_beta.networkEdgeSecurityServices.html @@ -399,15 +399,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -454,7 +456,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -466,14 +468,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -779,15 +781,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -834,7 +838,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -846,14 +850,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1110,15 +1114,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1165,7 +1171,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1177,14 +1183,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.networkEndpointGroups.html b/docs/dyn/compute_beta.networkEndpointGroups.html index 6f9c83bf1c..68c50eb41f 100644 --- a/docs/dyn/compute_beta.networkEndpointGroups.html +++ b/docs/dyn/compute_beta.networkEndpointGroups.html @@ -649,15 +649,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -704,7 +706,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -716,14 +718,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -952,15 +954,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1007,7 +1011,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1019,14 +1023,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1292,15 +1296,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1347,7 +1353,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1359,14 +1365,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2072,15 +2078,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2127,7 +2135,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2139,14 +2147,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.networkFirewallPolicies.html b/docs/dyn/compute_beta.networkFirewallPolicies.html index fe220e3aee..98ed34fc54 100644 --- a/docs/dyn/compute_beta.networkFirewallPolicies.html +++ b/docs/dyn/compute_beta.networkFirewallPolicies.html @@ -235,15 +235,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -290,7 +292,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -302,14 +304,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -723,15 +725,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -778,7 +782,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -790,14 +794,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1211,15 +1215,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1266,7 +1272,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1278,14 +1284,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2167,15 +2173,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2222,7 +2230,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2234,14 +2242,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2464,15 +2472,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2519,7 +2529,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2531,14 +2541,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4519,15 +4529,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4574,7 +4586,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4586,14 +4598,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5894,15 +5906,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5949,7 +5963,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5961,14 +5975,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6379,15 +6393,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6434,7 +6450,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6446,14 +6462,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6864,15 +6880,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6919,7 +6937,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6931,14 +6949,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7157,15 +7175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7212,7 +7232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7224,14 +7244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7450,15 +7470,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7505,7 +7527,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7517,14 +7539,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7743,15 +7765,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7798,7 +7822,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7810,14 +7834,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.networks.html b/docs/dyn/compute_beta.networks.html index 0438648db1..c0834704f5 100644 --- a/docs/dyn/compute_beta.networks.html +++ b/docs/dyn/compute_beta.networks.html @@ -285,15 +285,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -340,7 +342,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -352,14 +354,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -586,15 +588,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -641,7 +645,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -653,14 +657,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -883,15 +887,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -938,7 +944,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -950,14 +956,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2608,15 +2614,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2663,7 +2671,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2675,14 +2683,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3582,15 +3590,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3637,7 +3647,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3649,14 +3659,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3881,15 +3891,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3936,7 +3948,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3948,14 +3960,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4181,15 +4193,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4236,7 +4250,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4248,14 +4262,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4473,15 +4487,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4528,7 +4544,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4540,14 +4556,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4875,15 +4891,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4930,7 +4948,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4942,14 +4960,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.nodeGroups.html b/docs/dyn/compute_beta.nodeGroups.html index 02c6eb35c8..d9fb30446d 100644 --- a/docs/dyn/compute_beta.nodeGroups.html +++ b/docs/dyn/compute_beta.nodeGroups.html @@ -207,15 +207,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -262,7 +264,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -274,14 +276,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -795,15 +797,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -850,7 +854,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -862,14 +866,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1097,15 +1101,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1152,7 +1158,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1164,14 +1170,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1971,15 +1977,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2026,7 +2034,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2038,14 +2046,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2840,15 +2848,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2895,7 +2905,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2907,14 +2917,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3143,15 +3153,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3198,7 +3210,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3210,14 +3222,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4319,15 +4331,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4374,7 +4388,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4386,14 +4400,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4622,15 +4636,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4677,7 +4693,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4689,14 +4705,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.nodeTemplates.html b/docs/dyn/compute_beta.nodeTemplates.html index 0b6af6f0ce..e6c6849b7a 100644 --- a/docs/dyn/compute_beta.nodeTemplates.html +++ b/docs/dyn/compute_beta.nodeTemplates.html @@ -449,15 +449,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -504,7 +506,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -516,14 +518,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1277,15 +1279,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1332,7 +1336,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1344,14 +1348,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.organizationRolloutPlans.html b/docs/dyn/compute_beta.organizationRolloutPlans.html index cde835cef8..a53b373216 100644 --- a/docs/dyn/compute_beta.organizationRolloutPlans.html +++ b/docs/dyn/compute_beta.organizationRolloutPlans.html @@ -165,15 +165,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -220,7 +222,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -232,14 +234,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -667,15 +669,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -722,7 +726,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -734,14 +738,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.organizationRollouts.html b/docs/dyn/compute_beta.organizationRollouts.html index f5d3319efd..f6b6fd3bc9 100644 --- a/docs/dyn/compute_beta.organizationRollouts.html +++ b/docs/dyn/compute_beta.organizationRollouts.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -466,15 +468,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -521,7 +525,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -533,14 +537,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -763,15 +767,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -818,7 +824,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -830,14 +836,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1399,15 +1405,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1454,7 +1462,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1466,14 +1474,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1694,15 +1702,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1749,7 +1759,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1761,14 +1771,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.organizationSecurityPolicies.html b/docs/dyn/compute_beta.organizationSecurityPolicies.html index d86f9f3295..ad192dd3ed 100644 --- a/docs/dyn/compute_beta.organizationSecurityPolicies.html +++ b/docs/dyn/compute_beta.organizationSecurityPolicies.html @@ -224,15 +224,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -279,7 +281,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -291,14 +293,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -989,15 +991,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1044,7 +1048,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1056,14 +1060,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1291,15 +1295,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1346,7 +1352,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1358,14 +1364,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1586,15 +1592,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1641,7 +1649,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1653,14 +1661,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3856,15 +3864,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3911,7 +3921,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3923,14 +3933,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5195,15 +5205,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5250,7 +5262,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5262,14 +5274,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6208,15 +6220,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6263,7 +6277,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6275,14 +6289,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6976,15 +6990,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7031,7 +7047,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7043,14 +7059,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7273,15 +7289,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7328,7 +7346,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7340,14 +7358,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7570,15 +7588,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7625,7 +7645,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7637,14 +7657,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.packetMirrorings.html b/docs/dyn/compute_beta.packetMirrorings.html index 879a1cb4ea..708455c6d8 100644 --- a/docs/dyn/compute_beta.packetMirrorings.html +++ b/docs/dyn/compute_beta.packetMirrorings.html @@ -475,15 +475,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -530,7 +532,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -542,14 +544,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -994,15 +996,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1049,7 +1053,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1061,14 +1065,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1651,15 +1655,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1706,7 +1712,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1718,14 +1724,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.previewFeatures.html b/docs/dyn/compute_beta.previewFeatures.html index 4f9fee08bf..e57c8ab2a8 100644 --- a/docs/dyn/compute_beta.previewFeatures.html +++ b/docs/dyn/compute_beta.previewFeatures.html @@ -503,15 +503,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -558,7 +560,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -570,14 +572,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.projectViews.html b/docs/dyn/compute_beta.projectViews.html index 02e531673d..a629c7e454 100644 --- a/docs/dyn/compute_beta.projectViews.html +++ b/docs/dyn/compute_beta.projectViews.html @@ -90,6 +90,12 @@

Method Details

get(project, region, x__xgafv=None)
Returns the specified global ProjectViews resource, with a regional
 context.
+This regional API endpoint reads resource metadata from regional
+read-only replicas. Because changes are copied to these regional replicas
+asynchronously, for real-time resource reads or any write operations
+(creating, updating, or deleting resources), use the global
+[projects.get](https://cloud.google.com/compute/docs/reference/rest/v1/projects/get)
+endpoint.
 
 Args:
   project: string, Required. Project ID for this request. This is part of the URL path. (required)
@@ -107,6 +113,11 @@ 

Method Details

# A ProjectView resource contains read-only project data which is available # globally. "project": { # Represents a Project resource. # The project data. + # The returned Project data does not contain regional or zonal quota + # usage data. Global quota limits are present. For accurate, real-time quota + # usage numbers, query the global + # [projects.get](https://cloud.google.com/compute/docs/reference/rest/v1/projects/get) + # endpoint. # # A project is used to organize resources in a Google Cloud Platform # environment. For more information, read about the diff --git a/docs/dyn/compute_beta.projects.html b/docs/dyn/compute_beta.projects.html index 7c3dbe7c90..5ecf1c9444 100644 --- a/docs/dyn/compute_beta.projects.html +++ b/docs/dyn/compute_beta.projects.html @@ -200,15 +200,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -255,7 +257,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -267,14 +269,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -504,15 +506,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -559,7 +563,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -571,14 +575,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -795,15 +799,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -850,7 +856,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -862,14 +868,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1100,15 +1106,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1155,7 +1163,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1167,14 +1175,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2016,15 +2024,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2071,7 +2081,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2083,14 +2093,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2331,15 +2341,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2386,7 +2398,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2398,14 +2410,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2632,15 +2644,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2687,7 +2701,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2699,14 +2713,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2955,15 +2969,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3010,7 +3026,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3022,14 +3038,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3255,15 +3271,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3310,7 +3328,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3322,14 +3340,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3556,15 +3574,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3611,7 +3631,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3623,14 +3643,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3864,15 +3884,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3919,7 +3941,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3931,14 +3953,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.publicAdvertisedPrefixes.html b/docs/dyn/compute_beta.publicAdvertisedPrefixes.html index d41f6cabfe..e168c50d1c 100644 --- a/docs/dyn/compute_beta.publicAdvertisedPrefixes.html +++ b/docs/dyn/compute_beta.publicAdvertisedPrefixes.html @@ -169,15 +169,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -224,7 +226,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -236,14 +238,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -466,15 +468,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -521,7 +525,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -533,14 +537,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -736,6 +740,9 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "networkTier": "A String", # Network tier to be used for this prefix. All child delegated prefixes will + # inherit this field. If this field is not specified, it defaults to the + # network tier of the project that the PublicAdvertisedPrefix belongs to. "pdpScope": "A String", # Specifies how child public delegated prefix will be scoped. It could # be one of following values: # @@ -817,6 +824,9 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "networkTier": "A String", # Network tier to be used for this prefix. All child delegated prefixes will + # inherit this field. If this field is not specified, it defaults to the + # network tier of the project that the PublicAdvertisedPrefix belongs to. "pdpScope": "A String", # Specifies how child public delegated prefix will be scoped. It could # be one of following values: # @@ -917,15 +927,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -972,7 +984,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -984,14 +996,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1272,6 +1284,9 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "networkTier": "A String", # Network tier to be used for this prefix. All child delegated prefixes will + # inherit this field. If this field is not specified, it defaults to the + # network tier of the project that the PublicAdvertisedPrefix belongs to. "pdpScope": "A String", # Specifies how child public delegated prefix will be scoped. It could # be one of following values: # @@ -1404,6 +1419,9 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "networkTier": "A String", # Network tier to be used for this prefix. All child delegated prefixes will + # inherit this field. If this field is not specified, it defaults to the + # network tier of the project that the PublicAdvertisedPrefix belongs to. "pdpScope": "A String", # Specifies how child public delegated prefix will be scoped. It could # be one of following values: # @@ -1504,15 +1522,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1559,7 +1579,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1571,14 +1591,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1796,15 +1816,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1851,7 +1873,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1863,14 +1885,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.publicDelegatedPrefixes.html b/docs/dyn/compute_beta.publicDelegatedPrefixes.html index 67d69b4221..7d607cd1cd 100644 --- a/docs/dyn/compute_beta.publicDelegatedPrefixes.html +++ b/docs/dyn/compute_beta.publicDelegatedPrefixes.html @@ -263,6 +263,9 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -482,15 +485,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -537,7 +542,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -549,14 +554,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -780,15 +785,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -835,7 +842,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -847,14 +854,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1060,6 +1067,9 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -1180,6 +1190,9 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -1309,15 +1322,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1364,7 +1379,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1376,14 +1391,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1674,6 +1689,9 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -1846,6 +1864,9 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -1975,15 +1996,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2030,7 +2053,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2042,14 +2065,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2269,15 +2292,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2324,7 +2349,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2336,14 +2361,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionAutoscalers.html b/docs/dyn/compute_beta.regionAutoscalers.html index 59fdd12ad1..7f76e1fd45 100644 --- a/docs/dyn/compute_beta.regionAutoscalers.html +++ b/docs/dyn/compute_beta.regionAutoscalers.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1218,15 +1220,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1273,7 +1277,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1285,14 +1289,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2398,15 +2402,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2453,7 +2459,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2465,14 +2471,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3094,15 +3100,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3149,7 +3157,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3161,14 +3169,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionBackendBuckets.html b/docs/dyn/compute_beta.regionBackendBuckets.html index feba2a6697..1d983790c7 100644 --- a/docs/dyn/compute_beta.regionBackendBuckets.html +++ b/docs/dyn/compute_beta.regionBackendBuckets.html @@ -188,15 +188,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -243,7 +245,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -255,14 +257,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1254,15 +1256,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1309,7 +1313,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1321,14 +1325,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2434,15 +2438,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2489,7 +2495,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2501,14 +2507,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionBackendServices.html b/docs/dyn/compute_beta.regionBackendServices.html index 2ddcb58660..4f008c87b4 100644 --- a/docs/dyn/compute_beta.regionBackendServices.html +++ b/docs/dyn/compute_beta.regionBackendServices.html @@ -193,15 +193,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -248,7 +250,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -260,14 +262,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1649,7 +1651,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -3443,7 +3449,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -3644,15 +3654,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3699,7 +3711,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3711,14 +3723,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5186,7 +5198,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -6682,7 +6698,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -8117,7 +8137,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -8318,15 +8342,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8373,7 +8399,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8385,14 +8411,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9496,15 +9522,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9551,7 +9579,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9563,14 +9591,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10984,7 +11012,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -11185,15 +11217,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11240,7 +11274,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11252,14 +11286,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionCommitments.html b/docs/dyn/compute_beta.regionCommitments.html index 1e7b8c1f22..de2fe934b0 100644 --- a/docs/dyn/compute_beta.regionCommitments.html +++ b/docs/dyn/compute_beta.regionCommitments.html @@ -1605,15 +1605,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1660,7 +1662,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1672,14 +1674,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2899,15 +2901,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2954,7 +2958,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2966,14 +2970,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3452,15 +3456,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3507,7 +3513,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3519,14 +3525,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionCompositeHealthChecks.html b/docs/dyn/compute_beta.regionCompositeHealthChecks.html index 669a858af5..7ed5108552 100644 --- a/docs/dyn/compute_beta.regionCompositeHealthChecks.html +++ b/docs/dyn/compute_beta.regionCompositeHealthChecks.html @@ -419,15 +419,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -474,7 +476,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -486,14 +488,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -848,15 +850,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -903,7 +907,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -915,14 +919,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1384,15 +1388,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1439,7 +1445,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1451,14 +1457,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionDiskSettings.html b/docs/dyn/compute_beta.regionDiskSettings.html index 3b43c78e29..f14cce2099 100644 --- a/docs/dyn/compute_beta.regionDiskSettings.html +++ b/docs/dyn/compute_beta.regionDiskSettings.html @@ -230,15 +230,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -285,7 +287,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -297,14 +299,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionDisks.html b/docs/dyn/compute_beta.regionDisks.html index e9a3e0bff1..d713566060 100644 --- a/docs/dyn/compute_beta.regionDisks.html +++ b/docs/dyn/compute_beta.regionDisks.html @@ -214,15 +214,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -269,7 +271,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -281,14 +283,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -554,15 +556,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -609,7 +613,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -621,14 +625,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -936,7 +940,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -944,7 +949,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -966,7 +972,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -996,7 +1003,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1004,7 +1012,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1026,7 +1035,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1062,7 +1072,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1070,7 +1081,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1092,7 +1104,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1183,15 +1196,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1238,7 +1253,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1250,14 +1265,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1480,15 +1495,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1535,7 +1552,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1547,14 +1564,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1842,7 +1859,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1850,7 +1868,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1872,7 +1891,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2101,7 +2121,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2109,7 +2130,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2131,7 +2153,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2184,7 +2207,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2192,7 +2216,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2214,7 +2239,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2252,7 +2278,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2260,7 +2287,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2282,7 +2310,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2830,7 +2859,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2838,7 +2868,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2860,7 +2891,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3089,7 +3121,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3097,7 +3130,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3119,7 +3153,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3172,7 +3207,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3180,7 +3216,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3202,7 +3239,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3240,7 +3278,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3248,7 +3287,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3270,7 +3310,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3377,15 +3418,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3432,7 +3475,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3444,14 +3487,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3825,7 +3868,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3833,7 +3877,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3855,7 +3900,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4084,7 +4130,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4092,7 +4139,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4114,7 +4162,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4167,7 +4216,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4175,7 +4225,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4197,7 +4248,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4235,7 +4287,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4243,7 +4296,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4265,7 +4319,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4438,15 +4493,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4493,7 +4550,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4505,14 +4562,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4738,15 +4795,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4793,7 +4852,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4805,14 +4864,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5921,15 +5980,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5976,7 +6037,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5988,14 +6049,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6243,15 +6304,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6298,7 +6361,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6310,14 +6373,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6537,15 +6600,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6592,7 +6657,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6604,14 +6669,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6851,15 +6916,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6906,7 +6973,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6918,14 +6985,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7243,7 +7310,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7251,7 +7319,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7273,7 +7342,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7502,7 +7572,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7510,7 +7581,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7532,7 +7604,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7585,7 +7658,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7593,7 +7667,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7615,7 +7690,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7653,7 +7729,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7661,7 +7738,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7683,7 +7761,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7791,15 +7870,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7846,7 +7927,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7858,14 +7939,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8103,15 +8184,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8158,7 +8241,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8170,14 +8253,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionHealthAggregationPolicies.html b/docs/dyn/compute_beta.regionHealthAggregationPolicies.html index 8cc899bf59..d237420bc9 100644 --- a/docs/dyn/compute_beta.regionHealthAggregationPolicies.html +++ b/docs/dyn/compute_beta.regionHealthAggregationPolicies.html @@ -432,15 +432,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -487,7 +489,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -499,14 +501,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -863,15 +865,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -918,7 +922,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -930,14 +934,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1432,15 +1436,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1487,7 +1493,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1499,14 +1505,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionHealthCheckServices.html b/docs/dyn/compute_beta.regionHealthCheckServices.html index 51ce0732b2..2c8348b8c7 100644 --- a/docs/dyn/compute_beta.regionHealthCheckServices.html +++ b/docs/dyn/compute_beta.regionHealthCheckServices.html @@ -449,15 +449,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -504,7 +506,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -516,14 +518,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -913,15 +915,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -968,7 +972,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -980,14 +984,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1515,15 +1519,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1570,7 +1576,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1582,14 +1588,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionHealthChecks.html b/docs/dyn/compute_beta.regionHealthChecks.html index 21f6db5019..39f69f52d6 100644 --- a/docs/dyn/compute_beta.regionHealthChecks.html +++ b/docs/dyn/compute_beta.regionHealthChecks.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -671,7 +673,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -758,8 +760,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. }
@@ -1031,7 +1034,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -1118,8 +1121,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. } @@ -1184,15 +1188,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1239,7 +1245,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1251,14 +1257,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1766,7 +1772,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -1853,8 +1859,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. }, @@ -2177,7 +2184,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -2264,8 +2271,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. } @@ -2330,15 +2338,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2385,7 +2395,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2397,14 +2407,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2856,7 +2866,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -2943,8 +2953,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. } @@ -3009,15 +3020,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3064,7 +3077,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3076,14 +3089,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionHealthSources.html b/docs/dyn/compute_beta.regionHealthSources.html index e36211ec47..b6a367dc36 100644 --- a/docs/dyn/compute_beta.regionHealthSources.html +++ b/docs/dyn/compute_beta.regionHealthSources.html @@ -422,15 +422,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -477,7 +479,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -489,14 +491,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -870,15 +872,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -925,7 +929,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -937,14 +941,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1412,15 +1416,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1467,7 +1473,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1479,14 +1485,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagerResizeRequests.html b/docs/dyn/compute_beta.regionInstanceGroupManagerResizeRequests.html index 18d0cfca16..d4d8b88399 100644 --- a/docs/dyn/compute_beta.regionInstanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_beta.regionInstanceGroupManagerResizeRequests.html @@ -171,15 +171,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -226,7 +228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -238,14 +240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -475,15 +477,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -530,7 +534,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -542,14 +546,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -835,15 +839,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -890,7 +896,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -902,14 +908,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -940,15 +946,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -995,7 +1003,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1007,14 +1015,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1171,15 +1179,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1226,7 +1236,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1238,14 +1248,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1276,15 +1286,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1331,7 +1343,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1343,14 +1355,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1437,15 +1449,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1492,7 +1506,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1504,14 +1518,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1882,15 +1896,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1937,7 +1953,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1949,14 +1965,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1987,15 +2003,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2042,7 +2060,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2054,14 +2072,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html index e9fe4a1172..e686ce7b0c 100644 --- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html @@ -266,15 +266,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -321,7 +323,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -333,14 +335,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -641,15 +643,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -696,7 +700,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -708,14 +712,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -878,7 +882,7 @@

Method Details

The object takes the form of: { # RegionInstanceGroupManagers.applyUpdatesToInstances - "allInstances": True or False, # Flag to update all instances instead of specified list of “instances”. + "allInstances": True or False, # Flag to update all instances instead of specified list of "instances". # If the flag is set to true then the instances may not be specified # in the request. "allowedActions": [ # Actions that are allowed to update instances within MIG. @@ -969,15 +973,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1024,7 +1030,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1036,14 +1042,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1348,15 +1354,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1403,7 +1411,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1415,14 +1423,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1644,15 +1652,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1699,7 +1709,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1711,14 +1721,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1970,15 +1980,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2025,7 +2037,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2037,14 +2049,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2261,15 +2273,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2316,7 +2330,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2328,14 +2342,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2700,7 +2714,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2708,7 +2723,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2730,7 +2746,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2794,7 +2811,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -2916,7 +2976,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2924,7 +2985,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2946,7 +3008,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2998,7 +3061,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3006,7 +3070,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3028,7 +3093,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3283,15 +3349,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3338,7 +3406,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3350,14 +3418,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3393,15 +3461,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3448,7 +3518,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3460,14 +3530,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3967,7 +4037,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3975,7 +4046,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3997,7 +4069,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4061,7 +4134,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -4183,7 +4299,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4191,7 +4308,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4213,7 +4331,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4265,7 +4384,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4273,7 +4393,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4295,7 +4416,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4550,15 +4672,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4605,7 +4729,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4617,14 +4741,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4660,15 +4784,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4715,7 +4841,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4727,14 +4853,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5077,15 +5203,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5132,7 +5260,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5144,14 +5272,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5602,7 +5730,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5610,7 +5739,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5632,7 +5762,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5696,7 +5827,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -5818,7 +5992,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5826,7 +6001,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5848,7 +6024,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5900,7 +6077,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5908,7 +6086,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5930,7 +6109,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -6185,15 +6365,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6240,7 +6422,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6252,14 +6434,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6295,15 +6477,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6350,7 +6534,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6362,14 +6546,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6997,15 +7181,17 @@

Method Details

# delete the instance. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7052,7 +7238,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7064,14 +7250,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7256,7 +7442,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7264,7 +7451,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7286,7 +7474,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7350,7 +7539,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -7472,7 +7704,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7480,7 +7713,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7502,7 +7736,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7554,7 +7789,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7562,7 +7798,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7584,7 +7821,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8173,7 +8411,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8181,7 +8420,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8203,7 +8443,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8267,7 +8508,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -8389,7 +8673,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8397,7 +8682,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8419,7 +8705,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8471,7 +8758,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8479,7 +8767,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8501,7 +8790,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8756,15 +9046,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8811,7 +9103,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8823,14 +9115,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8866,15 +9158,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8921,7 +9215,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8933,14 +9227,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9283,15 +9577,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9338,7 +9634,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9350,14 +9646,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9654,15 +9950,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9709,7 +10007,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9721,14 +10019,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9971,15 +10269,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10026,7 +10326,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10038,14 +10338,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10278,15 +10578,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10333,7 +10635,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10345,14 +10647,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10616,15 +10918,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10671,7 +10975,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10683,14 +10987,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10934,15 +11238,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10989,7 +11295,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11001,14 +11307,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11248,15 +11554,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11303,7 +11611,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11315,14 +11623,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11550,15 +11858,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11605,7 +11915,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11617,14 +11927,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11857,15 +12167,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11912,7 +12224,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11924,14 +12236,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12175,15 +12487,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12230,7 +12544,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12242,14 +12556,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12506,15 +12820,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12561,7 +12877,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12573,14 +12889,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12835,15 +13151,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12890,7 +13208,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12902,14 +13220,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13314,7 +13632,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -13322,7 +13641,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -13344,7 +13664,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -13408,7 +13729,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -13530,7 +13894,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -13538,7 +13903,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -13560,7 +13926,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -13612,7 +13979,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -13620,7 +13988,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -13642,7 +14011,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -13897,15 +14267,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13952,7 +14324,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13964,14 +14336,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14007,15 +14379,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14062,7 +14436,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14074,14 +14448,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14424,15 +14798,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14479,7 +14855,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14491,14 +14867,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14795,15 +15171,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14850,7 +15228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14862,14 +15240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionInstanceGroups.html b/docs/dyn/compute_beta.regionInstanceGroups.html index 2b91485528..8a0d111f29 100644 --- a/docs/dyn/compute_beta.regionInstanceGroups.html +++ b/docs/dyn/compute_beta.regionInstanceGroups.html @@ -658,15 +658,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -713,7 +715,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -725,14 +727,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionInstanceTemplates.html b/docs/dyn/compute_beta.regionInstanceTemplates.html index 1254e654af..38631820a6 100644 --- a/docs/dyn/compute_beta.regionInstanceTemplates.html +++ b/docs/dyn/compute_beta.regionInstanceTemplates.html @@ -167,15 +167,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -222,7 +224,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -234,14 +236,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -541,7 +543,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -549,7 +552,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -571,7 +575,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -635,7 +640,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -757,7 +805,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -765,7 +814,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -787,7 +837,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -839,7 +890,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -847,7 +899,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -869,7 +922,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1345,10 +1399,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1601,7 +1654,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1609,7 +1663,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1631,7 +1686,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1695,7 +1751,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -1817,7 +1916,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1825,7 +1925,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1847,7 +1948,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1899,7 +2001,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1907,7 +2010,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1929,7 +2033,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2405,10 +2510,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2581,15 +2685,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2636,7 +2742,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2648,14 +2754,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3041,7 +3147,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3049,7 +3156,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3071,7 +3179,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3135,7 +3244,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -3257,7 +3409,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3265,7 +3418,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3287,7 +3441,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3339,7 +3494,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3347,7 +3503,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3369,7 +3526,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3845,10 +4003,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. diff --git a/docs/dyn/compute_beta.regionInstances.html b/docs/dyn/compute_beta.regionInstances.html index cb0889e469..463817f5b5 100644 --- a/docs/dyn/compute_beta.regionInstances.html +++ b/docs/dyn/compute_beta.regionInstances.html @@ -172,7 +172,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -180,7 +181,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -202,7 +204,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -266,7 +269,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -388,7 +434,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -396,7 +443,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -418,7 +466,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -470,7 +519,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -478,7 +528,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -500,7 +551,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -684,7 +736,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -692,7 +745,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -714,7 +768,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -778,7 +833,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable # only for bootable images. Read @@ -900,7 +998,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -908,7 +1007,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -930,7 +1030,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -982,7 +1083,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -990,7 +1092,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1012,7 +1115,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1488,10 +1592,9 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. - "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft - # Off signal is triggered for Spot - # VMs only. If not specified, there will be no wait before the G2 Soft - # Off signal is triggered. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1693,15 +1796,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1748,7 +1853,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1760,14 +1865,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionInstantSnapshotGroups.html b/docs/dyn/compute_beta.regionInstantSnapshotGroups.html index 157e9159ca..35c72fce7b 100644 --- a/docs/dyn/compute_beta.regionInstantSnapshotGroups.html +++ b/docs/dyn/compute_beta.regionInstantSnapshotGroups.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -934,15 +936,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -989,7 +993,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1001,14 +1005,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionInstantSnapshots.html b/docs/dyn/compute_beta.regionInstantSnapshots.html index 3378e7a5af..e58b4981b4 100644 --- a/docs/dyn/compute_beta.regionInstantSnapshots.html +++ b/docs/dyn/compute_beta.regionInstantSnapshots.html @@ -185,15 +185,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -240,7 +242,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -252,14 +254,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1056,15 +1058,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1111,7 +1115,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1123,14 +1127,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2487,15 +2491,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2542,7 +2548,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2554,14 +2560,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionMultiMigs.html b/docs/dyn/compute_beta.regionMultiMigs.html index 25089a4add..82a9653d64 100644 --- a/docs/dyn/compute_beta.regionMultiMigs.html +++ b/docs/dyn/compute_beta.regionMultiMigs.html @@ -166,15 +166,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -221,7 +223,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -233,14 +235,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -448,15 +450,17 @@

Method Details

"error": { # Output only. [Output Only] Encountered errors on the last state check. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -503,7 +507,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -515,14 +519,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -605,15 +609,17 @@

Method Details

"error": { # Output only. [Output Only] Encountered errors on the last state check. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -660,7 +666,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -672,14 +678,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -770,15 +776,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -825,7 +833,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -837,14 +845,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1137,15 +1145,17 @@

Method Details

"error": { # Output only. [Output Only] Encountered errors on the last state check. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1192,7 +1202,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1204,14 +1214,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html index cfb6720048..40da292e67 100644 --- a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html @@ -220,15 +220,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -275,7 +277,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -287,14 +289,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -521,15 +523,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -576,7 +580,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -588,14 +592,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -862,15 +866,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -917,7 +923,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -929,14 +935,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1642,15 +1648,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1697,7 +1705,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1709,14 +1717,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html index d396f5200e..978b24ff09 100644 --- a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html @@ -227,15 +227,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -282,7 +284,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -294,14 +296,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -716,15 +718,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -771,7 +775,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -783,14 +787,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1010,15 +1014,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1065,7 +1071,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1077,14 +1083,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1308,15 +1314,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1363,7 +1371,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1375,14 +1383,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3744,15 +3752,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3799,7 +3809,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3811,14 +3821,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5122,15 +5132,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5177,7 +5189,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5189,14 +5201,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5433,15 +5445,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5488,7 +5502,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5500,14 +5514,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5919,15 +5933,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5974,7 +5990,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5986,14 +6002,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6213,15 +6229,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6268,7 +6286,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6280,14 +6298,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6507,15 +6525,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6562,7 +6582,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6574,14 +6594,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionNetworkPolicies.html b/docs/dyn/compute_beta.regionNetworkPolicies.html index c981633c06..7249229ea2 100644 --- a/docs/dyn/compute_beta.regionNetworkPolicies.html +++ b/docs/dyn/compute_beta.regionNetworkPolicies.html @@ -199,15 +199,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -254,7 +256,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -266,14 +268,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -573,15 +575,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -628,7 +632,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -640,14 +644,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1170,15 +1174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1225,7 +1231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1237,14 +1243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1810,15 +1816,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1865,7 +1873,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1877,14 +1885,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2465,15 +2473,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2520,7 +2530,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2532,14 +2542,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2841,15 +2851,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2896,7 +2908,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2908,14 +2920,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3135,15 +3147,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3190,7 +3204,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3202,14 +3216,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3429,15 +3443,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3484,7 +3500,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3496,14 +3512,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionNotificationEndpoints.html b/docs/dyn/compute_beta.regionNotificationEndpoints.html index 436b5f6612..b19e4ce518 100644 --- a/docs/dyn/compute_beta.regionNotificationEndpoints.html +++ b/docs/dyn/compute_beta.regionNotificationEndpoints.html @@ -426,15 +426,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -481,7 +483,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -493,14 +495,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -857,15 +859,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -912,7 +916,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -924,14 +928,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionOperations.html b/docs/dyn/compute_beta.regionOperations.html index a66d4b4f36..9a8d2747c4 100644 --- a/docs/dyn/compute_beta.regionOperations.html +++ b/docs/dyn/compute_beta.regionOperations.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -537,15 +539,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -592,7 +596,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -604,14 +608,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -883,15 +887,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -938,7 +944,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -950,14 +956,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionSecurityPolicies.html b/docs/dyn/compute_beta.regionSecurityPolicies.html index c5b585dad4..58d8858ee4 100644 --- a/docs/dyn/compute_beta.regionSecurityPolicies.html +++ b/docs/dyn/compute_beta.regionSecurityPolicies.html @@ -637,15 +637,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -692,7 +694,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -704,14 +706,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -935,15 +937,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -990,7 +994,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1002,14 +1006,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3162,15 +3166,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3217,7 +3223,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3229,14 +3235,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5041,15 +5047,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5096,7 +5104,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5108,14 +5116,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5795,15 +5803,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5850,7 +5860,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5862,14 +5872,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6076,15 +6086,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6131,7 +6143,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6143,14 +6155,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6386,15 +6398,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6441,7 +6455,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6453,14 +6467,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionSnapshotSettings.html b/docs/dyn/compute_beta.regionSnapshotSettings.html index 13d0719981..9f836b857d 100644 --- a/docs/dyn/compute_beta.regionSnapshotSettings.html +++ b/docs/dyn/compute_beta.regionSnapshotSettings.html @@ -226,15 +226,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -281,7 +283,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -293,14 +295,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionSnapshots.html b/docs/dyn/compute_beta.regionSnapshots.html index e77568615e..941e457715 100644 --- a/docs/dyn/compute_beta.regionSnapshots.html +++ b/docs/dyn/compute_beta.regionSnapshots.html @@ -188,15 +188,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -243,7 +245,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -255,14 +257,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -567,7 +569,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -575,7 +578,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -597,7 +601,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -627,7 +632,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -635,7 +641,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -657,7 +664,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -693,7 +701,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -701,7 +710,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -723,7 +733,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1273,7 +1284,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1281,7 +1293,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1303,7 +1316,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1333,7 +1347,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1341,7 +1356,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1363,7 +1379,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1399,7 +1416,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1407,7 +1425,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1429,7 +1448,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1520,15 +1540,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1575,7 +1597,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1587,14 +1609,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1985,7 +2007,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1993,7 +2016,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2015,7 +2039,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2045,7 +2070,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2053,7 +2079,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2075,7 +2102,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2111,7 +2139,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2119,7 +2148,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2141,7 +2171,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3181,15 +3212,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3236,7 +3269,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3248,14 +3281,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3523,15 +3556,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3578,7 +3613,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3590,14 +3625,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionSslCertificates.html b/docs/dyn/compute_beta.regionSslCertificates.html index fdaeb29703..8978a3b0fb 100644 --- a/docs/dyn/compute_beta.regionSslCertificates.html +++ b/docs/dyn/compute_beta.regionSslCertificates.html @@ -169,15 +169,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -224,7 +226,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -236,14 +238,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -654,15 +656,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -709,7 +713,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -721,14 +725,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionSslPolicies.html b/docs/dyn/compute_beta.regionSslPolicies.html index c42e49b650..8425d80f67 100644 --- a/docs/dyn/compute_beta.regionSslPolicies.html +++ b/docs/dyn/compute_beta.regionSslPolicies.html @@ -178,15 +178,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -233,7 +235,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -245,14 +247,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -658,15 +660,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -713,7 +717,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -725,14 +729,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1378,15 +1382,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1433,7 +1439,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1445,14 +1451,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionTargetHttpProxies.html b/docs/dyn/compute_beta.regionTargetHttpProxies.html index d99e12fcd1..fc3d6f7ee1 100644 --- a/docs/dyn/compute_beta.regionTargetHttpProxies.html +++ b/docs/dyn/compute_beta.regionTargetHttpProxies.html @@ -172,15 +172,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -227,7 +229,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -239,14 +241,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -647,15 +649,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -702,7 +706,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -714,14 +718,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1180,15 +1184,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1235,7 +1241,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1247,14 +1253,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionTargetHttpsProxies.html b/docs/dyn/compute_beta.regionTargetHttpsProxies.html index 8d971d4c5c..9378c2bce6 100644 --- a/docs/dyn/compute_beta.regionTargetHttpsProxies.html +++ b/docs/dyn/compute_beta.regionTargetHttpsProxies.html @@ -178,15 +178,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -233,7 +235,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -245,14 +247,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -849,15 +851,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -904,7 +908,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -916,14 +920,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1658,15 +1662,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1713,7 +1719,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1725,14 +1731,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1962,15 +1968,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2017,7 +2025,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2029,14 +2037,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2262,15 +2270,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2317,7 +2327,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2329,14 +2339,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionTargetTcpProxies.html b/docs/dyn/compute_beta.regionTargetTcpProxies.html index c5d6ef99a3..adc498590a 100644 --- a/docs/dyn/compute_beta.regionTargetTcpProxies.html +++ b/docs/dyn/compute_beta.regionTargetTcpProxies.html @@ -169,15 +169,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -224,7 +226,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -236,14 +238,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -564,15 +566,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -619,7 +623,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -631,14 +635,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionUrlMaps.html b/docs/dyn/compute_beta.regionUrlMaps.html index 228b963169..ad264cdfdb 100644 --- a/docs/dyn/compute_beta.regionUrlMaps.html +++ b/docs/dyn/compute_beta.regionUrlMaps.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7976,15 +7978,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8031,7 +8035,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8043,14 +8047,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8285,15 +8289,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8340,7 +8346,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8352,14 +8358,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16228,15 +16234,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16283,7 +16291,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16295,14 +16303,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -20300,15 +20308,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -20355,7 +20365,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20367,14 +20377,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.reliabilityRisks.html b/docs/dyn/compute_beta.reliabilityRisks.html index df068a2b9e..2737b6857b 100644 --- a/docs/dyn/compute_beta.reliabilityRisks.html +++ b/docs/dyn/compute_beta.reliabilityRisks.html @@ -238,7 +238,7 @@

Method Details

An object of the form: { # Response message for the List method of ReliabilityRisksService. - "etag": "A String", + "etag": "A String", # [Output Only] An ETag of the resource. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of ReliabilityRisk resources. { # Represents a ReliabilityRisk resource. diff --git a/docs/dyn/compute_beta.reservationBlocks.html b/docs/dyn/compute_beta.reservationBlocks.html index ddaa2a05c5..cb60ecb531 100644 --- a/docs/dyn/compute_beta.reservationBlocks.html +++ b/docs/dyn/compute_beta.reservationBlocks.html @@ -883,15 +883,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -938,7 +940,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -950,14 +952,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.reservationSlots.html b/docs/dyn/compute_beta.reservationSlots.html index 252420e58f..9b0ebe4691 100644 --- a/docs/dyn/compute_beta.reservationSlots.html +++ b/docs/dyn/compute_beta.reservationSlots.html @@ -260,15 +260,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -315,7 +317,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -327,14 +329,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -818,15 +820,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -873,7 +877,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -885,14 +889,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.reservationSubBlocks.html b/docs/dyn/compute_beta.reservationSubBlocks.html index a5e69323bf..06a8e9738e 100644 --- a/docs/dyn/compute_beta.reservationSubBlocks.html +++ b/docs/dyn/compute_beta.reservationSubBlocks.html @@ -666,15 +666,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -721,7 +723,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -733,14 +735,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1194,15 +1196,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1249,7 +1253,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1261,14 +1265,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1504,15 +1508,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1559,7 +1565,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1571,14 +1577,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.reservations.html b/docs/dyn/compute_beta.reservations.html index 1d94327483..aaec1b2f2b 100644 --- a/docs/dyn/compute_beta.reservations.html +++ b/docs/dyn/compute_beta.reservations.html @@ -636,15 +636,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -691,7 +693,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -703,14 +705,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1822,15 +1824,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1877,7 +1881,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1889,14 +1893,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2528,15 +2532,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2583,7 +2589,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2595,14 +2601,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2831,15 +2837,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2886,7 +2894,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2898,14 +2906,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4290,15 +4298,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4345,7 +4355,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4357,14 +4367,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.resourcePolicies.html b/docs/dyn/compute_beta.resourcePolicies.html index 105ebae2d4..d7041ba264 100644 --- a/docs/dyn/compute_beta.resourcePolicies.html +++ b/docs/dyn/compute_beta.resourcePolicies.html @@ -515,15 +515,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -570,7 +572,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -582,14 +584,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1468,15 +1470,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1523,7 +1527,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1535,14 +1539,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2190,15 +2194,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2245,7 +2251,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2257,14 +2263,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.rolloutPlans.html b/docs/dyn/compute_beta.rolloutPlans.html index 90201c965f..cc048cd431 100644 --- a/docs/dyn/compute_beta.rolloutPlans.html +++ b/docs/dyn/compute_beta.rolloutPlans.html @@ -165,15 +165,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -220,7 +222,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -232,14 +234,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -667,15 +669,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -722,7 +726,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -734,14 +738,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.rollouts.html b/docs/dyn/compute_beta.rollouts.html index 7769e7a7ce..0f9833d3d9 100644 --- a/docs/dyn/compute_beta.rollouts.html +++ b/docs/dyn/compute_beta.rollouts.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -466,15 +468,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -521,7 +525,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -533,14 +537,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -763,15 +767,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -818,7 +824,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -830,14 +836,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1399,15 +1405,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1454,7 +1462,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1466,14 +1474,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1694,15 +1702,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1749,7 +1759,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1761,14 +1771,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.routers.html b/docs/dyn/compute_beta.routers.html index 581a33f0fe..12bd2a17be 100644 --- a/docs/dyn/compute_beta.routers.html +++ b/docs/dyn/compute_beta.routers.html @@ -947,15 +947,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1002,7 +1004,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1014,14 +1016,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1241,15 +1243,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1296,7 +1300,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1308,14 +1312,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1535,15 +1539,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1590,7 +1596,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1602,14 +1608,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3383,6 +3389,7 @@

Method Details

}, "uptimeMs": "A String", # Session uptime in milliseconds. Value will be 0 if session is not up. }, + "depreferenced": True or False, # Output only. [Output Only] Indicates whether the BGP peer is in a depreferenced state. "enableIpv4": True or False, # Output only. Enable IPv4 traffic over BGP Peer. # It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Output only. Enable IPv6 traffic over BGP Peer. @@ -4051,15 +4058,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4106,7 +4115,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4118,14 +4127,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6218,15 +6227,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6273,7 +6284,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6285,14 +6296,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6574,15 +6585,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6629,7 +6642,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6641,14 +6654,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6980,15 +6993,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7035,7 +7050,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7047,14 +7062,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8881,15 +8896,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8936,7 +8953,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8948,14 +8965,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9237,15 +9254,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9292,7 +9311,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9304,14 +9323,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9643,15 +9662,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9698,7 +9719,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9710,14 +9731,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.routes.html b/docs/dyn/compute_beta.routes.html index 968f6a67d7..bde4d0d87e 100644 --- a/docs/dyn/compute_beta.routes.html +++ b/docs/dyn/compute_beta.routes.html @@ -168,15 +168,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -223,7 +225,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -235,14 +237,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -809,15 +811,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -864,7 +868,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -876,14 +880,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.securityPolicies.html b/docs/dyn/compute_beta.securityPolicies.html index 67cea62efd..dc12d3fc7a 100644 --- a/docs/dyn/compute_beta.securityPolicies.html +++ b/docs/dyn/compute_beta.securityPolicies.html @@ -648,15 +648,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -703,7 +705,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -715,14 +717,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1856,15 +1858,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1911,7 +1915,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1923,14 +1927,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4080,15 +4084,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4135,7 +4141,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4147,14 +4153,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6091,15 +6097,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6146,7 +6154,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6158,14 +6166,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6844,15 +6852,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6899,7 +6909,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6911,14 +6921,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7124,15 +7134,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7179,7 +7191,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7191,14 +7203,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7423,15 +7435,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7478,7 +7492,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7490,14 +7504,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.serviceAttachments.html b/docs/dyn/compute_beta.serviceAttachments.html index cb01ee4f24..6ae62ce995 100644 --- a/docs/dyn/compute_beta.serviceAttachments.html +++ b/docs/dyn/compute_beta.serviceAttachments.html @@ -526,15 +526,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -581,7 +583,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -593,14 +595,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1503,15 +1505,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1558,7 +1562,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1570,14 +1574,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2247,15 +2251,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2302,7 +2308,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2314,14 +2320,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.snapshotGroups.html b/docs/dyn/compute_beta.snapshotGroups.html index a04dd2fb7f..8f279d3938 100644 --- a/docs/dyn/compute_beta.snapshotGroups.html +++ b/docs/dyn/compute_beta.snapshotGroups.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -919,15 +921,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -974,7 +978,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -986,14 +990,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.snapshotSettings.html b/docs/dyn/compute_beta.snapshotSettings.html index 3c6047f23e..2a99b612bd 100644 --- a/docs/dyn/compute_beta.snapshotSettings.html +++ b/docs/dyn/compute_beta.snapshotSettings.html @@ -224,15 +224,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -279,7 +281,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -291,14 +293,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.snapshots.html b/docs/dyn/compute_beta.snapshots.html index b9aba72141..7124f67c76 100644 --- a/docs/dyn/compute_beta.snapshots.html +++ b/docs/dyn/compute_beta.snapshots.html @@ -368,7 +368,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -376,7 +377,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -398,7 +400,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -428,7 +431,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -436,7 +440,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -458,7 +463,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -494,7 +500,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -502,7 +509,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -524,7 +532,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -715,15 +724,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -770,7 +781,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -782,14 +793,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1093,7 +1104,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1101,7 +1113,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1123,7 +1136,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1153,7 +1167,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1161,7 +1176,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1183,7 +1199,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1219,7 +1236,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1227,7 +1245,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1249,7 +1268,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1800,7 +1820,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1808,7 +1829,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1830,7 +1852,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1860,7 +1883,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1868,7 +1892,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1890,7 +1915,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1926,7 +1952,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1934,7 +1961,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1956,7 +1984,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2047,15 +2076,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2102,7 +2133,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2114,14 +2145,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2511,7 +2542,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2519,7 +2551,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2541,7 +2574,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2571,7 +2605,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2579,7 +2614,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2601,7 +2637,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2637,7 +2674,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2645,7 +2683,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2667,7 +2706,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3694,15 +3734,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3749,7 +3791,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3761,14 +3803,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4034,15 +4076,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4089,7 +4133,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4101,14 +4145,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.sslCertificates.html b/docs/dyn/compute_beta.sslCertificates.html index c58e808994..4603d7bd97 100644 --- a/docs/dyn/compute_beta.sslCertificates.html +++ b/docs/dyn/compute_beta.sslCertificates.html @@ -455,15 +455,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -510,7 +512,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -522,14 +524,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -936,15 +938,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -991,7 +995,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1003,14 +1007,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.sslPolicies.html b/docs/dyn/compute_beta.sslPolicies.html index ebf91906c8..19a665bed4 100644 --- a/docs/dyn/compute_beta.sslPolicies.html +++ b/docs/dyn/compute_beta.sslPolicies.html @@ -462,15 +462,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -517,7 +519,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -529,14 +531,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -939,15 +941,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -994,7 +998,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1006,14 +1010,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1656,15 +1660,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1711,7 +1717,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1723,14 +1729,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.storagePools.html b/docs/dyn/compute_beta.storagePools.html index 443e2dfd5a..031dde3996 100644 --- a/docs/dyn/compute_beta.storagePools.html +++ b/docs/dyn/compute_beta.storagePools.html @@ -238,7 +238,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -317,6 +317,14 @@

Method Details

}, "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id. + "shareSettings": { # Share settings for the storage pool. # Share settings for the storage pool. + "projectMap": { # A map of project id and project config. + "a_key": { # Config for each project in the share settings. + "projectId": "A String", # The project ID, should be same as the key of this project config in the + # parent map. + }, + }, + }, "state": "A String", # Output only. [Output Only] The status of storage pool creation. # # @@ -517,15 +525,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -572,7 +582,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -584,14 +594,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -765,7 +775,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -844,6 +854,14 @@

Method Details

}, "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id. + "shareSettings": { # Share settings for the storage pool. # Share settings for the storage pool. + "projectMap": { # A map of project id and project config. + "a_key": { # Config for each project in the share settings. + "projectId": "A String", # The project ID, should be same as the key of this project config in the + # parent map. + }, + }, + }, "state": "A String", # Output only. [Output Only] The status of storage pool creation. # # @@ -1273,7 +1291,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -1352,6 +1370,14 @@

Method Details

}, "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id. + "shareSettings": { # Share settings for the storage pool. # Share settings for the storage pool. + "projectMap": { # A map of project id and project config. + "a_key": { # Config for each project in the share settings. + "projectId": "A String", # The project ID, should be same as the key of this project config in the + # parent map. + }, + }, + }, "state": "A String", # Output only. [Output Only] The status of storage pool creation. # # @@ -1454,15 +1480,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1509,7 +1537,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1521,14 +1549,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1788,7 +1816,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -1867,6 +1895,14 @@

Method Details

}, "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id. + "shareSettings": { # Share settings for the storage pool. # Share settings for the storage pool. + "projectMap": { # A map of project id and project config. + "a_key": { # Config for each project in the share settings. + "projectId": "A String", # The project ID, should be same as the key of this project config in the + # parent map. + }, + }, + }, "state": "A String", # Output only. [Output Only] The status of storage pool creation. # # @@ -3070,7 +3106,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -3149,6 +3185,14 @@

Method Details

}, "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id. + "shareSettings": { # Share settings for the storage pool. # Share settings for the storage pool. + "projectMap": { # A map of project id and project config. + "a_key": { # Config for each project in the share settings. + "projectId": "A String", # The project ID, should be same as the key of this project config in the + # parent map. + }, + }, + }, "state": "A String", # Output only. [Output Only] The status of storage pool creation. # # @@ -3252,15 +3296,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3307,7 +3353,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3319,14 +3365,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.subnetworks.html b/docs/dyn/compute_beta.subnetworks.html index 6f9c51437e..bfc6dd99b1 100644 --- a/docs/dyn/compute_beta.subnetworks.html +++ b/docs/dyn/compute_beta.subnetworks.html @@ -665,15 +665,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -720,7 +722,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -732,14 +734,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -968,15 +970,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1023,7 +1027,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1035,14 +1039,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2190,15 +2194,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2245,7 +2251,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2257,14 +2263,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3416,15 +3422,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3471,7 +3479,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3483,14 +3491,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4592,15 +4600,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4647,7 +4657,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4659,14 +4669,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.targetGrpcProxies.html b/docs/dyn/compute_beta.targetGrpcProxies.html index bc1f7f48e8..56903ba35f 100644 --- a/docs/dyn/compute_beta.targetGrpcProxies.html +++ b/docs/dyn/compute_beta.targetGrpcProxies.html @@ -171,15 +171,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -226,7 +228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -238,14 +240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -572,15 +574,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -627,7 +631,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -639,14 +643,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1109,15 +1113,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1164,7 +1170,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1176,14 +1182,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.targetHttpProxies.html b/docs/dyn/compute_beta.targetHttpProxies.html index f93201b46d..13137c499a 100644 --- a/docs/dyn/compute_beta.targetHttpProxies.html +++ b/docs/dyn/compute_beta.targetHttpProxies.html @@ -457,15 +457,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -512,7 +514,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -524,14 +526,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -930,15 +932,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -985,7 +989,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -997,14 +1001,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1541,15 +1545,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1596,7 +1602,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1608,14 +1614,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1840,15 +1846,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1895,7 +1903,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1907,14 +1915,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.targetHttpsProxies.html b/docs/dyn/compute_beta.targetHttpsProxies.html index 46aae2d81f..bd045cd5c5 100644 --- a/docs/dyn/compute_beta.targetHttpsProxies.html +++ b/docs/dyn/compute_beta.targetHttpsProxies.html @@ -567,15 +567,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -622,7 +624,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -634,14 +636,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1236,15 +1238,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1291,7 +1295,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1303,14 +1307,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2043,15 +2047,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2098,7 +2104,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2110,14 +2116,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2345,15 +2351,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2400,7 +2408,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2412,14 +2420,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2645,15 +2653,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2700,7 +2710,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2712,14 +2722,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2950,15 +2960,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3005,7 +3017,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3017,14 +3029,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3253,15 +3265,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3308,7 +3322,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3320,14 +3334,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3553,15 +3567,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3608,7 +3624,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3620,14 +3636,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.targetInstances.html b/docs/dyn/compute_beta.targetInstances.html index 174eef4153..722f05de1b 100644 --- a/docs/dyn/compute_beta.targetInstances.html +++ b/docs/dyn/compute_beta.targetInstances.html @@ -415,15 +415,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -470,7 +472,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -482,14 +484,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -814,15 +816,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -869,7 +873,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -881,14 +885,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1311,15 +1315,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1366,7 +1372,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1378,14 +1384,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.targetPools.html b/docs/dyn/compute_beta.targetPools.html index 8d7c1afa21..f58fd10e37 100644 --- a/docs/dyn/compute_beta.targetPools.html +++ b/docs/dyn/compute_beta.targetPools.html @@ -207,15 +207,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -262,7 +264,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -274,14 +276,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -517,15 +519,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -572,7 +576,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -584,14 +588,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1084,15 +1088,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1139,7 +1145,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1151,14 +1157,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1597,15 +1603,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1652,7 +1660,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1664,14 +1672,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2137,15 +2145,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2192,7 +2202,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2204,14 +2214,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2442,15 +2452,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2497,7 +2509,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2509,14 +2521,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2743,15 +2755,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2798,7 +2812,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2810,14 +2824,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3046,15 +3060,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3101,7 +3117,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3113,14 +3129,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.targetSslProxies.html b/docs/dyn/compute_beta.targetSslProxies.html index 8359fd6b50..2cb47bb4b4 100644 --- a/docs/dyn/compute_beta.targetSslProxies.html +++ b/docs/dyn/compute_beta.targetSslProxies.html @@ -183,15 +183,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -238,7 +240,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -250,14 +252,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -580,15 +582,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -635,7 +639,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -647,14 +651,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1073,15 +1077,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1128,7 +1134,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1140,14 +1146,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1375,15 +1381,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1430,7 +1438,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1442,14 +1450,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1675,15 +1683,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1730,7 +1740,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1742,14 +1752,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1979,15 +1989,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2034,7 +2046,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2046,14 +2058,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2282,15 +2294,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2337,7 +2351,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2349,14 +2363,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.targetTcpProxies.html b/docs/dyn/compute_beta.targetTcpProxies.html index e22d651105..bddfbdb3c3 100644 --- a/docs/dyn/compute_beta.targetTcpProxies.html +++ b/docs/dyn/compute_beta.targetTcpProxies.html @@ -417,15 +417,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -472,7 +474,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -484,14 +486,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -810,15 +812,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -865,7 +869,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -877,14 +881,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1301,15 +1305,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1356,7 +1362,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1368,14 +1374,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1601,15 +1607,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1656,7 +1664,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1668,14 +1676,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.targetVpnGateways.html b/docs/dyn/compute_beta.targetVpnGateways.html index fd862b63de..eb6849a77b 100644 --- a/docs/dyn/compute_beta.targetVpnGateways.html +++ b/docs/dyn/compute_beta.targetVpnGateways.html @@ -443,15 +443,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -498,7 +500,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -510,14 +512,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -898,15 +900,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -953,7 +957,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -965,14 +969,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1429,15 +1433,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1484,7 +1490,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1496,14 +1502,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.urlMaps.html b/docs/dyn/compute_beta.urlMaps.html index 7cbb905377..14856348bf 100644 --- a/docs/dyn/compute_beta.urlMaps.html +++ b/docs/dyn/compute_beta.urlMaps.html @@ -4133,15 +4133,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4188,7 +4190,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4200,14 +4202,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11948,15 +11950,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12003,7 +12007,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12015,14 +12019,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12267,15 +12271,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12322,7 +12328,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12334,14 +12340,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -20219,15 +20225,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -20274,7 +20282,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20286,14 +20294,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -24300,15 +24308,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -24355,7 +24365,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -24367,14 +24377,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.vpnGateways.html b/docs/dyn/compute_beta.vpnGateways.html index 353623a793..c906e7bd9c 100644 --- a/docs/dyn/compute_beta.vpnGateways.html +++ b/docs/dyn/compute_beta.vpnGateways.html @@ -466,15 +466,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -521,7 +523,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -533,14 +535,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1010,15 +1012,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1065,7 +1069,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1077,14 +1081,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1561,15 +1565,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1616,7 +1622,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1628,14 +1634,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.vpnTunnels.html b/docs/dyn/compute_beta.vpnTunnels.html index 6cd8ea75d1..cd166b3b61 100644 --- a/docs/dyn/compute_beta.vpnTunnels.html +++ b/docs/dyn/compute_beta.vpnTunnels.html @@ -540,15 +540,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -595,7 +597,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -607,14 +609,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1187,15 +1189,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1242,7 +1246,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1254,14 +1258,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1815,15 +1819,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1870,7 +1876,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1882,14 +1888,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.wireGroups.html b/docs/dyn/compute_beta.wireGroups.html index 9e3b9d3351..27f9b3feeb 100644 --- a/docs/dyn/compute_beta.wireGroups.html +++ b/docs/dyn/compute_beta.wireGroups.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -807,15 +809,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -862,7 +866,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -874,14 +878,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1586,15 +1590,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1641,7 +1647,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1653,14 +1659,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.zoneOperations.html b/docs/dyn/compute_beta.zoneOperations.html index e67262448e..e1c78f95fa 100644 --- a/docs/dyn/compute_beta.zoneOperations.html +++ b/docs/dyn/compute_beta.zoneOperations.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -537,15 +539,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -592,7 +596,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -604,14 +608,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -882,15 +886,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -937,7 +943,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -949,14 +955,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.zoneVmExtensionPolicies.html b/docs/dyn/compute_beta.zoneVmExtensionPolicies.html index 47b5468bfa..68385ef340 100644 --- a/docs/dyn/compute_beta.zoneVmExtensionPolicies.html +++ b/docs/dyn/compute_beta.zoneVmExtensionPolicies.html @@ -169,15 +169,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -224,7 +226,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -236,14 +238,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -599,15 +601,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -654,7 +658,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -666,14 +670,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1173,15 +1177,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1228,7 +1234,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1240,14 +1246,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.addresses.html b/docs/dyn/compute_v1.addresses.html index dee846b0f6..b7c9eb45b8 100644 --- a/docs/dyn/compute_v1.addresses.html +++ b/docs/dyn/compute_v1.addresses.html @@ -246,8 +246,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -329,6 +331,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -501,15 +509,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -556,7 +566,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -568,14 +578,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -766,8 +776,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -849,6 +861,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -903,8 +921,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -986,6 +1006,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -1064,15 +1090,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1119,7 +1147,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1131,14 +1159,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1415,8 +1443,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -1498,6 +1528,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -1650,15 +1686,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1705,7 +1743,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1717,14 +1755,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1959,15 +1997,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2014,7 +2054,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2026,14 +2066,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.autoscalers.html b/docs/dyn/compute_v1.autoscalers.html index 2af607a273..d961ea7933 100644 --- a/docs/dyn/compute_v1.autoscalers.html +++ b/docs/dyn/compute_v1.autoscalers.html @@ -716,15 +716,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -771,7 +773,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -783,14 +785,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1707,15 +1709,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1762,7 +1766,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1774,14 +1778,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2836,15 +2840,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2891,7 +2897,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2903,14 +2909,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3506,15 +3512,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3561,7 +3569,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3573,14 +3581,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.backendBuckets.html b/docs/dyn/compute_v1.backendBuckets.html index 4d76be3a56..d46dd4b8e5 100644 --- a/docs/dyn/compute_v1.backendBuckets.html +++ b/docs/dyn/compute_v1.backendBuckets.html @@ -212,15 +212,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -267,7 +269,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -279,14 +281,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -893,15 +895,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -948,7 +952,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -960,14 +964,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1188,15 +1192,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1243,7 +1249,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1255,14 +1261,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2251,15 +2257,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2306,7 +2314,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2318,14 +2326,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3425,15 +3433,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3480,7 +3490,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3492,14 +3502,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3725,15 +3735,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3780,7 +3792,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3792,14 +3804,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5120,15 +5132,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5175,7 +5189,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5187,14 +5201,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html index 781a52f7a3..9f68095de0 100644 --- a/docs/dyn/compute_v1.backendServices.html +++ b/docs/dyn/compute_v1.backendServices.html @@ -221,15 +221,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -276,7 +278,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -288,14 +290,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1743,7 +1745,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -1981,15 +1987,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2036,7 +2044,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2048,14 +2056,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2276,15 +2284,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2331,7 +2341,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2343,14 +2353,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3698,7 +3708,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -5421,7 +5435,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -5567,15 +5585,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5622,7 +5642,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5634,14 +5654,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7075,7 +7095,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -8481,7 +8505,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -9827,7 +9855,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -9973,15 +10005,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10028,7 +10062,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10040,14 +10074,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10273,15 +10307,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10328,7 +10364,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10340,14 +10376,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11449,15 +11485,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11504,7 +11542,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11516,14 +11554,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12901,7 +12939,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -13047,15 +13089,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13102,7 +13146,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13114,14 +13158,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.crossSiteNetworks.html b/docs/dyn/compute_v1.crossSiteNetworks.html index 988abf84bf..a169681748 100644 --- a/docs/dyn/compute_v1.crossSiteNetworks.html +++ b/docs/dyn/compute_v1.crossSiteNetworks.html @@ -169,15 +169,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -224,7 +226,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -236,14 +238,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -522,15 +524,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -577,7 +581,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -589,14 +593,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1017,15 +1021,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1072,7 +1078,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1084,14 +1090,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html index cc25ea06c8..5fa6f7bfb2 100644 --- a/docs/dyn/compute_v1.disks.html +++ b/docs/dyn/compute_v1.disks.html @@ -224,15 +224,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -279,7 +281,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -291,14 +293,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -684,7 +686,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -692,7 +695,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -714,7 +718,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -915,7 +920,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -923,7 +929,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -945,7 +952,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -996,7 +1004,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1004,7 +1013,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1026,7 +1036,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1267,15 +1278,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1322,7 +1335,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1334,14 +1347,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1580,15 +1593,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1635,7 +1650,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1647,14 +1662,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1962,7 +1977,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1970,7 +1986,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1992,7 +2009,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2022,7 +2040,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2030,7 +2049,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2052,7 +2072,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2088,7 +2109,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2096,7 +2118,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2118,7 +2141,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2211,15 +2235,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2266,7 +2292,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2278,14 +2304,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2508,15 +2534,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2563,7 +2591,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2575,14 +2603,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2870,7 +2898,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2878,7 +2907,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2900,7 +2930,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3101,7 +3132,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3109,7 +3141,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3131,7 +3164,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3182,7 +3216,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3190,7 +3225,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3212,7 +3248,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3762,7 +3799,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3770,7 +3808,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3792,7 +3831,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3993,7 +4033,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4001,7 +4042,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4023,7 +4065,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4074,7 +4117,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4082,7 +4126,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4104,7 +4149,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4210,15 +4256,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4265,7 +4313,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4277,14 +4325,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4658,7 +4706,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4666,7 +4715,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4688,7 +4738,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4889,7 +4940,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4897,7 +4949,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4919,7 +4972,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4970,7 +5024,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4978,7 +5033,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5000,7 +5056,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5172,15 +5229,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5227,7 +5286,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5239,14 +5298,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5473,15 +5532,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5528,7 +5589,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5540,14 +5601,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6657,15 +6718,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6712,7 +6775,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6724,14 +6787,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6979,15 +7042,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7034,7 +7099,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7046,14 +7111,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7273,15 +7338,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7328,7 +7395,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7340,14 +7407,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7587,15 +7654,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7642,7 +7711,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7654,14 +7723,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7980,7 +8049,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7988,7 +8058,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8010,7 +8081,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8211,7 +8283,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8219,7 +8292,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8241,7 +8315,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8292,7 +8367,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8300,7 +8376,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8322,7 +8399,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8429,15 +8507,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8484,7 +8564,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8496,14 +8576,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8741,15 +8821,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8796,7 +8878,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8808,14 +8890,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.externalVpnGateways.html b/docs/dyn/compute_v1.externalVpnGateways.html index d0e81a241a..54a2d1d522 100644 --- a/docs/dyn/compute_v1.externalVpnGateways.html +++ b/docs/dyn/compute_v1.externalVpnGateways.html @@ -171,15 +171,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -226,7 +228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -238,14 +240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -657,15 +659,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -712,7 +716,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -724,14 +728,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1194,15 +1198,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1249,7 +1255,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1261,14 +1267,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.firewallPolicies.html b/docs/dyn/compute_v1.firewallPolicies.html index afe6db5db6..821e83171d 100644 --- a/docs/dyn/compute_v1.firewallPolicies.html +++ b/docs/dyn/compute_v1.firewallPolicies.html @@ -216,15 +216,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -271,7 +273,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -283,14 +285,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -697,15 +699,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -752,7 +756,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -764,14 +768,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -989,15 +993,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1044,7 +1050,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1056,14 +1062,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1285,15 +1291,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1340,7 +1348,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1352,14 +1360,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3084,15 +3092,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3139,7 +3149,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3151,14 +3161,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4009,15 +4019,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4064,7 +4076,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4076,14 +4088,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4749,15 +4761,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4804,7 +4818,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4816,14 +4830,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5231,15 +5245,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5286,7 +5302,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5298,14 +5314,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5523,15 +5539,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5578,7 +5596,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5590,14 +5608,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5815,15 +5833,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5870,7 +5890,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5882,14 +5902,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.firewalls.html b/docs/dyn/compute_v1.firewalls.html index 9176943600..7899bbb987 100644 --- a/docs/dyn/compute_v1.firewalls.html +++ b/docs/dyn/compute_v1.firewalls.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -815,15 +817,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -870,7 +874,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -882,14 +886,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1594,15 +1598,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1649,7 +1655,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1661,14 +1667,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2090,15 +2096,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2145,7 +2153,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2157,14 +2165,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.forwardingRules.html b/docs/dyn/compute_v1.forwardingRules.html index 09b7ad3bad..d865eba638 100644 --- a/docs/dyn/compute_v1.forwardingRules.html +++ b/docs/dyn/compute_v1.forwardingRules.html @@ -769,15 +769,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -824,7 +826,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -836,14 +838,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1874,15 +1876,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1929,7 +1933,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1941,14 +1945,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3113,15 +3117,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3168,7 +3174,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3180,14 +3186,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3423,15 +3429,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3478,7 +3486,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3490,14 +3498,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3724,15 +3732,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3779,7 +3789,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3791,14 +3801,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.futureReservations.html b/docs/dyn/compute_v1.futureReservations.html index 9530cacc6f..4f8f8c68c3 100644 --- a/docs/dyn/compute_v1.futureReservations.html +++ b/docs/dyn/compute_v1.futureReservations.html @@ -664,15 +664,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -719,7 +721,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -731,14 +733,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -962,15 +964,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1017,7 +1021,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1029,14 +1033,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1864,15 +1868,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1919,7 +1925,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1931,14 +1937,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2908,15 +2914,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2963,7 +2971,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2975,14 +2983,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.globalAddresses.html b/docs/dyn/compute_v1.globalAddresses.html index 7d85d4aa7a..d55fb9a9bc 100644 --- a/docs/dyn/compute_v1.globalAddresses.html +++ b/docs/dyn/compute_v1.globalAddresses.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -438,8 +440,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -521,6 +525,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -574,8 +584,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -657,6 +669,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -735,15 +753,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -790,7 +810,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -802,14 +822,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1084,8 +1104,10 @@

Method Details

# It supports the following cases: # # - - # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 - # addresses. The PDP must support enhanced IPv4 allocations. + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external + # addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 + # allocations. If an IPv6 PDP is used, the PDP must be in + # EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. # - # Case 2: Internal Range for global internal addresses. # @@ -1167,6 +1189,12 @@

Method Details

# - `PRIVATE_SERVICE_CONNECT` for a private network address that is # used to configure Private Service Connect. Only global internal addresses # can use this purpose. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses + # that can only be assigned to global external Passthrough Network Load + # Balancer forwarding rules, as an Availability Group 0 address. + # - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that + # can only be assigned to global external Passthrough Network Load Balancer + # forwarding rules, as an Availability Group 1 address. "region": "A String", # Output only. [Output Only] The URL of the region where a regional address resides. # For regional addresses, you must specify the region as a path parameter in # the HTTP request URL. *This field is not applicable to global @@ -1318,15 +1346,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1373,7 +1403,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1385,14 +1415,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1616,15 +1646,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1671,7 +1703,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1683,14 +1715,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.globalForwardingRules.html b/docs/dyn/compute_v1.globalForwardingRules.html index 911dcdc35c..465b6d72c5 100644 --- a/docs/dyn/compute_v1.globalForwardingRules.html +++ b/docs/dyn/compute_v1.globalForwardingRules.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1278,15 +1280,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1333,7 +1337,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1345,14 +1349,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2515,15 +2519,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2570,7 +2576,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2582,14 +2588,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2814,15 +2820,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2869,7 +2877,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2881,14 +2889,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3114,15 +3122,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3169,7 +3179,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3181,14 +3191,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html index eaa4d0556f..26e90400f0 100644 --- a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html @@ -217,15 +217,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -272,7 +274,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -284,14 +286,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -516,15 +518,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -571,7 +575,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -583,14 +587,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -853,15 +857,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -908,7 +914,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -920,14 +926,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1498,15 +1504,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1553,7 +1561,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1565,14 +1573,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.globalOperations.html b/docs/dyn/compute_v1.globalOperations.html index 7f7faf7659..78ddc065e8 100644 --- a/docs/dyn/compute_v1.globalOperations.html +++ b/docs/dyn/compute_v1.globalOperations.html @@ -253,15 +253,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -308,7 +310,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -320,14 +322,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -634,15 +636,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -689,7 +693,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -701,14 +705,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1000,15 +1004,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1055,7 +1061,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1067,14 +1073,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1345,15 +1351,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1400,7 +1408,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1412,14 +1420,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.globalOrganizationOperations.html b/docs/dyn/compute_v1.globalOrganizationOperations.html index 13713e8eff..7b6a55a5f1 100644 --- a/docs/dyn/compute_v1.globalOrganizationOperations.html +++ b/docs/dyn/compute_v1.globalOrganizationOperations.html @@ -166,15 +166,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -221,7 +223,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -233,14 +235,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -532,15 +534,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -587,7 +591,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -599,14 +603,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.globalPublicDelegatedPrefixes.html b/docs/dyn/compute_v1.globalPublicDelegatedPrefixes.html index 1d909676d6..26aaf7ebd2 100644 --- a/docs/dyn/compute_v1.globalPublicDelegatedPrefixes.html +++ b/docs/dyn/compute_v1.globalPublicDelegatedPrefixes.html @@ -168,15 +168,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -223,7 +225,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -235,14 +237,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -643,15 +645,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -698,7 +702,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -710,14 +714,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1255,15 +1259,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1310,7 +1316,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1322,14 +1328,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.globalVmExtensionPolicies.html b/docs/dyn/compute_v1.globalVmExtensionPolicies.html index a3c94dbfc3..d7a9e18bb0 100644 --- a/docs/dyn/compute_v1.globalVmExtensionPolicies.html +++ b/docs/dyn/compute_v1.globalVmExtensionPolicies.html @@ -475,15 +475,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -530,7 +532,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -542,14 +544,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1033,15 +1035,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1088,7 +1092,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1100,14 +1104,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1729,15 +1733,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1784,7 +1790,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1796,14 +1802,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.healthChecks.html b/docs/dyn/compute_v1.healthChecks.html index 46df29cf38..aebdf5a8d2 100644 --- a/docs/dyn/compute_v1.healthChecks.html +++ b/docs/dyn/compute_v1.healthChecks.html @@ -478,7 +478,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -565,8 +565,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. }, @@ -723,15 +724,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -778,7 +781,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -790,14 +793,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1218,7 +1221,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -1305,8 +1308,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. }
@@ -1577,7 +1581,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -1664,8 +1668,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. } @@ -1730,15 +1735,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1785,7 +1792,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1797,14 +1804,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2311,7 +2318,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -2398,8 +2405,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. }, @@ -2721,7 +2729,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -2808,8 +2816,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. } @@ -2874,15 +2883,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2929,7 +2940,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2941,14 +2952,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3398,7 +3409,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -3485,8 +3496,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. } @@ -3551,15 +3563,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3606,7 +3620,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3618,14 +3632,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.hosts.html b/docs/dyn/compute_v1.hosts.html new file mode 100644 index 0000000000..448af07862 --- /dev/null +++ b/docs/dyn/compute_v1.hosts.html @@ -0,0 +1,641 @@ + + + +

Compute Engine API . hosts

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, zone, association, host, x__xgafv=None)

+

Retrieves information about the specified host.

+

+ getVersion(project, zone, association, host, body=None, requestId=None, x__xgafv=None)

+

Allows customers to get SBOM versions of a host.

+

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

+

Retrieves a list of hosts.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(project, zone, association, host, x__xgafv=None) +
Retrieves information about the specified host.
+
+Args:
+  project: string, The project ID for this request. (required)
+  zone: string, The name of the zone for this request, formatted as RFC1035. (required)
+  association: string, The parent resource association for the Host. This field specifies the
+hierarchical context (e.g., reservation, block, sub-block) when
+accessing the host. For example, reservations/reservation_name,
+reservations/reservation_name/reservationBlocks/reservation_block_name or
+reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name. (required)
+  host: string, The name of the host, formatted as RFC1035 or a resource ID
+number. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a host resource.
+  "aliasLinks": [ # Output only. All aliases for this resource.
+      # e.g.
+      # projects/123/zones/us-centra1-a/reservation/r1/reservationBlock/b1/hosts/h1
+    "A String",
+  ],
+  "creationTimestamp": "A String", # Output only. The creation timestamp, formatted asRFC3339 text.
+  "description": "A String", # An optional description of this resource.
+  "id": "A String", # Output only. The unique identifier for this resource. This identifier is
+      # defined by the server.
+  "kind": "compute#host", # Output only. The type of resource. Alwayscompute#host for hosts.
+  "name": "A String", # Output only. The name of the host.
+  "selfLink": "A String", # Output only. The self link of the host.
+  "selfLinkWithId": "A String", # Output only. The self link with id of the host.
+  "state": "A String", # Output only. The state of the host.
+  "status": { # Output only. The status of the host
+    "physicalTopology": { # Output only. The physical topology of the reservation sub-block, if
+        # present
+      "block": "A String", # The unique identifier of the capacity block within the cluster.
+      "cluster": "A String", # The cluster name of the reservation sub-block.
+      "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+      "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+          # block.
+    },
+    "runningInstances": [ # Output only. The URIs of the instances currently running on this host.
+      "A String",
+    ],
+  },
+  "zone": "A String", # Output only. The zone in which the host resides.
+}
+
+ +
+ getVersion(project, zone, association, host, body=None, requestId=None, x__xgafv=None) +
Allows customers to get SBOM versions of a host.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
+  association: string, The parent resource association for the Host. This field specifies the
+hierarchical context (e.g., reservation, block, sub-block) when
+accessing the host. (required)
+  host: string, The name of the host, formatted as RFC1035 or a resource ID
+number. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "sbomSelections": [ # The SBOM selection to return. Duplicate values in the list will be ignored.
+    "A String",
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      { # Represents a single error encountered during the processing of an
+          # operation.
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          { # Container for structured error details providing additional context
+              # specific to the encountered error code.
+            "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users.
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ list(project, zone, association, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Retrieves a list of hosts.
+
+Args:
+  project: string, The project ID for this request. (required)
+  zone: string, The name of the zone for this request, formatted as RFC1035. (required)
+  association: string, The parent resource association for the Host. This field specifies the
+hierarchical context (e.g., reservation, block, sub-block) when
+accessing the host. For example, reservations/reservation_name,
+reservations/reservation_name/reservationBlocks/reservation_block_name or
+reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String",
+  "id": "A String", # The unique identifier for the resource; defined by the server.
+  "items": [ # A list of host resources.
+    { # Represents a host resource.
+      "aliasLinks": [ # Output only. All aliases for this resource.
+          # e.g.
+          # projects/123/zones/us-centra1-a/reservation/r1/reservationBlock/b1/hosts/h1
+        "A String",
+      ],
+      "creationTimestamp": "A String", # Output only. The creation timestamp, formatted asRFC3339 text.
+      "description": "A String", # An optional description of this resource.
+      "id": "A String", # Output only. The unique identifier for this resource. This identifier is
+          # defined by the server.
+      "kind": "compute#host", # Output only. The type of resource. Alwayscompute#host for hosts.
+      "name": "A String", # Output only. The name of the host.
+      "selfLink": "A String", # Output only. The self link of the host.
+      "selfLinkWithId": "A String", # Output only. The self link with id of the host.
+      "state": "A String", # Output only. The state of the host.
+      "status": { # Output only. The status of the host
+        "physicalTopology": { # Output only. The physical topology of the reservation sub-block, if
+            # present
+          "block": "A String", # The unique identifier of the capacity block within the cluster.
+          "cluster": "A String", # The cluster name of the reservation sub-block.
+          "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+          "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+              # block.
+        },
+        "runningInstances": [ # Output only. The URIs of the instances currently running on this host.
+          "A String",
+        ],
+      },
+      "zone": "A String", # Output only. The zone in which the host resides.
+    },
+  ],
+  "kind": "compute#hostList", # The type of resource. Always compute#host for a list of hosts.
+  "nextPageToken": "A String", # This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # The server-defined URL for this resource.
+  "unreachables": [ # Unreachable resources.
+      # end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # An informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.html b/docs/dyn/compute_v1.html index eec2feae8b..4db8bac474 100644 --- a/docs/dyn/compute_v1.html +++ b/docs/dyn/compute_v1.html @@ -184,6 +184,11 @@

Instance Methods

Returns the healthChecks Resource.

+

+ hosts() +

+

Returns the hosts Resource.

+

httpHealthChecks()

@@ -534,6 +539,11 @@

Instance Methods

Returns the regions Resource.

+

+ reliabilityRisks() +

+

Returns the reliabilityRisks Resource.

+

reservationBlocks()

diff --git a/docs/dyn/compute_v1.httpHealthChecks.html b/docs/dyn/compute_v1.httpHealthChecks.html index 03330ad3e5..c9904a0e0e 100644 --- a/docs/dyn/compute_v1.httpHealthChecks.html +++ b/docs/dyn/compute_v1.httpHealthChecks.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -563,15 +565,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -618,7 +622,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -630,14 +634,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1089,15 +1093,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1144,7 +1150,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1156,14 +1162,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1457,15 +1463,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1512,7 +1520,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1524,14 +1532,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.httpsHealthChecks.html b/docs/dyn/compute_v1.httpsHealthChecks.html index b3cac5c75e..5081b40857 100644 --- a/docs/dyn/compute_v1.httpsHealthChecks.html +++ b/docs/dyn/compute_v1.httpsHealthChecks.html @@ -174,15 +174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -229,7 +231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -241,14 +243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -571,15 +573,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -626,7 +630,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -638,14 +642,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1105,15 +1109,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1160,7 +1166,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1172,14 +1178,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1477,15 +1483,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1532,7 +1540,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1544,14 +1552,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.imageFamilyViews.html b/docs/dyn/compute_v1.imageFamilyViews.html index 70f78666cb..5ecc8a0766 100644 --- a/docs/dyn/compute_v1.imageFamilyViews.html +++ b/docs/dyn/compute_v1.imageFamilyViews.html @@ -207,7 +207,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -215,7 +216,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -237,7 +239,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -370,7 +373,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -378,7 +382,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -400,7 +405,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -443,7 +449,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -451,7 +458,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -473,7 +481,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -516,7 +525,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -524,7 +534,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -546,7 +557,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, diff --git a/docs/dyn/compute_v1.images.html b/docs/dyn/compute_v1.images.html index 9f2d52b77b..ea57f8636e 100644 --- a/docs/dyn/compute_v1.images.html +++ b/docs/dyn/compute_v1.images.html @@ -186,15 +186,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -241,7 +243,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -253,14 +255,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -505,15 +507,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -560,7 +564,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -572,14 +576,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -847,7 +851,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -855,7 +860,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -877,7 +883,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1010,7 +1017,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1018,7 +1026,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1040,7 +1049,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1083,7 +1093,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1091,7 +1102,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1113,7 +1125,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1156,7 +1169,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1164,7 +1178,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1186,7 +1201,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1327,7 +1343,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1335,7 +1352,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1357,7 +1375,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1490,7 +1509,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1498,7 +1518,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1520,7 +1541,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1563,7 +1585,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1571,7 +1594,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1593,7 +1617,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1636,7 +1661,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1644,7 +1670,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1666,7 +1693,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2167,7 +2195,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2175,7 +2204,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2197,7 +2227,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2330,7 +2361,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2338,7 +2370,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2360,7 +2393,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2403,7 +2437,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2411,7 +2446,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2433,7 +2469,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2476,7 +2513,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2484,7 +2522,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2506,7 +2545,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2587,15 +2627,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2642,7 +2684,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2654,14 +2696,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3020,7 +3062,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3028,7 +3071,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3050,7 +3094,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3183,7 +3228,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3191,7 +3237,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3213,7 +3260,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3256,7 +3304,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3264,7 +3313,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3286,7 +3336,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3329,7 +3380,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3337,7 +3389,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3359,7 +3412,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3542,7 +3596,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3550,7 +3605,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3572,7 +3628,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3705,7 +3762,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3713,7 +3771,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3735,7 +3794,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3778,7 +3838,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3786,7 +3847,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3808,7 +3870,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3851,7 +3914,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3859,7 +3923,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3881,7 +3946,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3961,15 +4027,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4016,7 +4084,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4028,14 +4096,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5133,15 +5201,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5188,7 +5258,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5200,14 +5270,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html b/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html index 24827c9a7b..a1754747e4 100644 --- a/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html @@ -171,15 +171,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -226,7 +228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -238,14 +240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -475,15 +477,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -530,7 +534,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -542,14 +546,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -833,15 +837,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -888,7 +894,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -900,14 +906,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -938,15 +944,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -993,7 +1001,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1005,14 +1013,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1169,15 +1177,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1224,7 +1234,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1236,14 +1246,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1274,15 +1284,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1329,7 +1341,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1341,14 +1353,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1435,15 +1447,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1490,7 +1504,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1502,14 +1516,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1877,15 +1891,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1932,7 +1948,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1944,14 +1960,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1982,15 +1998,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2037,7 +2055,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2049,14 +2067,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.instanceGroupManagers.html b/docs/dyn/compute_v1.instanceGroupManagers.html index d29db7d201..85cdd14884 100644 --- a/docs/dyn/compute_v1.instanceGroupManagers.html +++ b/docs/dyn/compute_v1.instanceGroupManagers.html @@ -258,15 +258,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -313,7 +315,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -325,14 +327,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -884,15 +886,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -939,7 +943,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -951,14 +955,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -994,15 +998,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1049,7 +1055,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1061,14 +1067,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1434,7 +1440,7 @@

Method Details

The object takes the form of: { # InstanceGroupManagers.applyUpdatesToInstances - "allInstances": True or False, # Flag to update all instances instead of specified list of “instances”. + "allInstances": True or False, # Flag to update all instances instead of specified list of "instances". # If the flag is set to true then the instances may not be specified # in the request. "instances": [ # The list of URLs of one or more instances for which you want to apply @@ -1522,15 +1528,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1577,7 +1585,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1589,14 +1597,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1899,15 +1907,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1954,7 +1964,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1966,14 +1976,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2198,15 +2208,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2253,7 +2265,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2265,14 +2277,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2527,15 +2539,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2582,7 +2596,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2594,14 +2608,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2822,15 +2836,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2877,7 +2893,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2889,14 +2905,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3350,15 +3366,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3405,7 +3423,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3417,14 +3435,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3460,15 +3478,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3515,7 +3535,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3527,14 +3547,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4113,15 +4133,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4168,7 +4190,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4180,14 +4202,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4223,15 +4245,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4278,7 +4302,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4290,14 +4314,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4628,15 +4652,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4683,7 +4709,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4695,14 +4721,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5242,15 +5268,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5297,7 +5325,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5309,14 +5337,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5352,15 +5380,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5407,7 +5437,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5419,14 +5449,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5840,7 +5870,7 @@

Method Details

An object of the form: { - "items": [ # Output only. [Output Only] The list of errors of the managed instance group. + "items": [ # Output only. The list of errors of the managed instance group. { "error": { # Output only. Contents of the error. "code": "A String", # Output only. Error code. @@ -5865,8 +5895,9 @@

Method Details

"timestamp": "A String", # Output only. The time that this error occurred. This value is in RFC3339 text format. }, ], - "nextPageToken": "A String", # Output only. [Output Only] This token allows you to get the next page of results for - # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for + "nextPageToken": "A String", # Output only. This token allows you to get the next page of results for list requests. + # If the number of results is larger than maxResults + # , then use the nextPageToken as a value for # the query parameter pageToken in the next list request. # Subsequent list requests will have their own nextPageToken to # continue paging through the results. @@ -6043,15 +6074,17 @@

Method Details

# delete the instance. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6098,7 +6131,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6110,14 +6143,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6845,15 +6878,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6900,7 +6935,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6912,14 +6947,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6955,15 +6990,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7010,7 +7047,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7022,14 +7059,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7360,15 +7397,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7415,7 +7454,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7427,14 +7466,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7733,15 +7772,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7788,7 +7829,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7800,14 +7841,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8051,15 +8092,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8106,7 +8149,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8118,14 +8161,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8370,15 +8413,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8425,7 +8470,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8437,14 +8482,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8689,15 +8734,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8744,7 +8791,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8756,14 +8803,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8995,15 +9042,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9050,7 +9099,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9062,14 +9111,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9312,15 +9361,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9367,7 +9418,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9379,14 +9430,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9631,15 +9682,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9686,7 +9739,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9698,14 +9751,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9963,15 +10016,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10018,7 +10073,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10030,14 +10085,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10293,15 +10348,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10348,7 +10405,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10360,14 +10417,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10666,15 +10723,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10721,7 +10780,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10733,14 +10792,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.instanceGroups.html b/docs/dyn/compute_v1.instanceGroups.html index 2d11cc8c64..fccaa9f12e 100644 --- a/docs/dyn/compute_v1.instanceGroups.html +++ b/docs/dyn/compute_v1.instanceGroups.html @@ -201,15 +201,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -256,7 +258,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -268,14 +270,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -759,15 +761,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -814,7 +818,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -826,14 +830,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1199,15 +1203,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1254,7 +1260,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1266,14 +1272,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1906,15 +1912,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1961,7 +1969,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1973,14 +1981,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2219,15 +2227,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2274,7 +2284,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2286,14 +2296,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.instanceSettings.html b/docs/dyn/compute_v1.instanceSettings.html index 04afa21ee1..7654ab4c7e 100644 --- a/docs/dyn/compute_v1.instanceSettings.html +++ b/docs/dyn/compute_v1.instanceSettings.html @@ -232,15 +232,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -287,7 +289,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -299,14 +301,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html index 60b1a72ad8..7eb3cf9961 100644 --- a/docs/dyn/compute_v1.instanceTemplates.html +++ b/docs/dyn/compute_v1.instanceTemplates.html @@ -352,7 +352,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -360,7 +361,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -382,7 +384,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -446,7 +449,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -537,7 +583,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -545,7 +592,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -567,7 +615,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -606,7 +655,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -614,7 +664,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -636,7 +687,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1003,6 +1055,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -1068,6 +1137,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -1314,15 +1397,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1369,7 +1454,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1381,14 +1466,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1682,7 +1767,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1690,7 +1776,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1712,7 +1799,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1776,7 +1864,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -1867,7 +1998,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1875,7 +2007,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1897,7 +2030,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1936,7 +2070,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1944,7 +2079,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1966,7 +2102,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2333,6 +2470,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -2398,6 +2552,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -3003,7 +3171,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3011,7 +3180,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3033,7 +3203,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3097,7 +3268,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -3188,7 +3402,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3196,7 +3411,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3218,7 +3434,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3257,7 +3474,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3265,7 +3483,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3287,7 +3506,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3654,6 +3874,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -3719,6 +3956,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -3874,15 +4125,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3929,7 +4182,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3941,14 +4194,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4328,7 +4581,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4336,7 +4590,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4358,7 +4613,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4422,7 +4678,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -4513,7 +4812,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4521,7 +4821,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4543,7 +4844,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4582,7 +4884,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4590,7 +4893,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4612,7 +4916,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4979,6 +5284,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -5044,6 +5366,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html index 38b2a39651..e77d854a60 100644 --- a/docs/dyn/compute_v1.instances.html +++ b/docs/dyn/compute_v1.instances.html @@ -99,7 +99,7 @@

Instance Methods

close()

Close httplib2 connections.

- delete(project, zone, instance, requestId=None, x__xgafv=None)

+ delete(project, zone, instance, noGracefulShutdown=None, requestId=None, x__xgafv=None)

Deletes the specified Instance resource. For more information, seeDeleting

deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None, x__xgafv=None)

@@ -216,7 +216,7 @@

Instance Methods

startWithEncryptionKey(project, zone, instance, body=None, requestId=None, x__xgafv=None)

Starts an instance that was stopped using theinstances().stop

- stop(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)

+ stop(project, zone, instance, discardLocalSsd=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)

Stops a running instance, shutting it down cleanly, and allows

suspend(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)

@@ -357,15 +357,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -412,7 +414,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -424,14 +426,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -846,15 +848,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -901,7 +905,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -913,14 +917,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1150,15 +1154,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1205,7 +1211,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1217,14 +1223,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1592,7 +1598,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1600,7 +1607,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1622,7 +1630,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1686,7 +1695,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -1777,7 +1829,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1785,7 +1838,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1807,7 +1861,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1846,7 +1901,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1854,7 +1910,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1876,7 +1933,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1998,7 +2056,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2006,7 +2065,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2028,7 +2088,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2406,11 +2467,37 @@

Method Details

"reservationConsumptionInfo": { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from. "consumedReservation": "A String", # Output only. [Output Only] The full resource name of the reservation that this # instance is consuming from. + "consumedReservationBlock": "A String", # Output only. [Output Only] The full resource name of the reservation block that this + # instance is consuming from. + "consumedReservationSubBlock": "A String", # Output only. [Output Only] The full resource name of the reservation sub-block that + # this instance is consuming from. }, "scheduling": { "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. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. + "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. + }, + "shutdownDetails": { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state. + # programmed stop scheduled. + "maxDuration": { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when + # `stop_state=PENDING_STOP`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "requestTimestamp": "A String", # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format. + "stopState": "A String", # Current stopping state of the instance. + "targetState": "A String", # Target instance state. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. @@ -2441,6 +2528,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -2506,6 +2610,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -2561,7 +2679,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2569,7 +2688,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2591,7 +2711,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2781,7 +2902,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2789,7 +2911,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2811,7 +2934,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2875,7 +2999,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -2966,7 +3133,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2974,7 +3142,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2996,7 +3165,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3035,7 +3205,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3043,7 +3214,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3065,7 +3237,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3195,15 +3368,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3250,7 +3425,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3262,14 +3437,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3512,7 +3687,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3520,7 +3696,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3542,7 +3719,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3606,7 +3784,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -3697,7 +3918,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3705,7 +3927,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3727,7 +3950,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3766,7 +3990,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3774,7 +3999,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3796,7 +4022,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3974,7 +4201,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3982,7 +4210,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4004,7 +4233,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4068,7 +4298,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -4159,7 +4432,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4167,7 +4441,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4189,7 +4464,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4228,7 +4504,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4236,7 +4513,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4258,7 +4536,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4625,6 +4904,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -4690,6 +4986,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -4874,15 +5184,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4929,7 +5241,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4941,14 +5253,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5105,7 +5417,7 @@

Method Details

- delete(project, zone, instance, requestId=None, x__xgafv=None) + delete(project, zone, instance, noGracefulShutdown=None, requestId=None, x__xgafv=None)
Deletes the specified Instance resource. For more information, seeDeleting
 an instance.
 
@@ -5113,6 +5425,7 @@ 

Method Details

project: string, Project ID for this request. (required) zone: string, The name of the zone for this request. (required) instance: string, Name of the instance resource to delete. (required) + noGracefulShutdown: boolean, If set to true, Graceful Shutdown is skipped. requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. @@ -5173,15 +5486,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5228,7 +5543,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5240,14 +5555,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5468,15 +5783,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5523,7 +5840,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5535,14 +5852,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5767,15 +6084,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5822,7 +6141,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5834,14 +6153,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6062,15 +6381,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6117,7 +6438,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6129,14 +6450,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6402,7 +6723,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6410,7 +6732,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -6432,7 +6755,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -6496,7 +6820,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -6587,7 +6954,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6595,7 +6963,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -6617,7 +6986,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -6656,7 +7026,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6664,7 +7035,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -6686,7 +7058,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -6808,7 +7181,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6816,7 +7190,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -6838,7 +7213,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7216,11 +7592,37 @@

Method Details

"reservationConsumptionInfo": { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from. "consumedReservation": "A String", # Output only. [Output Only] The full resource name of the reservation that this # instance is consuming from. + "consumedReservationBlock": "A String", # Output only. [Output Only] The full resource name of the reservation block that this + # instance is consuming from. + "consumedReservationSubBlock": "A String", # Output only. [Output Only] The full resource name of the reservation sub-block that + # this instance is consuming from. }, "scheduling": { "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. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. + "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. + }, + "shutdownDetails": { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state. + # programmed stop scheduled. + "maxDuration": { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when + # `stop_state=PENDING_STOP`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "requestTimestamp": "A String", # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format. + "stopState": "A String", # Current stopping state of the instance. + "targetState": "A String", # Target instance state. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. @@ -7251,6 +7653,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -7316,6 +7735,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -7371,7 +7804,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7379,7 +7813,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7401,7 +7836,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8650,7 +9086,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8658,7 +9095,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8680,7 +9118,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8744,7 +9183,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -8835,7 +9317,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8843,7 +9326,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8865,7 +9349,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -8904,7 +9389,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -8912,7 +9398,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -8934,7 +9421,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9056,7 +9544,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9064,7 +9553,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9086,7 +9576,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9464,11 +9955,37 @@

Method Details

"reservationConsumptionInfo": { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from. "consumedReservation": "A String", # Output only. [Output Only] The full resource name of the reservation that this # instance is consuming from. + "consumedReservationBlock": "A String", # Output only. [Output Only] The full resource name of the reservation block that this + # instance is consuming from. + "consumedReservationSubBlock": "A String", # Output only. [Output Only] The full resource name of the reservation sub-block that + # this instance is consuming from. }, "scheduling": { "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. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. + "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. + }, + "shutdownDetails": { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state. + # programmed stop scheduled. + "maxDuration": { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when + # `stop_state=PENDING_STOP`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "requestTimestamp": "A String", # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format. + "stopState": "A String", # Current stopping state of the instance. + "targetState": "A String", # Target instance state. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. @@ -9499,6 +10016,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -9564,6 +10098,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -9619,7 +10167,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -9627,7 +10176,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -9649,7 +10199,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -9765,15 +10316,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9820,7 +10373,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9832,14 +10385,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10191,7 +10744,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10199,7 +10753,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10221,7 +10776,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10285,7 +10841,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -10376,7 +10975,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10384,7 +10984,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10406,7 +11007,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10445,7 +11047,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10453,7 +11056,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10475,7 +11079,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -10597,7 +11202,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -10605,7 +11211,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -10627,7 +11234,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11005,11 +11613,37 @@

Method Details

"reservationConsumptionInfo": { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from. "consumedReservation": "A String", # Output only. [Output Only] The full resource name of the reservation that this # instance is consuming from. + "consumedReservationBlock": "A String", # Output only. [Output Only] The full resource name of the reservation block that this + # instance is consuming from. + "consumedReservationSubBlock": "A String", # Output only. [Output Only] The full resource name of the reservation sub-block that + # this instance is consuming from. }, "scheduling": { "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. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. + "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. + }, + "shutdownDetails": { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state. + # programmed stop scheduled. + "maxDuration": { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when + # `stop_state=PENDING_STOP`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "requestTimestamp": "A String", # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format. + "stopState": "A String", # Current stopping state of the instance. + "targetState": "A String", # Target instance state. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. @@ -11040,6 +11674,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -11105,6 +11756,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -11160,7 +11825,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -11168,7 +11834,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -11190,7 +11857,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -11514,15 +12182,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11569,7 +12239,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11581,14 +12251,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11816,15 +12486,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11871,7 +12543,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11883,14 +12555,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12122,15 +12794,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12177,7 +12851,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12189,14 +12863,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12417,15 +13091,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12472,7 +13148,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12484,14 +13160,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -12711,15 +13387,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -12766,7 +13444,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -12778,14 +13456,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13020,15 +13698,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13075,7 +13755,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13087,14 +13767,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -13316,15 +13996,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -13371,7 +14053,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -13383,14 +14065,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14497,15 +15179,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14552,7 +15236,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14564,14 +15248,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -14809,15 +15493,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -14864,7 +15550,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -14876,14 +15562,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15111,15 +15797,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15166,7 +15854,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15178,14 +15866,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15436,15 +16124,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15491,7 +16181,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15503,14 +16193,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15739,15 +16429,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15794,7 +16486,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15806,14 +16498,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16041,15 +16733,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16096,7 +16790,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16108,14 +16802,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16292,6 +16986,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -16357,6 +17068,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -16425,15 +17150,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16480,7 +17207,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16492,14 +17219,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -16735,15 +17462,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -16790,7 +17519,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -16802,14 +17531,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17040,15 +17769,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17095,7 +17826,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17107,14 +17838,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17345,15 +18076,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17400,7 +18133,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17412,14 +18145,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17657,15 +18390,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -17712,7 +18447,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -17724,14 +18459,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -17953,15 +18688,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -18008,7 +18745,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -18020,14 +18757,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -18248,15 +18985,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -18303,7 +19042,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -18315,14 +19054,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -18515,7 +19254,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -18523,7 +19263,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -18545,7 +19286,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -18619,15 +19361,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -18674,7 +19418,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -18686,14 +19430,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -18845,7 +19589,7 @@

Method Details

- stop(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None) + stop(project, zone, instance, discardLocalSsd=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)
Stops a running instance, shutting it down cleanly, and allows
 you to restart the instance at a later time. Stopped instances do not incur
 VM usage charges while they are stopped. However, resources that the VM is
@@ -18860,6 +19604,7 @@ 

Method Details

discardLocalSsd: boolean, This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded. + noGracefulShutdown: boolean, If set to true, Graceful Shutdown is skipped. requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. @@ -18920,15 +19665,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -18975,7 +19722,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -18987,14 +19734,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -19223,15 +19970,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -19278,7 +20027,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -19290,14 +20039,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -19595,7 +20344,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -19603,7 +20353,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -19625,7 +20376,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -19689,7 +20441,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -19780,7 +20575,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -19788,7 +20584,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -19810,7 +20607,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -19849,7 +20647,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -19857,7 +20656,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -19879,7 +20679,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -20001,7 +20802,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -20009,7 +20811,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -20031,7 +20834,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -20409,11 +21213,37 @@

Method Details

"reservationConsumptionInfo": { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from. "consumedReservation": "A String", # Output only. [Output Only] The full resource name of the reservation that this # instance is consuming from. + "consumedReservationBlock": "A String", # Output only. [Output Only] The full resource name of the reservation block that this + # instance is consuming from. + "consumedReservationSubBlock": "A String", # Output only. [Output Only] The full resource name of the reservation sub-block that + # this instance is consuming from. }, "scheduling": { "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. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. + "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. + }, + "shutdownDetails": { # Specifies if the instance is in `PENDING_STOP` state or there is a # Output only. [Output Only] Details about the instance stopping state. + # programmed stop scheduled. + "maxDuration": { # A Duration represents a fixed-length span of time represented # The duration for graceful shutdown. Only applicable when + # `stop_state=PENDING_STOP`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "requestTimestamp": "A String", # Past timestamp indicating the beginning of current `stopState` in RFC3339 text format. + "stopState": "A String", # Current stopping state of the instance. + "targetState": "A String", # Target instance state. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. "canReschedule": True or False, # Indicates if the maintenance can be customer triggered. @@ -20444,6 +21274,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -20509,6 +21356,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -20564,7 +21425,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -20572,7 +21434,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -20594,7 +21457,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -20713,15 +21577,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -20768,7 +21634,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -20780,14 +21646,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -21058,15 +21924,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -21113,7 +21981,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -21125,14 +21993,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -21361,15 +22229,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -21416,7 +22286,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -21428,14 +22298,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -21855,15 +22725,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -21910,7 +22782,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -21922,14 +22794,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -22163,15 +23035,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -22218,7 +23092,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -22230,14 +23104,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.instantSnapshotGroups.html b/docs/dyn/compute_v1.instantSnapshotGroups.html index 874ef5f98d..dcbadd5851 100644 --- a/docs/dyn/compute_v1.instantSnapshotGroups.html +++ b/docs/dyn/compute_v1.instantSnapshotGroups.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -933,15 +935,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -988,7 +992,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1000,14 +1004,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.instantSnapshots.html b/docs/dyn/compute_v1.instantSnapshots.html index 3ee0f48e5a..f310b4d0a1 100644 --- a/docs/dyn/compute_v1.instantSnapshots.html +++ b/docs/dyn/compute_v1.instantSnapshots.html @@ -481,15 +481,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -536,7 +538,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -548,14 +550,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1352,15 +1354,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1407,7 +1411,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1419,14 +1423,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2783,15 +2787,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2838,7 +2844,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2850,14 +2856,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.interconnectAttachmentGroups.html b/docs/dyn/compute_v1.interconnectAttachmentGroups.html index fca8ce056e..f509d2950a 100644 --- a/docs/dyn/compute_v1.interconnectAttachmentGroups.html +++ b/docs/dyn/compute_v1.interconnectAttachmentGroups.html @@ -181,15 +181,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -236,7 +238,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -248,14 +250,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1210,15 +1212,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1265,7 +1269,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1277,14 +1281,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1893,15 +1897,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1948,7 +1954,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1960,14 +1966,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.interconnectAttachments.html b/docs/dyn/compute_v1.interconnectAttachments.html index adf2cf7065..6391a8a2ff 100644 --- a/docs/dyn/compute_v1.interconnectAttachments.html +++ b/docs/dyn/compute_v1.interconnectAttachments.html @@ -751,15 +751,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -806,7 +808,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -818,14 +820,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1821,15 +1823,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1876,7 +1880,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1888,14 +1892,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3029,15 +3033,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3084,7 +3090,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3096,14 +3102,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3339,15 +3345,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3394,7 +3402,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3406,14 +3414,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.interconnectGroups.html b/docs/dyn/compute_v1.interconnectGroups.html index c3d6a7e1ec..cb0b18499e 100644 --- a/docs/dyn/compute_v1.interconnectGroups.html +++ b/docs/dyn/compute_v1.interconnectGroups.html @@ -305,15 +305,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -360,7 +362,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -372,14 +374,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -598,15 +600,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -653,7 +657,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -665,14 +669,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1699,15 +1703,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1754,7 +1760,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1766,14 +1772,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2369,15 +2375,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2424,7 +2432,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2436,14 +2444,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.interconnects.html b/docs/dyn/compute_v1.interconnects.html index 73f66d8c27..37444c6aa7 100644 --- a/docs/dyn/compute_v1.interconnects.html +++ b/docs/dyn/compute_v1.interconnects.html @@ -177,15 +177,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -232,7 +234,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -244,14 +246,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1206,15 +1208,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1261,7 +1265,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1273,14 +1277,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2217,15 +2221,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2272,7 +2278,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2284,14 +2290,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2516,15 +2522,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2571,7 +2579,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2583,14 +2591,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.licenses.html b/docs/dyn/compute_v1.licenses.html index a75350358f..0cd4c8a21f 100644 --- a/docs/dyn/compute_v1.licenses.html +++ b/docs/dyn/compute_v1.licenses.html @@ -180,15 +180,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -235,7 +237,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -247,14 +249,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1029,15 +1031,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1084,7 +1088,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1096,14 +1100,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2559,15 +2563,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2614,7 +2620,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2626,14 +2632,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.machineImages.html b/docs/dyn/compute_v1.machineImages.html index b68e77f648..128f2ec8ff 100644 --- a/docs/dyn/compute_v1.machineImages.html +++ b/docs/dyn/compute_v1.machineImages.html @@ -178,15 +178,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -233,7 +235,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -245,14 +247,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -529,7 +531,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -537,7 +540,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -559,7 +563,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -623,7 +628,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -714,7 +762,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -722,7 +771,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -744,7 +794,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -783,7 +834,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -791,7 +843,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -813,7 +866,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1180,6 +1234,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -1245,6 +1316,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -1337,7 +1422,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1345,7 +1431,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1367,7 +1454,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1433,7 +1521,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1441,7 +1530,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1463,7 +1553,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1524,7 +1615,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1532,7 +1624,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1554,7 +1647,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1870,6 +1964,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -1935,6 +2046,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -2472,7 +2597,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2480,7 +2606,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2502,7 +2629,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2566,7 +2694,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -2657,7 +2828,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2665,7 +2837,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2687,7 +2860,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2726,7 +2900,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2734,7 +2909,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2756,7 +2932,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3123,6 +3300,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -3188,6 +3382,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -3280,7 +3488,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3288,7 +3497,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3310,7 +3520,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3376,7 +3587,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3384,7 +3596,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3406,7 +3619,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3467,7 +3681,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3475,7 +3690,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3497,7 +3713,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3813,6 +4030,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -3878,6 +4112,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -3983,15 +4231,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4038,7 +4288,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4050,14 +4300,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4420,7 +4670,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4428,7 +4679,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4450,7 +4702,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4514,7 +4767,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -4605,7 +4901,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4613,7 +4910,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4635,7 +4933,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4674,7 +4973,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -4682,7 +4982,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -4704,7 +5005,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5071,6 +5373,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -5136,6 +5455,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -5228,7 +5561,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5236,7 +5570,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5258,7 +5593,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5324,7 +5660,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5332,7 +5669,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5354,7 +5692,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5415,7 +5754,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -5423,7 +5763,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -5445,7 +5786,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -5761,6 +6103,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -5826,6 +6185,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -6866,15 +7239,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6921,7 +7296,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6933,14 +7308,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.networkAttachments.html b/docs/dyn/compute_v1.networkAttachments.html index 44426d1f09..8c7310ecd9 100644 --- a/docs/dyn/compute_v1.networkAttachments.html +++ b/docs/dyn/compute_v1.networkAttachments.html @@ -446,15 +446,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -501,7 +503,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -513,14 +515,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1267,15 +1269,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1322,7 +1326,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1334,14 +1338,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1855,15 +1859,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1910,7 +1916,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1922,14 +1928,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.networkEdgeSecurityServices.html b/docs/dyn/compute_v1.networkEdgeSecurityServices.html index d72a2e6d46..a7750cae28 100644 --- a/docs/dyn/compute_v1.networkEdgeSecurityServices.html +++ b/docs/dyn/compute_v1.networkEdgeSecurityServices.html @@ -399,15 +399,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -454,7 +456,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -466,14 +468,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -779,15 +781,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -834,7 +838,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -846,14 +850,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1110,15 +1114,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1165,7 +1171,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1177,14 +1183,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.networkEndpointGroups.html b/docs/dyn/compute_v1.networkEndpointGroups.html index 67555cc523..28b169f993 100644 --- a/docs/dyn/compute_v1.networkEndpointGroups.html +++ b/docs/dyn/compute_v1.networkEndpointGroups.html @@ -584,15 +584,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -639,7 +641,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -651,14 +653,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -887,15 +889,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -942,7 +946,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -954,14 +958,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1227,15 +1231,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1282,7 +1288,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1294,14 +1300,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1877,15 +1883,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1932,7 +1940,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1944,14 +1952,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.networkFirewallPolicies.html b/docs/dyn/compute_v1.networkFirewallPolicies.html index 8450cd66c7..1c05680e3e 100644 --- a/docs/dyn/compute_v1.networkFirewallPolicies.html +++ b/docs/dyn/compute_v1.networkFirewallPolicies.html @@ -229,15 +229,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -284,7 +286,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -296,14 +298,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -715,15 +717,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -770,7 +774,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -782,14 +786,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1201,15 +1205,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1256,7 +1262,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1268,14 +1274,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2137,15 +2143,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2192,7 +2200,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2204,14 +2212,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2434,15 +2442,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2489,7 +2499,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2501,14 +2511,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4439,15 +4449,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4494,7 +4506,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4506,14 +4518,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5774,15 +5786,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5829,7 +5843,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5841,14 +5855,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6257,15 +6271,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6312,7 +6328,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6324,14 +6340,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6740,15 +6756,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6795,7 +6813,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6807,14 +6825,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7033,15 +7051,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7088,7 +7108,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7100,14 +7120,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7326,15 +7346,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7381,7 +7403,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7393,14 +7415,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7619,15 +7641,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7674,7 +7698,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7686,14 +7710,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.networks.html b/docs/dyn/compute_v1.networks.html index f63dab9b61..9ac85c7cb2 100644 --- a/docs/dyn/compute_v1.networks.html +++ b/docs/dyn/compute_v1.networks.html @@ -282,15 +282,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -337,7 +339,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -349,14 +351,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -583,15 +585,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -638,7 +642,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -650,14 +654,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -880,15 +884,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -935,7 +941,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -947,14 +953,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2123,15 +2129,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2178,7 +2186,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2190,14 +2198,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3097,15 +3105,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3152,7 +3162,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3164,14 +3174,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3396,15 +3406,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3451,7 +3463,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3463,14 +3475,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3696,15 +3708,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3751,7 +3765,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3763,14 +3777,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3988,15 +4002,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4043,7 +4059,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4055,14 +4071,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4357,15 +4373,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4412,7 +4430,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4424,14 +4442,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.nodeGroups.html b/docs/dyn/compute_v1.nodeGroups.html index 2ff76be9f5..cfa7a4a6d9 100644 --- a/docs/dyn/compute_v1.nodeGroups.html +++ b/docs/dyn/compute_v1.nodeGroups.html @@ -207,15 +207,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -262,7 +264,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -274,14 +276,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -780,15 +782,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -835,7 +839,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -847,14 +851,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1082,15 +1086,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1137,7 +1143,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1149,14 +1155,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1926,15 +1932,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1981,7 +1989,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1993,14 +2001,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2765,15 +2773,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2820,7 +2830,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2832,14 +2842,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3068,15 +3078,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3123,7 +3135,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3135,14 +3147,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4244,15 +4256,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4299,7 +4313,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4311,14 +4325,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4547,15 +4561,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4602,7 +4618,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4614,14 +4630,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.nodeTemplates.html b/docs/dyn/compute_v1.nodeTemplates.html index 1a5db39842..71158acb52 100644 --- a/docs/dyn/compute_v1.nodeTemplates.html +++ b/docs/dyn/compute_v1.nodeTemplates.html @@ -449,15 +449,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -504,7 +506,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -516,14 +518,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1277,15 +1279,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1332,7 +1336,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1344,14 +1348,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.organizationSecurityPolicies.html b/docs/dyn/compute_v1.organizationSecurityPolicies.html index 5d7fe5c1b4..f5081c18cd 100644 --- a/docs/dyn/compute_v1.organizationSecurityPolicies.html +++ b/docs/dyn/compute_v1.organizationSecurityPolicies.html @@ -224,15 +224,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -279,7 +281,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -291,14 +293,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -929,15 +931,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -984,7 +988,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -996,14 +1000,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1231,15 +1235,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1286,7 +1292,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1298,14 +1304,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1526,15 +1532,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1581,7 +1589,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1593,14 +1601,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3580,15 +3588,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3635,7 +3645,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3647,14 +3657,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4841,15 +4851,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4896,7 +4908,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4908,14 +4920,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5775,15 +5787,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5830,7 +5844,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5842,14 +5856,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6482,15 +6496,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6537,7 +6553,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6549,14 +6565,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6779,15 +6795,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6834,7 +6852,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6846,14 +6864,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7076,15 +7094,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7131,7 +7151,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7143,14 +7163,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.packetMirrorings.html b/docs/dyn/compute_v1.packetMirrorings.html index 56a8ad1680..18fc6c24bc 100644 --- a/docs/dyn/compute_v1.packetMirrorings.html +++ b/docs/dyn/compute_v1.packetMirrorings.html @@ -475,15 +475,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -530,7 +532,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -542,14 +544,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -994,15 +996,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1049,7 +1053,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1061,14 +1065,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1651,15 +1655,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1706,7 +1712,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1718,14 +1724,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.previewFeatures.html b/docs/dyn/compute_v1.previewFeatures.html index f59bc9a68e..842494b7c6 100644 --- a/docs/dyn/compute_v1.previewFeatures.html +++ b/docs/dyn/compute_v1.previewFeatures.html @@ -503,15 +503,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -558,7 +560,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -570,14 +572,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.projects.html b/docs/dyn/compute_v1.projects.html index d05ffc46d2..ba2087549b 100644 --- a/docs/dyn/compute_v1.projects.html +++ b/docs/dyn/compute_v1.projects.html @@ -197,15 +197,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -252,7 +254,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -264,14 +266,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -501,15 +503,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -556,7 +560,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -568,14 +572,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -792,15 +796,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -847,7 +853,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -859,14 +865,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1097,15 +1103,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1152,7 +1160,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1164,14 +1172,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2001,15 +2009,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2056,7 +2066,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2068,14 +2078,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2316,15 +2326,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2371,7 +2383,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2383,14 +2395,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2617,15 +2629,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2672,7 +2686,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2684,14 +2698,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2940,15 +2954,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2995,7 +3011,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3007,14 +3023,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3240,15 +3256,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3295,7 +3313,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3307,14 +3325,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3548,15 +3566,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3603,7 +3623,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3615,14 +3635,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.publicAdvertisedPrefixes.html b/docs/dyn/compute_v1.publicAdvertisedPrefixes.html index 938b8617a4..a303e01992 100644 --- a/docs/dyn/compute_v1.publicAdvertisedPrefixes.html +++ b/docs/dyn/compute_v1.publicAdvertisedPrefixes.html @@ -169,15 +169,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -224,7 +226,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -236,14 +238,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -466,15 +468,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -521,7 +525,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -533,14 +537,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -917,15 +921,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -972,7 +978,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -984,14 +990,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1504,15 +1510,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1559,7 +1567,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1571,14 +1579,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1796,15 +1804,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1851,7 +1861,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1863,14 +1873,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.publicDelegatedPrefixes.html b/docs/dyn/compute_v1.publicDelegatedPrefixes.html index 26a7bdc8d3..0d509f2a7b 100644 --- a/docs/dyn/compute_v1.publicDelegatedPrefixes.html +++ b/docs/dyn/compute_v1.publicDelegatedPrefixes.html @@ -456,15 +456,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -511,7 +513,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -523,14 +525,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -754,15 +756,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -809,7 +813,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -821,14 +825,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1231,15 +1235,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1286,7 +1292,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1298,14 +1304,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1845,15 +1851,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1900,7 +1908,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1912,14 +1920,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2139,15 +2147,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2194,7 +2204,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2206,14 +2216,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionAutoscalers.html b/docs/dyn/compute_v1.regionAutoscalers.html index cb31ea1159..861a1a5216 100644 --- a/docs/dyn/compute_v1.regionAutoscalers.html +++ b/docs/dyn/compute_v1.regionAutoscalers.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1166,15 +1168,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1221,7 +1225,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1233,14 +1237,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2294,15 +2298,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2349,7 +2355,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2361,14 +2367,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2964,15 +2970,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3019,7 +3027,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3031,14 +3039,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionBackendBuckets.html b/docs/dyn/compute_v1.regionBackendBuckets.html index ac17461b05..65fade2f68 100644 --- a/docs/dyn/compute_v1.regionBackendBuckets.html +++ b/docs/dyn/compute_v1.regionBackendBuckets.html @@ -185,15 +185,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -240,7 +242,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -252,14 +254,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1251,15 +1253,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1306,7 +1310,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1318,14 +1322,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2431,15 +2435,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2486,7 +2492,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2498,14 +2504,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionBackendServices.html b/docs/dyn/compute_v1.regionBackendServices.html index 7a911be618..e00ceecb12 100644 --- a/docs/dyn/compute_v1.regionBackendServices.html +++ b/docs/dyn/compute_v1.regionBackendServices.html @@ -193,15 +193,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -248,7 +250,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -260,14 +262,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1616,7 +1618,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -3322,7 +3328,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -3468,15 +3478,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3523,7 +3535,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3535,14 +3547,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4977,7 +4989,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -6385,7 +6401,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -7732,7 +7752,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -7878,15 +7902,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7933,7 +7959,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7945,14 +7971,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9056,15 +9082,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9111,7 +9139,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9123,14 +9151,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -10511,7 +10539,11 @@

Method Details

"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. # # Can only be set if load balancing scheme is EXTERNAL_MANAGED, - # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. + # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and + # EXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a + # global backend service, the service lb policy must be global. For a + # regional backend service, the service lb policy must be regional and in the + # same region. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. # # Only NONE and HEADER_FIELD are supported @@ -10657,15 +10689,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -10712,7 +10746,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -10724,14 +10758,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionCommitments.html b/docs/dyn/compute_v1.regionCommitments.html index 753112aaf3..e477f70472 100644 --- a/docs/dyn/compute_v1.regionCommitments.html +++ b/docs/dyn/compute_v1.regionCommitments.html @@ -1494,15 +1494,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1549,7 +1551,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1561,14 +1563,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2684,15 +2686,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2739,7 +2743,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2751,14 +2755,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionCompositeHealthChecks.html b/docs/dyn/compute_v1.regionCompositeHealthChecks.html index 30b4e46c6a..d324b128ba 100644 --- a/docs/dyn/compute_v1.regionCompositeHealthChecks.html +++ b/docs/dyn/compute_v1.regionCompositeHealthChecks.html @@ -419,15 +419,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -474,7 +476,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -486,14 +488,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -848,15 +850,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -903,7 +907,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -915,14 +919,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1384,15 +1388,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1439,7 +1445,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1451,14 +1457,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionDisks.html b/docs/dyn/compute_v1.regionDisks.html index 4301051360..91aa25d535 100644 --- a/docs/dyn/compute_v1.regionDisks.html +++ b/docs/dyn/compute_v1.regionDisks.html @@ -214,15 +214,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -269,7 +271,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -281,14 +283,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -554,15 +556,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -609,7 +613,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -621,14 +625,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -936,7 +940,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -944,7 +949,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -966,7 +972,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -996,7 +1003,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1004,7 +1012,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1026,7 +1035,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1062,7 +1072,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1070,7 +1081,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1092,7 +1104,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1183,15 +1196,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1238,7 +1253,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1250,14 +1265,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1480,15 +1495,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1535,7 +1552,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1547,14 +1564,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1842,7 +1859,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1850,7 +1868,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1872,7 +1891,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2073,7 +2093,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2081,7 +2102,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2103,7 +2125,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2154,7 +2177,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2162,7 +2186,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2184,7 +2209,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2731,7 +2757,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2739,7 +2766,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2761,7 +2789,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2962,7 +2991,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2970,7 +3000,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2992,7 +3023,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3043,7 +3075,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3051,7 +3084,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3073,7 +3107,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3179,15 +3214,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3234,7 +3271,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3246,14 +3283,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3627,7 +3664,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3635,7 +3673,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3657,7 +3696,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3858,7 +3898,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3866,7 +3907,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3888,7 +3930,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3939,7 +3982,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3947,7 +3991,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3969,7 +4014,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -4141,15 +4187,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4196,7 +4244,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4208,14 +4256,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4441,15 +4489,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4496,7 +4546,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4508,14 +4558,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5624,15 +5674,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5679,7 +5731,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5691,14 +5743,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5946,15 +5998,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6001,7 +6055,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6013,14 +6067,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6240,15 +6294,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6295,7 +6351,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6307,14 +6363,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6554,15 +6610,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6609,7 +6667,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6621,14 +6679,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6946,7 +7004,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -6954,7 +7013,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -6976,7 +7036,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7177,7 +7238,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7185,7 +7247,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7207,7 +7270,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7258,7 +7322,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -7266,7 +7331,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -7288,7 +7354,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -7395,15 +7462,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7450,7 +7519,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7462,14 +7531,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7707,15 +7776,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7762,7 +7833,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7774,14 +7845,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionHealthAggregationPolicies.html b/docs/dyn/compute_v1.regionHealthAggregationPolicies.html index d8a329c1c8..970710b8d3 100644 --- a/docs/dyn/compute_v1.regionHealthAggregationPolicies.html +++ b/docs/dyn/compute_v1.regionHealthAggregationPolicies.html @@ -432,15 +432,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -487,7 +489,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -499,14 +501,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -863,15 +865,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -918,7 +922,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -930,14 +934,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1432,15 +1436,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1487,7 +1493,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1499,14 +1505,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionHealthCheckServices.html b/docs/dyn/compute_v1.regionHealthCheckServices.html index f77f7610b9..f815da51c5 100644 --- a/docs/dyn/compute_v1.regionHealthCheckServices.html +++ b/docs/dyn/compute_v1.regionHealthCheckServices.html @@ -435,15 +435,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -490,7 +492,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -502,14 +504,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -871,15 +873,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -926,7 +930,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -938,14 +942,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1445,15 +1449,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1500,7 +1506,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1512,14 +1518,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionHealthChecks.html b/docs/dyn/compute_v1.regionHealthChecks.html index 0cbf00da57..48f0bfbc9f 100644 --- a/docs/dyn/compute_v1.regionHealthChecks.html +++ b/docs/dyn/compute_v1.regionHealthChecks.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -671,7 +673,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -758,8 +760,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. }
@@ -1031,7 +1034,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -1118,8 +1121,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. } @@ -1184,15 +1188,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1239,7 +1245,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1251,14 +1257,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1766,7 +1772,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -1853,8 +1859,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. }, @@ -2177,7 +2184,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -2264,8 +2271,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. } @@ -2330,15 +2338,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2385,7 +2395,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2397,14 +2407,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2856,7 +2866,7 @@

Method Details

# on what other health check fields are supported and what other resources # can use this health check: # - # - SSL, HTTP2, and GRPC protocols are not supported. + # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. # - The TCP request field is not supported. # - The proxyHeader field for HTTP, HTTPS, and TCP is not # supported. @@ -2943,8 +2953,9 @@

Method Details

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is # 5 seconds. It is invalid for timeoutSec to have greater # value than checkIntervalSec. - "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the - # protocol-specific health check fields must be specified, which must matchtype field. + "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. + # Exactly one of the protocol-specific health check fields must be specified, + # which must match type field. "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many # consecutive failures. The default value is 2. } @@ -3009,15 +3020,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3064,7 +3077,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3076,14 +3089,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionHealthSources.html b/docs/dyn/compute_v1.regionHealthSources.html index e99993f2c3..12c4d2421e 100644 --- a/docs/dyn/compute_v1.regionHealthSources.html +++ b/docs/dyn/compute_v1.regionHealthSources.html @@ -422,15 +422,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -477,7 +479,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -489,14 +491,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -870,15 +872,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -925,7 +929,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -937,14 +941,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1412,15 +1416,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1467,7 +1473,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1479,14 +1485,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionInstanceGroupManagerResizeRequests.html b/docs/dyn/compute_v1.regionInstanceGroupManagerResizeRequests.html index 494dd39d6c..3d6fccbd8c 100644 --- a/docs/dyn/compute_v1.regionInstanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_v1.regionInstanceGroupManagerResizeRequests.html @@ -171,15 +171,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -226,7 +228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -238,14 +240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -475,15 +477,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -530,7 +534,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -542,14 +546,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -833,15 +837,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -888,7 +894,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -900,14 +906,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -938,15 +944,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -993,7 +1001,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1005,14 +1013,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1167,15 +1175,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1222,7 +1232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1234,14 +1244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1272,15 +1282,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1327,7 +1339,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1339,14 +1351,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1433,15 +1445,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1488,7 +1502,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1500,14 +1514,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1876,15 +1890,17 @@

Method Details

# never removed from here, as the ResizeRequest is not going to retry. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1931,7 +1947,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1943,14 +1959,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1981,15 +1997,17 @@

Method Details

"error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2036,7 +2054,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2048,14 +2066,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionInstanceGroupManagers.html b/docs/dyn/compute_v1.regionInstanceGroupManagers.html index f87592f79c..0312db97c0 100644 --- a/docs/dyn/compute_v1.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_v1.regionInstanceGroupManagers.html @@ -251,15 +251,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -306,7 +308,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -318,14 +320,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -488,7 +490,7 @@

Method Details

The object takes the form of: { # RegionInstanceGroupManagers.applyUpdatesToInstances - "allInstances": True or False, # Flag to update all instances instead of specified list of “instances”. + "allInstances": True or False, # Flag to update all instances instead of specified list of "instances". # If the flag is set to true then the instances may not be specified # in the request. "instances": [ # The list of URLs of one or more instances for which you want to apply @@ -576,15 +578,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -631,7 +635,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -643,14 +647,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -955,15 +959,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1010,7 +1016,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1022,14 +1028,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1251,15 +1257,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1306,7 +1314,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1318,14 +1326,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1577,15 +1585,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1632,7 +1642,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1644,14 +1654,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1868,15 +1878,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1923,7 +1935,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1935,14 +1947,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2395,15 +2407,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2450,7 +2464,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2462,14 +2476,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2505,15 +2519,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2560,7 +2576,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2572,14 +2588,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3155,15 +3171,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3210,7 +3228,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3222,14 +3240,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3265,15 +3283,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3320,7 +3340,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3332,14 +3352,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3670,15 +3690,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3725,7 +3747,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3737,14 +3759,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4283,15 +4305,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4338,7 +4362,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4350,14 +4374,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4393,15 +4417,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4448,7 +4474,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4460,14 +4486,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5078,15 +5104,17 @@

Method Details

# delete the instance. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5133,7 +5161,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5145,14 +5173,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5877,15 +5905,17 @@

Method Details

"error": { # Output only. Encountered errors. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5932,7 +5962,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5944,14 +5974,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5987,15 +6017,17 @@

Method Details

"error": { # Output only. Errors encountered during bulk instance operation. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6042,7 +6074,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6054,14 +6086,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6392,15 +6424,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6447,7 +6481,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6459,14 +6493,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6763,15 +6797,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6818,7 +6854,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6830,14 +6866,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7080,15 +7116,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7135,7 +7173,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7147,14 +7185,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7387,15 +7425,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7442,7 +7482,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7454,14 +7494,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7705,15 +7745,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7760,7 +7802,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7772,14 +7814,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8007,15 +8049,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8062,7 +8106,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8074,14 +8118,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8314,15 +8358,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8369,7 +8415,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8381,14 +8427,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8632,15 +8678,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8687,7 +8735,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8699,14 +8747,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8963,15 +9011,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9018,7 +9068,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9030,14 +9080,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9292,15 +9342,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9347,7 +9399,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9359,14 +9411,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9663,15 +9715,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9718,7 +9772,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9730,14 +9784,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionInstanceGroups.html b/docs/dyn/compute_v1.regionInstanceGroups.html index aa3196c2ea..ee2e52f131 100644 --- a/docs/dyn/compute_v1.regionInstanceGroups.html +++ b/docs/dyn/compute_v1.regionInstanceGroups.html @@ -658,15 +658,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -713,7 +715,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -725,14 +727,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionInstanceTemplates.html b/docs/dyn/compute_v1.regionInstanceTemplates.html index 43f21d061d..d79eac0fc3 100644 --- a/docs/dyn/compute_v1.regionInstanceTemplates.html +++ b/docs/dyn/compute_v1.regionInstanceTemplates.html @@ -167,15 +167,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -222,7 +224,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -234,14 +236,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -536,7 +538,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -544,7 +547,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -566,7 +570,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -630,7 +635,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -721,7 +769,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -729,7 +778,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -751,7 +801,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -790,7 +841,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -798,7 +850,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -820,7 +873,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1187,6 +1241,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -1252,6 +1323,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -1487,7 +1572,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1495,7 +1581,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1517,7 +1604,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1581,7 +1669,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -1672,7 +1803,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1680,7 +1812,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1702,7 +1835,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1741,7 +1875,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1749,7 +1884,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1771,7 +1907,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2138,6 +2275,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -2203,6 +2357,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -2358,15 +2526,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2413,7 +2583,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2425,14 +2595,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2813,7 +2983,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2821,7 +2992,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2843,7 +3015,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2907,7 +3080,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -2998,7 +3214,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3006,7 +3223,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3028,7 +3246,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3067,7 +3286,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -3075,7 +3295,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -3097,7 +3318,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3464,6 +3686,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -3529,6 +3768,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical diff --git a/docs/dyn/compute_v1.regionInstances.html b/docs/dyn/compute_v1.regionInstances.html index 1ec69601fa..3af29c1480 100644 --- a/docs/dyn/compute_v1.regionInstances.html +++ b/docs/dyn/compute_v1.regionInstances.html @@ -172,7 +172,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -180,7 +181,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -202,7 +204,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -266,7 +269,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -357,7 +403,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -365,7 +412,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -387,7 +435,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -426,7 +475,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -434,7 +484,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -456,7 +507,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -634,7 +686,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -642,7 +695,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -664,7 +718,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -728,7 +783,50 @@

Method Details

# boot disks, the default size is the size of the sourceImage. # If you do not specify a sourceImage, the default disk size # is 500 GB. - "diskType": "A String", + "diskType": "A String", # Specifies the disk type used for the boot disk or an additional data + # disk. For valid disk type values, see + # Supported types for Hyperdisk volumes and + # Persistent Disk type variables. + # + # When creating a single instance, you must provide either the full or + # partial URL of the disk type. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # + # When creating an instance template, instance flexibility policy, or when + # creating or updating an all-instances configuration, you specify the + # disk type without a URL, for example, hyperdisk-balanced. + # + # If you omit this field for a disk, the default disk type depends on + # the instance's machine series, as follows. + # + # + # - For first- and second-generation machine series like N1, N2, T2, and + # M1, the + # default disk type is Standard Persistent Disk + # (pd-standard). + # - For C3, C3D, and M3 the default is Balanced Persistent Disk + # (pd-balanced). + # - For other third-generation machine + # series like A3, H3, Z3, all + # fourth-generation types like C4, N4, M4, and newer machine series, + # the default is Hyperdisk Balanced + # (hyperdisk-balanced). + # + # + # + # The disk type you specify must be compatible with the instance's machine + # series. For a list of machine series that support Persistent Disk, see Machine + # series support for Persistent Disk. + # + # For a list of machine series that support Hyperdisk, seeMachine + # series support for Hyperdisk. "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for # persistent disks. @@ -819,7 +917,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -827,7 +926,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -849,7 +949,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -888,7 +989,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -896,7 +998,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -918,7 +1021,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1285,6 +1389,23 @@

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. + "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 + # graceful shutdown isn't complete after this time, then the instance + # transitions to the STOPPING state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be # within the range of [90, 330] with the increment of 30, if unset, the # default behavior of host error recovery will be used. @@ -1350,6 +1471,20 @@

Method Details

# instance creation or while the instance isstopped and # therefore, in a `TERMINATED` state. SeeInstance Life # Cycle for more information on the possible instance states. + "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 + # Soft Off signal is triggered for Spot VMs only. If not specified, + # there will be no wait before the G2 Soft Off signal is triggered. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, "provisioningModel": "A String", # Specifies the provisioning model of the instance. "skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft # Off and ACPI G3 Mechanical @@ -1534,15 +1669,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1589,7 +1726,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1601,14 +1738,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionInstantSnapshotGroups.html b/docs/dyn/compute_v1.regionInstantSnapshotGroups.html index 2fe6856a97..43ccb34038 100644 --- a/docs/dyn/compute_v1.regionInstantSnapshotGroups.html +++ b/docs/dyn/compute_v1.regionInstantSnapshotGroups.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -934,15 +936,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -989,7 +993,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1001,14 +1005,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionInstantSnapshots.html b/docs/dyn/compute_v1.regionInstantSnapshots.html index 0f4af30c5d..c35b4bc64b 100644 --- a/docs/dyn/compute_v1.regionInstantSnapshots.html +++ b/docs/dyn/compute_v1.regionInstantSnapshots.html @@ -185,15 +185,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -240,7 +242,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -252,14 +254,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1056,15 +1058,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1111,7 +1115,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1123,14 +1127,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2487,15 +2491,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2542,7 +2548,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2554,14 +2560,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionNetworkEndpointGroups.html b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html index ed589701da..315a81a348 100644 --- a/docs/dyn/compute_v1.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html @@ -220,15 +220,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -275,7 +277,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -287,14 +289,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -521,15 +523,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -576,7 +580,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -588,14 +592,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -862,15 +866,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -917,7 +923,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -929,14 +935,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1512,15 +1518,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1567,7 +1575,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1579,14 +1587,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html index 88345ecd3f..0d9ca83ae1 100644 --- a/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html @@ -215,15 +215,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -270,7 +272,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -282,14 +284,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -702,15 +704,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -757,7 +761,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -769,14 +773,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -996,15 +1000,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1051,7 +1057,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1063,14 +1069,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1294,15 +1300,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1349,7 +1357,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1361,14 +1369,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3674,15 +3682,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3729,7 +3739,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3741,14 +3751,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5012,15 +5022,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5067,7 +5079,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5079,14 +5091,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5496,15 +5508,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5551,7 +5565,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5563,14 +5577,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5790,15 +5804,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5845,7 +5861,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5857,14 +5873,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6084,15 +6100,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6139,7 +6157,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6151,14 +6169,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionNotificationEndpoints.html b/docs/dyn/compute_v1.regionNotificationEndpoints.html index 3e457b45a6..1de9d39818 100644 --- a/docs/dyn/compute_v1.regionNotificationEndpoints.html +++ b/docs/dyn/compute_v1.regionNotificationEndpoints.html @@ -426,15 +426,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -481,7 +483,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -493,14 +495,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -857,15 +859,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -912,7 +916,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -924,14 +928,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionOperations.html b/docs/dyn/compute_v1.regionOperations.html index 7b7079b608..037efe3378 100644 --- a/docs/dyn/compute_v1.regionOperations.html +++ b/docs/dyn/compute_v1.regionOperations.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -537,15 +539,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -592,7 +596,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -604,14 +608,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -883,15 +887,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -938,7 +944,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -950,14 +956,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionSecurityPolicies.html b/docs/dyn/compute_v1.regionSecurityPolicies.html index a9d63c17da..5022d55d85 100644 --- a/docs/dyn/compute_v1.regionSecurityPolicies.html +++ b/docs/dyn/compute_v1.regionSecurityPolicies.html @@ -577,15 +577,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -632,7 +634,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -644,14 +646,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -875,15 +877,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -930,7 +934,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -942,14 +946,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2886,15 +2890,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2941,7 +2947,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2953,14 +2959,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4609,15 +4615,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4664,7 +4672,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4676,14 +4684,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5303,15 +5311,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5358,7 +5368,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5370,14 +5380,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5584,15 +5594,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5639,7 +5651,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5651,14 +5663,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5894,15 +5906,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5949,7 +5963,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5961,14 +5975,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionSnapshotSettings.html b/docs/dyn/compute_v1.regionSnapshotSettings.html index 27a1ef6f95..85ae4856a9 100644 --- a/docs/dyn/compute_v1.regionSnapshotSettings.html +++ b/docs/dyn/compute_v1.regionSnapshotSettings.html @@ -226,15 +226,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -281,7 +283,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -293,14 +295,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionSnapshots.html b/docs/dyn/compute_v1.regionSnapshots.html index 8d1f8c2e83..6767bbfa08 100644 --- a/docs/dyn/compute_v1.regionSnapshots.html +++ b/docs/dyn/compute_v1.regionSnapshots.html @@ -188,15 +188,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -243,7 +245,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -255,14 +257,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -567,7 +569,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -575,7 +578,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -597,7 +601,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -627,7 +632,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -635,7 +641,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -657,7 +664,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -693,7 +701,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -701,7 +710,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -723,7 +733,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1273,7 +1284,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1281,7 +1293,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1303,7 +1316,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1333,7 +1347,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1341,7 +1356,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1363,7 +1379,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1399,7 +1416,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1407,7 +1425,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1429,7 +1448,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1520,15 +1540,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1575,7 +1597,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1587,14 +1609,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1985,7 +2007,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1993,7 +2016,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2015,7 +2039,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2045,7 +2070,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2053,7 +2079,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2075,7 +2102,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2111,7 +2139,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2119,7 +2148,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2141,7 +2171,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3181,15 +3212,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3236,7 +3269,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3248,14 +3281,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3523,15 +3556,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3578,7 +3613,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3590,14 +3625,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionSslCertificates.html b/docs/dyn/compute_v1.regionSslCertificates.html index 7bdbd9d13d..2d12b48cdc 100644 --- a/docs/dyn/compute_v1.regionSslCertificates.html +++ b/docs/dyn/compute_v1.regionSslCertificates.html @@ -166,15 +166,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -221,7 +223,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -233,14 +235,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -651,15 +653,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -706,7 +710,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -718,14 +722,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionSslPolicies.html b/docs/dyn/compute_v1.regionSslPolicies.html index 14f21d5f15..3a373928ff 100644 --- a/docs/dyn/compute_v1.regionSslPolicies.html +++ b/docs/dyn/compute_v1.regionSslPolicies.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -655,15 +657,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -710,7 +714,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -722,14 +726,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1375,15 +1379,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1430,7 +1436,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1442,14 +1448,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionTargetHttpProxies.html b/docs/dyn/compute_v1.regionTargetHttpProxies.html index b9be00a2b3..ebe7134c66 100644 --- a/docs/dyn/compute_v1.regionTargetHttpProxies.html +++ b/docs/dyn/compute_v1.regionTargetHttpProxies.html @@ -169,15 +169,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -224,7 +226,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -236,14 +238,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -616,15 +618,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -671,7 +675,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -683,14 +687,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1135,15 +1139,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1190,7 +1196,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1202,14 +1208,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionTargetHttpsProxies.html b/docs/dyn/compute_v1.regionTargetHttpsProxies.html index 5aaa2f1f55..d108207bec 100644 --- a/docs/dyn/compute_v1.regionTargetHttpsProxies.html +++ b/docs/dyn/compute_v1.regionTargetHttpsProxies.html @@ -175,15 +175,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -230,7 +232,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -242,14 +244,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -814,15 +816,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -869,7 +873,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -881,14 +885,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1591,15 +1595,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1646,7 +1652,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1658,14 +1664,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1895,15 +1901,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1950,7 +1958,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1962,14 +1970,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2195,15 +2203,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2250,7 +2260,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2262,14 +2272,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionTargetTcpProxies.html b/docs/dyn/compute_v1.regionTargetTcpProxies.html index 81fccc7dae..a51375e82c 100644 --- a/docs/dyn/compute_v1.regionTargetTcpProxies.html +++ b/docs/dyn/compute_v1.regionTargetTcpProxies.html @@ -166,15 +166,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -221,7 +223,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -233,14 +235,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -561,15 +563,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -616,7 +620,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -628,14 +632,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionUrlMaps.html b/docs/dyn/compute_v1.regionUrlMaps.html index b81d136bd8..6176609aad 100644 --- a/docs/dyn/compute_v1.regionUrlMaps.html +++ b/docs/dyn/compute_v1.regionUrlMaps.html @@ -164,15 +164,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -219,7 +221,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -231,14 +233,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -7562,15 +7564,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7617,7 +7621,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7629,14 +7633,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -15097,15 +15101,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -15152,7 +15158,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -15164,14 +15170,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -18931,15 +18937,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -18986,7 +18994,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -18998,14 +19006,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.reliabilityRisks.html b/docs/dyn/compute_v1.reliabilityRisks.html new file mode 100644 index 0000000000..98b0320c9d --- /dev/null +++ b/docs/dyn/compute_v1.reliabilityRisks.html @@ -0,0 +1,328 @@ + + + +

Compute Engine API . reliabilityRisks

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, reliabilityRisk, x__xgafv=None)

+

Returns the specified ReliabilityRisk resource.

+

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

+

Retrieves the list of reliabilityRisks available in the specified project.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(project, reliabilityRisk, x__xgafv=None) +
Returns the specified ReliabilityRisk resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  reliabilityRisk: string, Name of the ReliabilityRisk resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a ReliabilityRisk resource.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339
+      # text format.
+  "description": "A String", # An optional textual description of the resource; provided when the
+      # resource is created.
+  "details": { # Detailed insights and metrics about a detected reliability risk. # [Output Only] Details of the reliability risk resource
+    "duration": "A String", # The duration of the risk since it was detected.
+    "globalDnsInsight": { # Detailed insights for a global DNS reliability risk. # Insight details for global DNS risk.
+      "projectDefaultIsGlobalDns": True or False, # Indicates whether the project's default DNS setting is global DNS.
+      "queryObservationWindow": "A String", # The observation window for the query counts.
+      "riskyQueryCount": "A String", # The number of queries that are risky. This is always less than or
+          # equal to total_query_count.
+      "totalQueryCount": "A String", # The total number of queries in the observation window.
+    },
+    "lastUpdateTimestamp": "A String", # The last time the risk was updated.
+    "severity": "A String", # The severity of the risk.
+    "type": "A String", # The type of risk.
+  },
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#reliabilityRisk", # Output only. [Output Only] Type of resource. Always compute#reliabilityRisk
+      # for reliability risks.
+  "name": "A String", # Name of the resource. The name must be 1-63 characters long and
+      # comply with RFC1035.
+  "recommendation": { # Recommendation for mitigating a reliability risk, including a reference URL. # The recommendation to mitigate the risk.
+    "content": "A String", # Mitigation guide for the risk.
+    "referenceUrl": "A String", # URL referencing a more detailed mitigation guide.
+  },
+  "selfLink": "A String", # Output only. [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.
+}
+
+ +
+ list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Retrieves the list of reliabilityRisks available in the specified project.
+
+Args:
+  project: string, Project ID for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the List method of ReliabilityRisksService.
+  "etag": "A String", # [Output Only] An ETag of the resource.
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of ReliabilityRisk resources.
+    { # Represents a ReliabilityRisk resource.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339
+          # text format.
+      "description": "A String", # An optional textual description of the resource; provided when the
+          # resource is created.
+      "details": { # Detailed insights and metrics about a detected reliability risk. # [Output Only] Details of the reliability risk resource
+        "duration": "A String", # The duration of the risk since it was detected.
+        "globalDnsInsight": { # Detailed insights for a global DNS reliability risk. # Insight details for global DNS risk.
+          "projectDefaultIsGlobalDns": True or False, # Indicates whether the project's default DNS setting is global DNS.
+          "queryObservationWindow": "A String", # The observation window for the query counts.
+          "riskyQueryCount": "A String", # The number of queries that are risky. This is always less than or
+              # equal to total_query_count.
+          "totalQueryCount": "A String", # The total number of queries in the observation window.
+        },
+        "lastUpdateTimestamp": "A String", # The last time the risk was updated.
+        "severity": "A String", # The severity of the risk.
+        "type": "A String", # The type of risk.
+      },
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "kind": "compute#reliabilityRisk", # Output only. [Output Only] Type of resource. Always compute#reliabilityRisk
+          # for reliability risks.
+      "name": "A String", # Name of the resource. The name must be 1-63 characters long and
+          # comply with RFC1035.
+      "recommendation": { # Recommendation for mitigating a reliability risk, including a reference URL. # The recommendation to mitigate the risk.
+        "content": "A String", # Mitigation guide for the risk.
+        "referenceUrl": "A String", # URL referencing a more detailed mitigation guide.
+      },
+      "selfLink": "A String", # Output only. [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.
+    },
+  ],
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+      # end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.reservationBlocks.html b/docs/dyn/compute_v1.reservationBlocks.html index 1641c87398..9d135dad60 100644 --- a/docs/dyn/compute_v1.reservationBlocks.html +++ b/docs/dyn/compute_v1.reservationBlocks.html @@ -883,15 +883,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -938,7 +940,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -950,14 +952,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.reservationSlots.html b/docs/dyn/compute_v1.reservationSlots.html index b0bdf89ed1..04a01b451a 100644 --- a/docs/dyn/compute_v1.reservationSlots.html +++ b/docs/dyn/compute_v1.reservationSlots.html @@ -245,15 +245,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -300,7 +302,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -312,14 +314,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -773,15 +775,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -828,7 +832,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -840,14 +844,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.reservationSubBlocks.html b/docs/dyn/compute_v1.reservationSubBlocks.html index 783c07ca37..3b1721435b 100644 --- a/docs/dyn/compute_v1.reservationSubBlocks.html +++ b/docs/dyn/compute_v1.reservationSubBlocks.html @@ -666,15 +666,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -721,7 +723,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -733,14 +735,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1194,15 +1196,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1249,7 +1253,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1261,14 +1265,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1504,15 +1508,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1559,7 +1565,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1571,14 +1577,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.reservations.html b/docs/dyn/compute_v1.reservations.html index a241114d7d..3f0c7302e9 100644 --- a/docs/dyn/compute_v1.reservations.html +++ b/docs/dyn/compute_v1.reservations.html @@ -611,15 +611,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -666,7 +668,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -678,14 +680,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1747,15 +1749,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1802,7 +1806,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1814,14 +1818,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2428,15 +2432,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2483,7 +2489,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2495,14 +2501,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2731,15 +2737,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2786,7 +2794,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2798,14 +2806,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4165,15 +4173,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4220,7 +4230,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4232,14 +4242,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.resourcePolicies.html b/docs/dyn/compute_v1.resourcePolicies.html index d41720ede6..f9424d491f 100644 --- a/docs/dyn/compute_v1.resourcePolicies.html +++ b/docs/dyn/compute_v1.resourcePolicies.html @@ -511,15 +511,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -566,7 +568,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -578,14 +580,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1456,15 +1458,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1511,7 +1515,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1523,14 +1527,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2170,15 +2174,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2225,7 +2231,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2237,14 +2243,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.rolloutPlans.html b/docs/dyn/compute_v1.rolloutPlans.html index 21594425ad..02bc327a09 100644 --- a/docs/dyn/compute_v1.rolloutPlans.html +++ b/docs/dyn/compute_v1.rolloutPlans.html @@ -165,15 +165,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -220,7 +222,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -232,14 +234,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -667,15 +669,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -722,7 +726,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -734,14 +738,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.rollouts.html b/docs/dyn/compute_v1.rollouts.html index 6d913c62be..5203c738cc 100644 --- a/docs/dyn/compute_v1.rollouts.html +++ b/docs/dyn/compute_v1.rollouts.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -466,15 +468,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -521,7 +525,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -533,14 +537,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -763,15 +767,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -818,7 +824,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -830,14 +836,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1399,15 +1405,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1454,7 +1462,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1466,14 +1474,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1694,15 +1702,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1749,7 +1759,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1761,14 +1771,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.routers.html b/docs/dyn/compute_v1.routers.html index 26346f5031..4466bcd8a2 100644 --- a/docs/dyn/compute_v1.routers.html +++ b/docs/dyn/compute_v1.routers.html @@ -944,15 +944,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -999,7 +1001,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1011,14 +1013,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1238,15 +1240,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1293,7 +1297,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1305,14 +1309,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1532,15 +1536,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1587,7 +1593,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1599,14 +1605,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4048,15 +4054,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4103,7 +4111,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4115,14 +4123,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6215,15 +6223,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6270,7 +6280,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6282,14 +6292,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6571,15 +6581,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6626,7 +6638,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6638,14 +6650,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6977,15 +6989,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -7032,7 +7046,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -7044,14 +7058,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -8844,15 +8858,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -8899,7 +8915,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -8911,14 +8927,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9200,15 +9216,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9255,7 +9273,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9267,14 +9285,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -9606,15 +9624,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -9661,7 +9681,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -9673,14 +9693,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.routes.html b/docs/dyn/compute_v1.routes.html index 60ac449734..7cc1d2ab88 100644 --- a/docs/dyn/compute_v1.routes.html +++ b/docs/dyn/compute_v1.routes.html @@ -168,15 +168,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -223,7 +225,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -235,14 +237,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -809,15 +811,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -864,7 +868,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -876,14 +880,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.securityPolicies.html b/docs/dyn/compute_v1.securityPolicies.html index 100d2e2406..e6730840d3 100644 --- a/docs/dyn/compute_v1.securityPolicies.html +++ b/docs/dyn/compute_v1.securityPolicies.html @@ -585,15 +585,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -640,7 +642,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -652,14 +654,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1715,15 +1717,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1770,7 +1774,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1782,14 +1786,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3723,15 +3727,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3778,7 +3784,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3790,14 +3796,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -5578,15 +5584,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -5633,7 +5641,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -5645,14 +5653,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6271,15 +6279,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6326,7 +6336,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6338,14 +6348,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6551,15 +6561,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6606,7 +6618,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6618,14 +6630,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -6850,15 +6862,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -6905,7 +6919,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -6917,14 +6931,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.serviceAttachments.html b/docs/dyn/compute_v1.serviceAttachments.html index 8adbf3e2f6..6dcb7b6aa7 100644 --- a/docs/dyn/compute_v1.serviceAttachments.html +++ b/docs/dyn/compute_v1.serviceAttachments.html @@ -508,15 +508,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -563,7 +565,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -575,14 +577,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1449,15 +1451,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1504,7 +1508,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1516,14 +1520,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2157,15 +2161,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2212,7 +2218,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2224,14 +2230,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.snapshotSettings.html b/docs/dyn/compute_v1.snapshotSettings.html index 9db43b946f..769b854fad 100644 --- a/docs/dyn/compute_v1.snapshotSettings.html +++ b/docs/dyn/compute_v1.snapshotSettings.html @@ -224,15 +224,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -279,7 +281,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -291,14 +293,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.snapshots.html b/docs/dyn/compute_v1.snapshots.html index 0844245b07..678787ca9e 100644 --- a/docs/dyn/compute_v1.snapshots.html +++ b/docs/dyn/compute_v1.snapshots.html @@ -187,15 +187,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -242,7 +244,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -254,14 +256,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -565,7 +567,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -573,7 +576,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -595,7 +599,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -625,7 +630,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -633,7 +639,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -655,7 +662,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -691,7 +699,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -699,7 +708,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -721,7 +731,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1272,7 +1283,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1280,7 +1292,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1302,7 +1315,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1332,7 +1346,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1340,7 +1355,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1362,7 +1378,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1398,7 +1415,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1406,7 +1424,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -1428,7 +1447,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -1519,15 +1539,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1574,7 +1596,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1586,14 +1608,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1983,7 +2005,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -1991,7 +2014,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2013,7 +2037,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2043,7 +2068,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2051,7 +2077,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2073,7 +2100,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -2109,7 +2137,8 @@

Method Details

# For example: # # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - "rawKey": "A String", # Specifies a 256-bit customer-supplied + "rawKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies a 256-bit customer-supplied # encryption key, encoded in RFC # 4648 base64 to either encrypt or decrypt this resource. You can # provide either the rawKey or thersaEncryptedKey. @@ -2117,7 +2146,8 @@

Method Details

# # "rawKey": # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + "rsaEncryptedKey": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit # customer-supplied encryption key to either encrypt or decrypt this # resource. You can provide either the rawKey or thersaEncryptedKey. # For example: @@ -2139,7 +2169,8 @@

Method Details

# # # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - "sha256": "A String", # [Output only] TheRFC + "sha256": "A String", # [DEPRECATED] CSEK is no longer supported. Use CMEK instead. + # [Output only] TheRFC # 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, @@ -3166,15 +3197,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3221,7 +3254,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3233,14 +3266,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3506,15 +3539,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3561,7 +3596,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3573,14 +3608,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.sslCertificates.html b/docs/dyn/compute_v1.sslCertificates.html index b3b7dcc35e..32e1fedac0 100644 --- a/docs/dyn/compute_v1.sslCertificates.html +++ b/docs/dyn/compute_v1.sslCertificates.html @@ -452,15 +452,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -507,7 +509,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -519,14 +521,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -933,15 +935,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -988,7 +992,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1000,14 +1004,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.sslPolicies.html b/docs/dyn/compute_v1.sslPolicies.html index 63b82c8721..658fc16037 100644 --- a/docs/dyn/compute_v1.sslPolicies.html +++ b/docs/dyn/compute_v1.sslPolicies.html @@ -459,15 +459,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -514,7 +516,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -526,14 +528,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -936,15 +938,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -991,7 +995,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1003,14 +1007,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1653,15 +1657,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1708,7 +1714,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1720,14 +1726,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.storagePools.html b/docs/dyn/compute_v1.storagePools.html index ab9249e1e3..5591e2bf00 100644 --- a/docs/dyn/compute_v1.storagePools.html +++ b/docs/dyn/compute_v1.storagePools.html @@ -238,7 +238,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -317,6 +317,14 @@

Method Details

}, "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id. + "shareSettings": { # Share settings for the storage pool. # Share settings for the storage pool. + "projectMap": { # A map of project id and project config. + "a_key": { # Config for each project in the share settings. + "projectId": "A String", # The project ID, should be same as the key of this project config in the + # parent map. + }, + }, + }, "state": "A String", # Output only. [Output Only] The status of storage pool creation. # # @@ -517,15 +525,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -572,7 +582,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -584,14 +594,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -765,7 +775,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -844,6 +854,14 @@

Method Details

}, "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id. + "shareSettings": { # Share settings for the storage pool. # Share settings for the storage pool. + "projectMap": { # A map of project id and project config. + "a_key": { # Config for each project in the share settings. + "projectId": "A String", # The project ID, should be same as the key of this project config in the + # parent map. + }, + }, + }, "state": "A String", # Output only. [Output Only] The status of storage pool creation. # # @@ -1273,7 +1291,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -1352,6 +1370,14 @@

Method Details

}, "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id. + "shareSettings": { # Share settings for the storage pool. # Share settings for the storage pool. + "projectMap": { # A map of project id and project config. + "a_key": { # Config for each project in the share settings. + "projectId": "A String", # The project ID, should be same as the key of this project config in the + # parent map. + }, + }, + }, "state": "A String", # Output only. [Output Only] The status of storage pool creation. # # @@ -1454,15 +1480,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1509,7 +1537,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1521,14 +1549,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1788,7 +1816,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -1867,6 +1895,14 @@

Method Details

}, "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id. + "shareSettings": { # Share settings for the storage pool. # Share settings for the storage pool. + "projectMap": { # A map of project id and project config. + "a_key": { # Config for each project in the share settings. + "projectId": "A String", # The project ID, should be same as the key of this project config in the + # parent map. + }, + }, + }, "state": "A String", # Output only. [Output Only] The status of storage pool creation. # # @@ -3070,7 +3106,7 @@

Method Details

# text format. "description": "A String", # An optional description of this resource. Provide this property when you # create the resource. - "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Provisioned capacities for each SKU for this Exapool in GiB "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool @@ -3149,6 +3185,14 @@

Method Details

}, "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id. + "shareSettings": { # Share settings for the storage pool. # Share settings for the storage pool. + "projectMap": { # A map of project id and project config. + "a_key": { # Config for each project in the share settings. + "projectId": "A String", # The project ID, should be same as the key of this project config in the + # parent map. + }, + }, + }, "state": "A String", # Output only. [Output Only] The status of storage pool creation. # # @@ -3252,15 +3296,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3307,7 +3353,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3319,14 +3365,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.subnetworks.html b/docs/dyn/compute_v1.subnetworks.html index 69c17ea1ff..64e5b314d2 100644 --- a/docs/dyn/compute_v1.subnetworks.html +++ b/docs/dyn/compute_v1.subnetworks.html @@ -661,15 +661,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -716,7 +718,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -728,14 +730,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -964,15 +966,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1019,7 +1023,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1031,14 +1035,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2178,15 +2182,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2233,7 +2239,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2245,14 +2251,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3396,15 +3402,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3451,7 +3459,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3463,14 +3471,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -4572,15 +4580,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -4627,7 +4637,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -4639,14 +4649,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.targetGrpcProxies.html b/docs/dyn/compute_v1.targetGrpcProxies.html index 95357a3627..fab5e975fe 100644 --- a/docs/dyn/compute_v1.targetGrpcProxies.html +++ b/docs/dyn/compute_v1.targetGrpcProxies.html @@ -168,15 +168,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -223,7 +225,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -235,14 +237,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -569,15 +571,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -624,7 +628,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -636,14 +640,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1106,15 +1110,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1161,7 +1167,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1173,14 +1179,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.targetHttpProxies.html b/docs/dyn/compute_v1.targetHttpProxies.html index ec8974c753..641ccba33c 100644 --- a/docs/dyn/compute_v1.targetHttpProxies.html +++ b/docs/dyn/compute_v1.targetHttpProxies.html @@ -415,15 +415,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -470,7 +472,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -482,14 +484,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -860,15 +862,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -915,7 +919,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -927,14 +931,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1443,15 +1447,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1498,7 +1504,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1510,14 +1516,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1742,15 +1748,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1797,7 +1805,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1809,14 +1817,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.targetHttpsProxies.html b/docs/dyn/compute_v1.targetHttpsProxies.html index 0f1caa4b71..1e506f7cd7 100644 --- a/docs/dyn/compute_v1.targetHttpsProxies.html +++ b/docs/dyn/compute_v1.targetHttpsProxies.html @@ -548,15 +548,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -603,7 +605,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -615,14 +617,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1185,15 +1187,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1240,7 +1244,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1252,14 +1256,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1960,15 +1964,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2015,7 +2021,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2027,14 +2033,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2262,15 +2268,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2317,7 +2325,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2329,14 +2337,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2562,15 +2570,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2617,7 +2627,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2629,14 +2639,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2867,15 +2877,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2922,7 +2934,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2934,14 +2946,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3170,15 +3182,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3225,7 +3239,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3237,14 +3251,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3470,15 +3484,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3525,7 +3541,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3537,14 +3553,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.targetInstances.html b/docs/dyn/compute_v1.targetInstances.html index 40ee4cca9e..26f9bcccf8 100644 --- a/docs/dyn/compute_v1.targetInstances.html +++ b/docs/dyn/compute_v1.targetInstances.html @@ -415,15 +415,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -470,7 +472,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -482,14 +484,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -814,15 +816,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -869,7 +873,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -881,14 +885,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1311,15 +1315,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1366,7 +1372,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1378,14 +1384,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.targetPools.html b/docs/dyn/compute_v1.targetPools.html index 66c6dc74f4..6b9d980651 100644 --- a/docs/dyn/compute_v1.targetPools.html +++ b/docs/dyn/compute_v1.targetPools.html @@ -207,15 +207,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -262,7 +264,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -274,14 +276,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -517,15 +519,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -572,7 +576,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -584,14 +588,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1084,15 +1088,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1139,7 +1145,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1151,14 +1157,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1597,15 +1603,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1652,7 +1660,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1664,14 +1672,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2137,15 +2145,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2192,7 +2202,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2204,14 +2214,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2442,15 +2452,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2497,7 +2509,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2509,14 +2521,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2743,15 +2755,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2798,7 +2812,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2810,14 +2824,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -3046,15 +3060,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3101,7 +3117,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3113,14 +3129,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.targetSslProxies.html b/docs/dyn/compute_v1.targetSslProxies.html index e039f3d67f..0122bce30b 100644 --- a/docs/dyn/compute_v1.targetSslProxies.html +++ b/docs/dyn/compute_v1.targetSslProxies.html @@ -183,15 +183,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -238,7 +240,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -250,14 +252,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -580,15 +582,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -635,7 +639,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -647,14 +651,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1073,15 +1077,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1128,7 +1134,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1140,14 +1146,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1375,15 +1381,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1430,7 +1438,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1442,14 +1450,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1675,15 +1683,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1730,7 +1740,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1742,14 +1752,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1979,15 +1989,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2034,7 +2046,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2046,14 +2058,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2282,15 +2294,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -2337,7 +2351,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -2349,14 +2363,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.targetTcpProxies.html b/docs/dyn/compute_v1.targetTcpProxies.html index aadb544c8f..c6536e1c04 100644 --- a/docs/dyn/compute_v1.targetTcpProxies.html +++ b/docs/dyn/compute_v1.targetTcpProxies.html @@ -417,15 +417,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -472,7 +474,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -484,14 +486,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -810,15 +812,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -865,7 +869,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -877,14 +881,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1301,15 +1305,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1356,7 +1362,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1368,14 +1374,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1601,15 +1607,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1656,7 +1664,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1668,14 +1676,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.targetVpnGateways.html b/docs/dyn/compute_v1.targetVpnGateways.html index 745f4c8d6f..c9d68cd267 100644 --- a/docs/dyn/compute_v1.targetVpnGateways.html +++ b/docs/dyn/compute_v1.targetVpnGateways.html @@ -440,15 +440,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -495,7 +497,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -507,14 +509,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -895,15 +897,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -950,7 +954,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -962,14 +966,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1426,15 +1430,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1481,7 +1487,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1493,14 +1499,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.urlMaps.html b/docs/dyn/compute_v1.urlMaps.html index a427ff8f19..3cf15701f3 100644 --- a/docs/dyn/compute_v1.urlMaps.html +++ b/docs/dyn/compute_v1.urlMaps.html @@ -3929,15 +3929,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -3984,7 +3986,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -3996,14 +3998,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11336,15 +11338,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11391,7 +11395,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11403,14 +11407,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -11655,15 +11659,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -11710,7 +11716,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -11722,14 +11728,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -19199,15 +19205,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -19254,7 +19262,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -19266,14 +19274,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -23076,15 +23084,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -23131,7 +23141,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -23143,14 +23153,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.vpnGateways.html b/docs/dyn/compute_v1.vpnGateways.html index 75f06cf613..1a686dd520 100644 --- a/docs/dyn/compute_v1.vpnGateways.html +++ b/docs/dyn/compute_v1.vpnGateways.html @@ -466,15 +466,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -521,7 +523,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -533,14 +535,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1010,15 +1012,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1065,7 +1069,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1077,14 +1081,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1561,15 +1565,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1616,7 +1622,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1628,14 +1634,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.vpnTunnels.html b/docs/dyn/compute_v1.vpnTunnels.html index b51d6ca371..dbe39a27c2 100644 --- a/docs/dyn/compute_v1.vpnTunnels.html +++ b/docs/dyn/compute_v1.vpnTunnels.html @@ -535,15 +535,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -590,7 +592,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -602,14 +604,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1178,15 +1180,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1233,7 +1237,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1245,14 +1249,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1804,15 +1808,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1859,7 +1865,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1871,14 +1877,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.wireGroups.html b/docs/dyn/compute_v1.wireGroups.html index 26c7e88027..565c6aab75 100644 --- a/docs/dyn/compute_v1.wireGroups.html +++ b/docs/dyn/compute_v1.wireGroups.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -769,15 +771,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -824,7 +828,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -836,14 +840,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1510,15 +1514,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1565,7 +1571,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1577,14 +1583,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.zoneOperations.html b/docs/dyn/compute_v1.zoneOperations.html index 4723f0262c..ef959f5a55 100644 --- a/docs/dyn/compute_v1.zoneOperations.html +++ b/docs/dyn/compute_v1.zoneOperations.html @@ -170,15 +170,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -225,7 +227,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -237,14 +239,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -537,15 +539,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -592,7 +596,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -604,14 +608,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -882,15 +886,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -937,7 +943,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -949,14 +955,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.zoneVmExtensionPolicies.html b/docs/dyn/compute_v1.zoneVmExtensionPolicies.html index e0bcf5e7c3..d55fc0bcf4 100644 --- a/docs/dyn/compute_v1.zoneVmExtensionPolicies.html +++ b/docs/dyn/compute_v1.zoneVmExtensionPolicies.html @@ -169,15 +169,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -224,7 +226,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -236,14 +238,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -599,15 +601,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -654,7 +658,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -666,14 +670,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1173,15 +1177,17 @@

Method Details

# this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this # operation. - { + { # Represents a single error encountered during the processing of an + # operation. "code": "A String", # [Output Only] The error type identifier for this error. "errorDetails": [ # [Output Only] An optional list of messages that contain the error # details. There is a set of defined message types to use for providing # details.The syntax depends on the error code. For example, # QuotaExceededInfo will have details when the error code is # QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. + { # Container for structured error details providing additional context + # specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. # # Example of an error when contacting the "pubsub.googleapis.com" API when it # is not enabled: @@ -1228,7 +1234,7 @@

Method Details

# regular expression of `A-Z+[A-Z0-9]`, which represents # UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. + "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. # # For example, if a quota check failed with an error indicating the calling # project hasn't enabled the accessed service, this can contain a URL pointing @@ -1240,14 +1246,14 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user + "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. # which can be attached to an RPC error. "locale": "A String", # The locale used following the specification defined at # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. # Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index ae6f631a58..dbfc1dcbd9 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -29,6 +29,223 @@ "description": "Creates and runs virtual machines on Google Cloud Platform.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/compute/", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-west4.rep.googleapis.com/", +"location": "us-west4" +} +], "icons": { "x16": "https://www.google.com/images/icons/product/compute_engine-16.png", "x32": "https://www.google.com/images/icons/product/compute_engine-32.png" @@ -977,6 +1194,43 @@ "https://www.googleapis.com/auth/compute" ] }, +"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.", +"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", @@ -20220,6 +20474,48 @@ "https://www.googleapis.com/auth/compute" ] }, +"setName": { +"description": "Sets name of an interconnect.", +"flatPath": "projects/{project}/global/interconnects/{interconnect}/setName", +"httpMethod": "POST", +"id": "compute.interconnects.setName", +"parameterOrder": [ +"project", +"interconnect" +], +"parameters": { +"interconnect": { +"description": "Name of the interconnect to update.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID\nso that if you must retry your request, the server will know to ignore\nthe request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/global/interconnects/{interconnect}/setName", +"request": { +"$ref": "InterconnectsSetNameRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", "flatPath": "projects/{project}/global/interconnects/{resource}/testIamPermissions", @@ -21250,6 +21546,100 @@ } } }, +"managedRulesets": { +"methods": { +"get": { +"description": "Gets the details for the specified managed ruleset name.", +"flatPath": "projects/{project}/global/managedRulesets/{managedRuleset}", +"httpMethod": "GET", +"id": "compute.managedRulesets.get", +"parameterOrder": [ +"project", +"managedRuleset" +], +"parameters": { +"managedRuleset": { +"description": "Name of the managed ruleset to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/managedRulesets/{managedRuleset}", +"response": { +"$ref": "ManagedRuleset" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"list": { +"description": "Retrieves the list of all the managed rulesets available.", +"flatPath": "projects/{project}/global/managedRulesets", +"httpMethod": "GET", +"id": "compute.managedRulesets.list", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/global/managedRulesets", +"response": { +"$ref": "ManagedRulesetList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, "networkAttachments": { "methods": { "aggregatedList": { @@ -28014,7 +28404,7 @@ "projectViews": { "methods": { "get": { -"description": "Returns the specified global ProjectViews resource, with a regional\ncontext.", +"description": "Returns the specified global ProjectViews resource, with a regional\ncontext.\nThis regional API endpoint reads resource metadata from regional\nread-only replicas. Because changes are copied to these regional replicas\nasynchronously, for real-time resource reads or any write operations\n(creating, updating, or deleting resources), use the global\n[projects.get](https://cloud.google.com/compute/docs/reference/rest/v1/projects/get)\nendpoint.", "flatPath": "projects/{project}/regions/{region}/projectViews", "httpMethod": "GET", "id": "compute.projectViews.get", @@ -44151,6 +44541,81 @@ } } }, +"reservationConsumedInstances": { +"methods": { +"list": { +"description": "Lists the instances consuming capacity from a specific reservation.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationConsumedInstances", +"httpMethod": "GET", +"id": "compute.reservationConsumedInstances.list", +"parameterOrder": [ +"project", +"zone", +"reservation" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Required. Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"reservation": { +"description": "Required. The name of the reservation to list consumed instances for.", +"location": "path", +"pattern": "^reservations/[^/]+$", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "Required. Zone name for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{+reservation}/reservationConsumedInstances", +"response": { +"$ref": "ReservationConsumedInstancesListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, "reservationSlots": { "methods": { "get": { @@ -57624,7 +58089,7 @@ } } }, -"revision": "20260629", +"revision": "20260722", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -58571,7 +59036,7 @@ false "type": "string" }, "ipCollection": { -"description": "Reference to the source of IP addresses.\n\nIt supports the following cases:\n \n - \n Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4\n addresses. The PDP must support enhanced IPv4 allocations.\n - \n Case 2: Internal Range for global internal addresses.\n\n\n\nUse one of the following formats to specify the resource:\n\nFor a Public Delegated Prefix:\n \n - \n Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp\n - Partial URL:\n - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - regions/region/publicDelegatedPrefixes/pdp-name\n \n\n\nFor an Internal Range:\n \n - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range\n - Partial URL:projects/project/locations/global/internalRanges/internal-range", +"description": "Reference to the source of IP addresses.\n\nIt supports the following cases:\n \n - \n Case 1: PublicDelegatedPrefix (PDP) for BYOIP external\n addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4\n allocations. If an IPv6 PDP is used, the PDP must be in\n EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.\n - \n Case 2: Internal Range for global internal addresses.\n\n\n\nUse one of the following formats to specify the resource:\n\nFor a Public Delegated Prefix:\n \n - \n Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp\n - Partial URL:\n - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - regions/region/publicDelegatedPrefixes/pdp-name\n \n\n\nFor an Internal Range:\n \n - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range\n - Partial URL:projects/project/locations/global/internalRanges/internal-range", "type": "string" }, "ipVersion": { @@ -58656,7 +59121,7 @@ false "type": "integer" }, "purpose": { -"description": "The purpose of this resource, which can be one of the following values:\n \n \n - GCE_ENDPOINT for addresses that are used by VM\n instances, alias IP ranges, load balancers, and similar resources.\n - DNS_RESOLVER for a DNS resolver address in a subnetwork\n for a Cloud DNS inbound\n forwarder IP addresses (regional internal IP address in a subnet of\n a VPC network)\n - VPC_PEERING for global internal IP addresses used for\n \n private services access allocated ranges.\n - NAT_AUTO for the regional external IP addresses used by\n Cloud NAT when allocating addresses using\n \n automatic NAT IP address allocation.\n - IPSEC_INTERCONNECT for addresses created from a private\n IP range that are reserved for a VLAN attachment in an\n *HA VPN over Cloud Interconnect* configuration. These addresses\n are regional resources.\n - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned\n to multiple internal forwarding rules.\n - `PRIVATE_SERVICE_CONNECT` for a private network address that is\n used to configure Private Service Connect. Only global internal addresses\n can use this purpose.", +"description": "The purpose of this resource, which can be one of the following values:\n \n \n - GCE_ENDPOINT for addresses that are used by VM\n instances, alias IP ranges, load balancers, and similar resources.\n - DNS_RESOLVER for a DNS resolver address in a subnetwork\n for a Cloud DNS inbound\n forwarder IP addresses (regional internal IP address in a subnet of\n a VPC network)\n - VPC_PEERING for global internal IP addresses used for\n \n private services access allocated ranges.\n - NAT_AUTO for the regional external IP addresses used by\n Cloud NAT when allocating addresses using\n \n automatic NAT IP address allocation.\n - IPSEC_INTERCONNECT for addresses created from a private\n IP range that are reserved for a VLAN attachment in an\n *HA VPN over Cloud Interconnect* configuration. These addresses\n are regional resources.\n - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned\n to multiple internal forwarding rules.\n - `PRIVATE_SERVICE_CONNECT` for a private network address that is\n used to configure Private Service Connect. Only global internal addresses\n can use this purpose.\n - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses\n that can only be assigned to global external Passthrough Network Load\n Balancer forwarding rules, as an Availability Group 0 address.\n - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that\n can only be assigned to global external Passthrough Network Load Balancer\n forwarding rules, as an Availability Group 1 address.", "enum": [ "APPLICATION_AND_PROXY_LOAD_BALANCERS", "DNS_RESOLVER", @@ -58675,7 +59140,7 @@ false "The global external address can only be assigned to Global External\nApplication or Proxy Load Balancer forwarding rules. This is the default\nvalue for global external addresses.", "DNS resolver address in the subnetwork.", "VM internal/alias IP, Internal LB service IP, etc.", -"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment\u2019s IP address range.", +"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment's IP address range.", "External IP automatically reserved for Cloud NAT.", "The global external address can only be assigned to Global External\nPassthrough Network Load Balancer forwarding rules, as an Availability\nGroup 0 address.", "The global external address can only be assigned to Global External\nPassthrough Network Load Balancer forwarding rules, as an Availability\nGroup 1 address.", @@ -59787,6 +60252,7 @@ false "type": "string" }, "diskType": { +"description": "Specifies the disk type used for the boot disk or an additional data\ndisk. For valid disk type values, see \nSupported types for Hyperdisk volumes and\nPersistent Disk type variables.\n\nWhen creating a single instance, you must provide either the full or\npartial URL of the disk type. For example, the following values are\nvalid: \n \n \n - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType\n - projects/project/zones/zone/diskTypes/diskType\n - zones/zone/diskTypes/diskType\n\n\n\nWhen creating an instance template, instance flexibility policy, or when\ncreating or updating an all-instances configuration, you specify the\ndisk type without a URL, for example, hyperdisk-balanced.\n\nIf you omit this field for a disk, the default disk type depends on\nthe instance's machine series, as follows.\n \n \n - For first- and second-generation machine series like N1, N2, T2, and\n M1, the\n default disk type is Standard Persistent Disk\n (pd-standard).\n - For C3, C3D, and M3 the default is Balanced Persistent Disk\n (pd-balanced). \n - For other third-generation machine\n series like A3, H3, Z3, all\n fourth-generation types like C4, N4, M4, and newer machine series,\n the default is Hyperdisk Balanced\n (hyperdisk-balanced).\n\n\n\nThe disk type you specify must be compatible with the instance's machine\nseries. For a list of machine series that support Persistent Disk, see Machine\nseries support for Persistent Disk.\n\nFor a list of machine series that support Hyperdisk, seeMachine\nseries support for Hyperdisk.", "type": "string" }, "enableConfidentialCompute": { @@ -62218,7 +62684,7 @@ false "type": "array" }, "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 and the scope is global.", +"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" }, "sessionAffinity": { @@ -64329,6 +64795,67 @@ 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.", +"id": "CalendarModeExtensionAdviceRequest", +"properties": { +"endTimeNotLaterThan": { +"description": "Required. The desired end time after the Future Reservation is extended.", +"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 containing the recommended duration to extend a\nFuture Reservation in CALENDAR mode based on the available capacity during\nthe 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.", +"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." +}, +"recommendationId": { +"description": "Unique id of the recommendation, a UUID string generated by the API.", +"type": "string" +} +}, +"type": "object" +}, +"CalendarModeExtensionAdviceResponseNotRecommendedReason": { +"description": "Information about why no recommendation was provided.", +"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.", +"type": "string" +}, +"status": { +"description": "Status of recommendation.", +"enum": [ +"CONDITIONS_NOT_MET", +"NOT_RECOMMENDED_REASON_STATUS_UNSPECIFIED", +"NO_CAPACITY" +], +"enumDescriptions": [ +"The requested extension window does not 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", @@ -65085,6 +65612,8 @@ false "MEMORY_OPTIMIZED", "MEMORY_OPTIMIZED_M3", "MEMORY_OPTIMIZED_M4", +"MEMORY_OPTIMIZED_M4N", +"MEMORY_OPTIMIZED_M4N_6TB", "MEMORY_OPTIMIZED_M4_6TB", "MEMORY_OPTIMIZED_X4", "MEMORY_OPTIMIZED_X4_1440_24T", @@ -65097,6 +65626,9 @@ false "MEMORY_OPTIMIZED_X4_960_12T", "MEMORY_OPTIMIZED_X4_960_16T", "NETWORK_OPTIMIZED_C4N", +"NETWORK_OPTIMIZED_U4C", +"NETWORK_OPTIMIZED_U4P", +"NETWORK_OPTIMIZED_U4S", "STORAGE_OPTIMIZED_Z3", "STORAGE_OPTIMIZED_Z4D", "TYPE_UNSPECIFIED" @@ -65135,6 +65667,8 @@ false "", "", "", +"", +"", "CUD bucket for X4 machine with 1440 vCPUs and 24TB of memory.", "", "CUD bucket for X4 machine with 1920 vCPUs and 32TB of memory.", @@ -65145,6 +65679,9 @@ false "CUD bucket for X4 machine with 960 vCPUs and 12TB of memory.", "CUD bucket for X4 machine with 960 vCPUs and 16TB of memory.", "CUD bucket for C4N (dual Diorite) machines.", +"CUD bucket for NETWORK_OPTIMIZED_U4C machines.", +"CUD bucket for NETWORK_OPTIMIZED_U4P machines.", +"CUD bucket for NETWORK_OPTIMIZED_U4S machines.", "", "CUD bucket for Z4D machines.", "Note for internal users: When adding a new enum Type for v1, make sure\nto also add it in the comment for the `optional Type type` definition.\nThis ensures that the public documentation displays the new enum Type." @@ -66690,15 +67227,18 @@ false "type": "string" }, "rawKey": { -"description": "Specifies a 256-bit customer-supplied\nencryption key, encoded in RFC\n4648 base64 to either encrypt or decrypt this resource. You can\nprovide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rawKey\":\n\"SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=\"", +"deprecated": true, +"description": "[DEPRECATED] CSEK is no longer supported. Use CMEK instead.\nSpecifies a 256-bit customer-supplied\nencryption key, encoded in RFC\n4648 base64 to either encrypt or decrypt this resource. You can\nprovide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rawKey\":\n\"SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=\"", "type": "string" }, "rsaEncryptedKey": { -"description": "Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit\ncustomer-supplied encryption key to either encrypt or decrypt this\nresource. You can provide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rsaEncryptedKey\":\n\"ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH\nz0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD\nD6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==\"\n\nThe key must meet the following requirements before you can provide it to \nCompute Engine: \n \n 1. The key is wrapped using a RSA public key certificate provided by \n Google. \n 2. After being wrapped, the key must be encoded in RFC 4648 base64 \n encoding. \n\nGets the RSA public key certificate provided by Google at: \n\n\nhttps://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem", +"deprecated": true, +"description": "[DEPRECATED] CSEK is no longer supported. Use CMEK instead.\nSpecifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit\ncustomer-supplied encryption key to either encrypt or decrypt this\nresource. You can provide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rsaEncryptedKey\":\n\"ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH\nz0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD\nD6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==\"\n\nThe key must meet the following requirements before you can provide it to \nCompute Engine: \n \n 1. The key is wrapped using a RSA public key certificate provided by \n Google. \n 2. After being wrapped, the key must be encoded in RFC 4648 base64 \n encoding. \n\nGets the RSA public key certificate provided by Google at: \n\n\nhttps://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem", "type": "string" }, "sha256": { -"description": "[Output only] TheRFC\n4648 base64 encoded SHA-256 hash of the customer-supplied\nencryption key that protects this resource.", +"deprecated": true, +"description": "[DEPRECATED] CSEK is no longer supported. Use CMEK instead.\n[Output only] TheRFC\n4648 base64 encoded SHA-256 hash of the customer-supplied\nencryption key that protects this resource.", "type": "string" } }, @@ -70759,6 +71299,19 @@ false }, "type": "object" }, +"FirewallPolicyRuleOperationMetadata": { +"description": "Metadata for FirewallPolicyRule operations.", +"id": "FirewallPolicyRuleOperationMetadata", +"properties": { +"allocatedPriority": { +"description": "Output only. [Output Only] The priority allocated for the firewall policy rule if query\nparameters specified minPriority/maxPriority.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "FirewallPolicyRuleSecureTag": { "id": "FirewallPolicyRuleSecureTag", "properties": { @@ -73621,6 +74174,10 @@ false "description": "Policy for a single extension.", "id": "GlobalVmExtensionPolicyExtensionPolicy", "properties": { +"installedSoftwareSelector": { +"$ref": "GlobalVmExtensionPolicyInstalledSoftwareSelector", +"description": "Optional. Only deploy this extension if the specified software is detected on the\nVM. For a live list of valid software values, see:\nhttps://cloud.google.com/compute/docs/vm-extensions/supported-software" +}, "pinnedVersion": { "description": "Optional. The version pinning for the extension.\nIf empty, the extension will be installed with the latest version\nreleased by the extension producer.", "type": "string" @@ -73632,6 +74189,33 @@ false }, "type": "object" }, +"GlobalVmExtensionPolicyInstalledSoftwareSelector": { +"description": "Defines the software requirements for a VM extension policy.", +"id": "GlobalVmExtensionPolicyInstalledSoftwareSelector", +"properties": { +"anyOfSelectors": { +"additionalProperties": { +"$ref": "GlobalVmExtensionPolicyInstalledSoftwareSelectorSelectorSet" +}, +"description": "Optional. If any of these SelectorSets are satisfied, the condition\nis met (OR logic).\nThe key is a user-provided name for this set.", +"type": "object" +} +}, +"type": "object" +}, +"GlobalVmExtensionPolicyInstalledSoftwareSelectorSelectorSet": { +"id": "GlobalVmExtensionPolicyInstalledSoftwareSelectorSelectorSet", +"properties": { +"allOfSelectors": { +"description": "Optional. All software in this list must be detected (AND logic).\nValid software names (e.g. \"Apache Web Server\").", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GlobalVmExtensionPolicyInstanceSelector": { "description": "Selector to target VMs for a zone VM extension policy.", "id": "GlobalVmExtensionPolicyInstanceSelector", @@ -74600,6 +75184,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -74608,18 +75193,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -74684,6 +75274,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -74692,18 +75283,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -75909,7 +76505,7 @@ false "type": "string" }, "sourceRegions": { -"description": "The list of cloud regions from which health checks are performed. If any\nregions are specified, then exactly 3 regions should be specified. The\nregion names must be valid names of Google Cloud regions.\nThis can only be set for global health check.\nIf this list is non-empty, then there are restrictions\non what other health check fields are supported and what other resources\ncan use this health check:\n \n - SSL, HTTP2, and GRPC protocols are not supported.\n - The TCP request field is not supported.\n - The proxyHeader field for HTTP, HTTPS, and TCP is not\n supported.\n - The checkIntervalSec field must be at least 30.\n - The health check cannot be used with BackendService nor with managed\n instance group auto-healing.", +"description": "The list of cloud regions from which health checks are performed. If any\nregions are specified, then exactly 3 regions should be specified. The\nregion names must be valid names of Google Cloud regions.\nThis can only be set for global health check.\nIf this list is non-empty, then there are restrictions\non what other health check fields are supported and what other resources\ncan use this health check:\n \n - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported.\n - The TCP request field is not supported.\n - The proxyHeader field for HTTP, HTTPS, and TCP is not\n supported.\n - The checkIntervalSec field must be at least 30.\n - The health check cannot be used with BackendService nor with managed\n instance group auto-healing.", "items": { "type": "string" }, @@ -75927,7 +76523,7 @@ false "type": "integer" }, "type": { -"description": "Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the\nprotocol-specific health check fields must be specified, which must matchtype field.", +"description": "Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS.\nExactly one of the protocol-specific health check fields must be specified,\nwhich must match type field.", "enum": [ "GRPC", "GRPC_WITH_TLS", @@ -77967,7 +78563,7 @@ false "type": "array" }, "kind": { -"default": "compute#host", +"default": "compute#hostList", "description": "The type of resource. Always compute#host for a list of hosts.", "type": "string" }, @@ -81695,6 +82291,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -81703,18 +82300,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -81761,6 +82363,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -81769,18 +82372,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -82097,6 +82705,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -82105,18 +82714,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -82191,6 +82805,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -82199,18 +82814,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -82417,6 +83037,7 @@ false "type": "array" }, "disruptionMode": { +"deprecated": true, "description": "Whether the boot disk is allowed to be updated with restart.", "enum": [ "LEGACY", @@ -82556,7 +83177,7 @@ false "id": "InstanceGroupManagersApplyUpdatesRequest", "properties": { "allInstances": { -"description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.", +"description": "Flag to update all instances instead of specified list of \"instances\".\nIf the flag is set to true then the instances may not be specified\nin the request.", "type": "boolean" }, "allowedActions": { @@ -82581,6 +83202,7 @@ false "type": "array" }, "disruptionMode": { +"deprecated": true, "description": "Whether the boot disk is allowed to be updated with restart.", "enum": [ "LEGACY", @@ -82852,6 +83474,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -82860,18 +83483,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -82910,7 +83538,7 @@ false "id": "InstanceGroupManagersListErrorsResponse", "properties": { "items": { -"description": "Output only. [Output Only] The list of errors of the managed instance group.", +"description": "Output only. The list of errors of the managed instance group.", "items": { "$ref": "InstanceManagedByIgmError" }, @@ -82918,7 +83546,7 @@ false "type": "array" }, "nextPageToken": { -"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"description": "Output only. This token allows you to get the next page of results for list requests.\nIf the number of results is larger than maxResults\n, then use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", "readOnly": true, "type": "string" } @@ -84397,6 +85025,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" @@ -90426,6 +91058,21 @@ false }, "type": "object" }, +"InterconnectsSetNameRequest": { +"description": "Request to rename an interconnect.", +"id": "InterconnectsSetNameRequest", +"properties": { +"currentName": { +"description": "The current name of the interconnect.\nThe name must be 1-63 characters long, and comply with RFC1035.", +"type": "string" +}, +"name": { +"description": "The new name of the interconnect.\nThe name must be 1-63 characters long, and comply with RFC1035.", +"type": "string" +} +}, +"type": "object" +}, "InternalIpAddress": { "id": "InternalIpAddress", "properties": { @@ -93375,6 +94022,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -93383,18 +94031,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -93511,6 +94164,197 @@ false }, "type": "object" }, +"ManagedRuleset": { +"description": "Represents a ManagedRuleset resource.\n\nManaged internally by Cloud Armor CLH for Managed Rules features.\nCustomers can only view these resources to modify their Security Policies.\nFor more information, see\nhttps://cloud.google.com/armor/docs/.", +"id": "ManagedRuleset", +"properties": { +"changeLog": { +"description": "Output only. [Output Only] The change log for this managed ruleset.", +"readOnly": true, +"type": "string" +}, +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp in RFC3339 text format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "[Output Only] An optional description of this resource.", +"type": "string" +}, +"id": { +"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"format": "uint64", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Name of the resource. Generated internally when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"ruleIds": { +"description": "Output only. [Output Only] The list of managed rule IDs that are included in\nthis managed ruleset.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"rulesetId": { +"description": "Output only. [Output Only] The managed ruleset identifier that can be configured in\nSecurity Policy rules.", +"readOnly": true, +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for the resource.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ManagedRulesetList": { +"id": "ManagedRulesetList", +"properties": { +"id": { +"type": "string" +}, +"items": { +"items": { +"$ref": "ManagedRuleset" +}, +"type": "array" +}, +"nextPageToken": { +"type": "string" +}, +"warning": { +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "ManagementInterface": { "description": "Represents a managed interface for an accelerator domain.\nIt defines the network endpoint and authentication configuration needed to\naccess specific management services like NMX-C or gNMI.", "id": "ManagementInterface", @@ -93551,15 +94395,17 @@ false "type": "string" }, "type": { -"description": "Required. The type of management service this interface provides.\nSupported types include NMX-C for partition management and gNMI for switch\nmonitoring.", +"description": "Required. The type of management service this interface provides.\nSupported types include NMX-C for partition management, gNMI for switch\nmonitoring, and TPU slice management.", "enum": [ "TYPE_NVLINK_PARTITION_MANAGEMENT", "TYPE_NVLINK_SWITCH_MONITORING", +"TYPE_TPU_SLICE_MANAGEMENT", "TYPE_UNSPECIFIED" ], "enumDescriptions": [ "", "", +"", "" ], "type": "string" @@ -94039,6 +94885,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -94047,18 +94894,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -97938,6 +98790,13 @@ false "description": "Represents a match condition that incoming traffic is evaluated against.\nExactly one field must be specified.", "id": "NetworkPolicyTrafficClassificationRuleMatcher", "properties": { +"destAddressGroups": { +"description": "Address groups which should be matched against the traffic destination.\nMaximum number of destination address groups is 10.\nExample:\nprojects//locations//addressGroups/.", +"items": { +"type": "string" +}, +"type": "array" +}, "destIpRanges": { "description": "CIDR IP address range.\nMaximum number of destination CIDR IP ranges allowed is 5000.", "items": { @@ -98109,7 +98968,7 @@ false "The global external address can only be assigned to Global External\nApplication or Proxy Load Balancer forwarding rules. This is the default\nvalue for global external addresses.", "DNS resolver address in the subnetwork.", "VM internal/alias IP, Internal LB service IP, etc.", -"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment\u2019s IP address range.", +"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment's IP address range.", "External IP automatically reserved for Cloud NAT.", "The global external address can only be assigned to Global External\nPassthrough Network Load Balancer forwarding rules, as an Availability\nGroup 0 address.", "The global external address can only be assigned to Global External\nPassthrough Network Load Balancer forwarding rules, as an Availability\nGroup 1 address.", @@ -101731,6 +102590,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -101739,18 +102599,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -101773,6 +102638,11 @@ false }, "type": "object" }, +"firewallPolicyRuleOperationMetadata": { +"$ref": "FirewallPolicyRuleOperationMetadata", +"description": "Output only. [Output Only] Metadata containing the allocated priority from the\nnetworkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule\nmethods if not explicitly provided by the user.", +"readOnly": true +}, "getVersionOperationMetadata": { "$ref": "GetVersionOperationMetadata" }, @@ -101851,9 +102721,9 @@ false "RUNNING" ], "enumDescriptions": [ -"", -"", -"" +"The operation has completed processing successfully or with an error.", +"The operation is waiting to be processed.", +"The operation is actively being processed." ], "type": "string" }, @@ -104612,7 +105482,7 @@ false "properties": { "project": { "$ref": "Project", -"description": "The project data." +"description": "The project data.\nThe returned Project data does not contain regional or zonal quota\nusage data. Global quota limits are present. For accurate, real-time quota\nusage numbers, query the global\n[projects.get](https://cloud.google.com/compute/docs/reference/rest/v1/projects/get)\nendpoint." } }, "type": "object" @@ -106110,6 +106980,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -106118,18 +106989,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -108906,7 +109782,7 @@ false "id": "RegionInstanceGroupManagersApplyUpdatesRequest", "properties": { "allInstances": { -"description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.", +"description": "Flag to update all instances instead of specified list of \"instances\".\nIf the flag is set to true then the instances may not be specified\nin the request.", "type": "boolean" }, "allowedActions": { @@ -108931,6 +109807,7 @@ false "type": "array" }, "disruptionMode": { +"deprecated": true, "description": "Whether the boot disk is allowed to be updated with restart.", "enum": [ "LEGACY", @@ -109950,6 +110827,7 @@ false "id": "ReliabilityRisksListResponse", "properties": { "etag": { +"description": "[Output Only] An ETag of the resource.", "type": "string" }, "id": { @@ -110973,6 +111851,242 @@ false }, "type": "object" }, +"ReservationConsumedInstance": { +"description": "ReservationConsumedInstance represents a consumed instance.", +"id": "ReservationConsumedInstance", +"properties": { +"instance": { +"description": "The full URI of the instance resource.", +"type": "string" +}, +"service": { +"description": "The service to which the instance belongs. Typically \"COMPUTE\".", +"type": "string" +}, +"status": { +"$ref": "ReservationConsumedInstanceStatus", +"description": "Output only. [Output Only] The status of the consumed instance.", +"readOnly": true +} +}, +"type": "object" +}, +"ReservationConsumedInstanceStatus": { +"description": "Status information for the instance's consumption of the reservation.", +"id": "ReservationConsumedInstanceStatus", +"properties": { +"linkageErrors": { +"description": "A list of issues related to this instance's linkage to the reservation.", +"properties": { +"errors": { +"description": "[Output Only] The array of errors encountered while processing this\noperation.", +"items": { +"description": "Represents a single error encountered during the processing of an\noperation.", +"properties": { +"code": { +"description": "[Output Only] The error type identifier for this error.", +"type": "string" +}, +"errorDetails": { +"description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", +"items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", +"properties": { +"errorInfo": { +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." +}, +"help": { +"$ref": "Help", +"description": "Links and information to help the user resolve the error." +}, +"localizedMessage": { +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." +}, +"quotaInfo": { +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." +} +}, +"type": "object" +}, +"type": "array" +}, +"location": { +"description": "[Output Only] Indicates the field in the request that caused the error.\nThis property is optional.", +"type": "string" +}, +"message": { +"description": "[Output Only] An optional, human-readable error message.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"ReservationConsumedInstancesListResponse": { +"description": "Response message for listing reservation consumed instances.", +"id": "ReservationConsumedInstancesListResponse", +"properties": { +"id": { +"description": "Uniquely identifies the type of this resource.", +"type": "string" +}, +"items": { +"description": "A list of ReservationConsumedInstance resources.", +"items": { +"$ref": "ReservationConsumedInstance" +}, +"type": "array" +}, +"kind": { +"description": "Identifies the resource as a list of reservation consumed instances.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"warning": { +"description": "[Output Only] Informational warning which replaces the result in some\ncases.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "ReservationList": { "id": "ReservationList", "properties": { @@ -113377,6 +114491,14 @@ false "description": "Output only. The IDs of the accelerator topologies the instance belongs to. For\nexample\nThe key will be topologies like \"4x4\", \"2x2x2\" and the value will be\nthe location ID of the topologies.", "readOnly": true, "type": "object" +}, +"networkTopologyIds": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. Key-value store for arbitrary network topology identifiers\ndefined by the underlying infrastructure.\nThe key will be the topology label and the value will be the location\nID for the topology.", +"readOnly": true, +"type": "object" } }, "type": "object" @@ -117467,6 +118589,10 @@ false "format": "int64", "type": "string" }, +"exposeHostTopology": { +"description": "This optional flag exposes the hashed physical host ID in the\nResourceStatus resource of the VM.", +"type": "boolean" +}, "gracefulShutdown": { "$ref": "SchedulingGracefulShutdown" }, @@ -117557,7 +118683,7 @@ false }, "preemptionNoticeDuration": { "$ref": "Duration", -"description": "Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft\n Off signal is triggered for Spot\n VMs only. If not specified, there will be no wait before the G2 Soft\n Off signal is triggered." +"description": "Specifies the Metadata Service preemption notice duration before the GCE ACPI G2\nSoft Off signal is triggered for Spot VMs only. If not specified,\nthere will be no wait before the G2 Soft Off signal is triggered." }, "provisioningModel": { "description": "Specifies the provisioning model of the instance.", @@ -123195,8 +124321,7 @@ false }, "exapoolProvisionedCapacityGb": { "$ref": "StoragePoolExapoolProvisionedCapacityGb", -"description": "Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB", -"readOnly": true +"description": "Provisioned capacities for each SKU for this Exapool in GiB" }, "id": { "description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", @@ -132056,6 +133181,10 @@ false "description": "Configuration for a specific VM extension.", "id": "VmExtensionPolicyExtensionPolicy", "properties": { +"installedSoftwareSelector": { +"$ref": "VmExtensionPolicyInstalledSoftwareSelector", +"description": "Optional. Only deploy this extension if the specified software is detected on the\nVM. For a live list of valid software values, see:\nhttps://cloud.google.com/compute/docs/vm-extensions/supported-software" +}, "pinnedVersion": { "description": "Optional. The specific version of the extension to install. If not set, the latest\nversion is used.", "type": "string" @@ -132067,6 +133196,33 @@ false }, "type": "object" }, +"VmExtensionPolicyInstalledSoftwareSelector": { +"description": "Defines the software requirements for a VM extension policy.", +"id": "VmExtensionPolicyInstalledSoftwareSelector", +"properties": { +"anyOfSelectors": { +"additionalProperties": { +"$ref": "VmExtensionPolicyInstalledSoftwareSelectorSelectorSet" +}, +"description": "Optional. If any of these SelectorSets are satisfied, the condition\nis met (OR logic).\nThe key is a user-provided name for this set.", +"type": "object" +} +}, +"type": "object" +}, +"VmExtensionPolicyInstalledSoftwareSelectorSelectorSet": { +"id": "VmExtensionPolicyInstalledSoftwareSelectorSelectorSet", +"properties": { +"allOfSelectors": { +"description": "Optional. All software in this list must be detected (AND logic).\nValid software names (e.g. \"Apache Web Server\").", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "VmExtensionPolicyInstanceSelector": { "description": "Defines how to select VMs to apply a zone VM extension policy.", "id": "VmExtensionPolicyInstanceSelector", diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 2e072ad053..2466beb4eb 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -29,6 +29,223 @@ "description": "Creates and runs virtual machines on Google Cloud Platform.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/compute/", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-west4.rep.googleapis.com/", +"location": "us-west4" +} +], "icons": { "x16": "https://www.google.com/images/icons/product/compute_engine-16.png", "x32": "https://www.google.com/images/icons/product/compute_engine-32.png" @@ -24615,7 +24832,7 @@ "projectViews": { "methods": { "get": { -"description": "Returns the specified global ProjectViews resource, with a regional\ncontext.", +"description": "Returns the specified global ProjectViews resource, with a regional\ncontext.\nThis regional API endpoint reads resource metadata from regional\nread-only replicas. Because changes are copied to these regional replicas\nasynchronously, for real-time resource reads or any write operations\n(creating, updating, or deleting resources), use the global\n[projects.get](https://cloud.google.com/compute/docs/reference/rest/v1/projects/get)\nendpoint.", "flatPath": "projects/{project}/regions/{region}/projectViews", "httpMethod": "GET", "id": "compute.projectViews.get", @@ -52760,7 +52977,7 @@ } } }, -"revision": "20260629", +"revision": "20260722", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -53487,7 +53704,7 @@ false "type": "string" }, "ipCollection": { -"description": "Reference to the source of IP addresses.\n\nIt supports the following cases:\n \n - \n Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4\n addresses. The PDP must support enhanced IPv4 allocations.\n - \n Case 2: Internal Range for global internal addresses.\n\n\n\nUse one of the following formats to specify the resource:\n\nFor a Public Delegated Prefix:\n \n - \n Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp\n - Partial URL:\n - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - regions/region/publicDelegatedPrefixes/pdp-name\n \n\n\nFor an Internal Range:\n \n - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range\n - Partial URL:projects/project/locations/global/internalRanges/internal-range", +"description": "Reference to the source of IP addresses.\n\nIt supports the following cases:\n \n - \n Case 1: PublicDelegatedPrefix (PDP) for BYOIP external\n addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4\n allocations. If an IPv6 PDP is used, the PDP must be in\n EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.\n - \n Case 2: Internal Range for global internal addresses.\n\n\n\nUse one of the following formats to specify the resource:\n\nFor a Public Delegated Prefix:\n \n - \n Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp\n - Partial URL:\n - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - regions/region/publicDelegatedPrefixes/pdp-name\n \n\n\nFor an Internal Range:\n \n - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range\n - Partial URL:projects/project/locations/global/internalRanges/internal-range", "type": "string" }, "ipVersion": { @@ -53570,7 +53787,7 @@ false "type": "integer" }, "purpose": { -"description": "The purpose of this resource, which can be one of the following values:\n \n \n - GCE_ENDPOINT for addresses that are used by VM\n instances, alias IP ranges, load balancers, and similar resources.\n - DNS_RESOLVER for a DNS resolver address in a subnetwork\n for a Cloud DNS inbound\n forwarder IP addresses (regional internal IP address in a subnet of\n a VPC network)\n - VPC_PEERING for global internal IP addresses used for\n \n private services access allocated ranges.\n - NAT_AUTO for the regional external IP addresses used by\n Cloud NAT when allocating addresses using\n \n automatic NAT IP address allocation.\n - IPSEC_INTERCONNECT for addresses created from a private\n IP range that are reserved for a VLAN attachment in an\n *HA VPN over Cloud Interconnect* configuration. These addresses\n are regional resources.\n - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned\n to multiple internal forwarding rules.\n - `PRIVATE_SERVICE_CONNECT` for a private network address that is\n used to configure Private Service Connect. Only global internal addresses\n can use this purpose.", +"description": "The purpose of this resource, which can be one of the following values:\n \n \n - GCE_ENDPOINT for addresses that are used by VM\n instances, alias IP ranges, load balancers, and similar resources.\n - DNS_RESOLVER for a DNS resolver address in a subnetwork\n for a Cloud DNS inbound\n forwarder IP addresses (regional internal IP address in a subnet of\n a VPC network)\n - VPC_PEERING for global internal IP addresses used for\n \n private services access allocated ranges.\n - NAT_AUTO for the regional external IP addresses used by\n Cloud NAT when allocating addresses using\n \n automatic NAT IP address allocation.\n - IPSEC_INTERCONNECT for addresses created from a private\n IP range that are reserved for a VLAN attachment in an\n *HA VPN over Cloud Interconnect* configuration. These addresses\n are regional resources.\n - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned\n to multiple internal forwarding rules.\n - `PRIVATE_SERVICE_CONNECT` for a private network address that is\n used to configure Private Service Connect. Only global internal addresses\n can use this purpose.\n - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses\n that can only be assigned to global external Passthrough Network Load\n Balancer forwarding rules, as an Availability Group 0 address.\n - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that\n can only be assigned to global external Passthrough Network Load Balancer\n forwarding rules, as an Availability Group 1 address.", "enum": [ "DNS_RESOLVER", "GCE_ENDPOINT", @@ -53587,7 +53804,7 @@ false "enumDescriptions": [ "DNS resolver address in the subnetwork.", "VM internal/alias IP, Internal LB service IP, etc.", -"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment\u2019s IP address range.", +"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment's IP address range.", "External IP automatically reserved for Cloud NAT.", "The global external address can only be assigned to Global External\nPassthrough Network Load Balancer forwarding rules, as an Availability\nGroup 0 address.", "The global external address can only be assigned to Global External\nPassthrough Network Load Balancer forwarding rules, as an Availability\nGroup 1 address.", @@ -54632,6 +54849,7 @@ false "type": "string" }, "diskType": { +"description": "Specifies the disk type used for the boot disk or an additional data\ndisk. For valid disk type values, see \nSupported types for Hyperdisk volumes and\nPersistent Disk type variables.\n\nWhen creating a single instance, you must provide either the full or\npartial URL of the disk type. For example, the following values are\nvalid: \n \n \n - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType\n - projects/project/zones/zone/diskTypes/diskType\n - zones/zone/diskTypes/diskType\n\n\n\nWhen creating an instance template, instance flexibility policy, or when\ncreating or updating an all-instances configuration, you specify the\ndisk type without a URL, for example, hyperdisk-balanced.\n\nIf you omit this field for a disk, the default disk type depends on\nthe instance's machine series, as follows.\n \n \n - For first- and second-generation machine series like N1, N2, T2, and\n M1, the\n default disk type is Standard Persistent Disk\n (pd-standard).\n - For C3, C3D, and M3 the default is Balanced Persistent Disk\n (pd-balanced). \n - For other third-generation machine\n series like A3, H3, Z3, all\n fourth-generation types like C4, N4, M4, and newer machine series,\n the default is Hyperdisk Balanced\n (hyperdisk-balanced).\n\n\n\nThe disk type you specify must be compatible with the instance's machine\nseries. For a list of machine series that support Persistent Disk, see Machine\nseries support for Persistent Disk.\n\nFor a list of machine series that support Hyperdisk, seeMachine\nseries support for Hyperdisk.", "type": "string" }, "enableConfidentialCompute": { @@ -56953,7 +57171,7 @@ false "type": "array" }, "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 and the scope is global.", +"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" }, "sessionAffinity": { @@ -59632,6 +59850,7 @@ false "MEMORY_OPTIMIZED_X4_480_8T", "MEMORY_OPTIMIZED_X4_960_12T", "MEMORY_OPTIMIZED_X4_960_16T", +"NETWORK_OPTIMIZED_C4N", "STORAGE_OPTIMIZED_Z3", "TYPE_UNSPECIFIED" ], @@ -59674,6 +59893,7 @@ false "CUD bucket for X4 machine with 480 vCPUs and 8TB of memory.", "CUD bucket for X4 machine with 960 vCPUs and 12TB of memory.", "CUD bucket for X4 machine with 960 vCPUs and 16TB of memory.", +"CUD bucket for C4N (dual Diorite) machines.", "", "Note for internal users: When adding a new enum Type for v1, make sure\nto also add it in the comment for the `optional Type type` definition.\nThis ensures that the public documentation displays the new enum Type." ], @@ -61140,15 +61360,18 @@ false "type": "string" }, "rawKey": { -"description": "Specifies a 256-bit customer-supplied\nencryption key, encoded in RFC\n4648 base64 to either encrypt or decrypt this resource. You can\nprovide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rawKey\":\n\"SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=\"", +"deprecated": true, +"description": "[DEPRECATED] CSEK is no longer supported. Use CMEK instead.\nSpecifies a 256-bit customer-supplied\nencryption key, encoded in RFC\n4648 base64 to either encrypt or decrypt this resource. You can\nprovide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rawKey\":\n\"SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=\"", "type": "string" }, "rsaEncryptedKey": { -"description": "Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit\ncustomer-supplied encryption key to either encrypt or decrypt this\nresource. You can provide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rsaEncryptedKey\":\n\"ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH\nz0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD\nD6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==\"\n\nThe key must meet the following requirements before you can provide it to \nCompute Engine: \n \n 1. The key is wrapped using a RSA public key certificate provided by \n Google. \n 2. After being wrapped, the key must be encoded in RFC 4648 base64 \n encoding. \n\nGets the RSA public key certificate provided by Google at: \n\n\nhttps://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem", +"deprecated": true, +"description": "[DEPRECATED] CSEK is no longer supported. Use CMEK instead.\nSpecifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit\ncustomer-supplied encryption key to either encrypt or decrypt this\nresource. You can provide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rsaEncryptedKey\":\n\"ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH\nz0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD\nD6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==\"\n\nThe key must meet the following requirements before you can provide it to \nCompute Engine: \n \n 1. The key is wrapped using a RSA public key certificate provided by \n Google. \n 2. After being wrapped, the key must be encoded in RFC 4648 base64 \n encoding. \n\nGets the RSA public key certificate provided by Google at: \n\n\nhttps://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem", "type": "string" }, "sha256": { -"description": "[Output only] TheRFC\n4648 base64 encoded SHA-256 hash of the customer-supplied\nencryption key that protects this resource.", +"deprecated": true, +"description": "[DEPRECATED] CSEK is no longer supported. Use CMEK instead.\n[Output only] TheRFC\n4648 base64 encoded SHA-256 hash of the customer-supplied\nencryption key that protects this resource.", "type": "string" } }, @@ -68285,7 +68508,7 @@ false "type": "string" }, "sourceRegions": { -"description": "The list of cloud regions from which health checks are performed. If any\nregions are specified, then exactly 3 regions should be specified. The\nregion names must be valid names of Google Cloud regions.\nThis can only be set for global health check.\nIf this list is non-empty, then there are restrictions\non what other health check fields are supported and what other resources\ncan use this health check:\n \n - SSL, HTTP2, and GRPC protocols are not supported.\n - The TCP request field is not supported.\n - The proxyHeader field for HTTP, HTTPS, and TCP is not\n supported.\n - The checkIntervalSec field must be at least 30.\n - The health check cannot be used with BackendService nor with managed\n instance group auto-healing.", +"description": "The list of cloud regions from which health checks are performed. If any\nregions are specified, then exactly 3 regions should be specified. The\nregion names must be valid names of Google Cloud regions.\nThis can only be set for global health check.\nIf this list is non-empty, then there are restrictions\non what other health check fields are supported and what other resources\ncan use this health check:\n \n - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported.\n - The TCP request field is not supported.\n - The proxyHeader field for HTTP, HTTPS, and TCP is not\n supported.\n - The checkIntervalSec field must be at least 30.\n - The health check cannot be used with BackendService nor with managed\n instance group auto-healing.", "items": { "type": "string" }, @@ -68303,7 +68526,7 @@ false "type": "integer" }, "type": { -"description": "Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the\nprotocol-specific health check fields must be specified, which must matchtype field.", +"description": "Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS.\nExactly one of the protocol-specific health check fields must be specified,\nwhich must match type field.", "enum": [ "GRPC", "GRPC_WITH_TLS", @@ -70333,7 +70556,7 @@ false "type": "array" }, "kind": { -"default": "compute#host", +"default": "compute#hostList", "description": "The type of resource. Always compute#host for a list of hosts.", "type": "string" }, @@ -73746,6 +73969,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -73754,18 +73978,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -73806,6 +74035,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -73814,18 +74044,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -74140,6 +74375,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -74148,18 +74384,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -74234,6 +74475,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -74242,18 +74484,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -74583,7 +74830,7 @@ false "id": "InstanceGroupManagersApplyUpdatesRequest", "properties": { "allInstances": { -"description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.", +"description": "Flag to update all instances instead of specified list of \"instances\".\nIf the flag is set to true then the instances may not be specified\nin the request.", "type": "boolean" }, "allowedActions": { @@ -74842,6 +75089,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -74850,18 +75098,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -74900,7 +75153,7 @@ false "id": "InstanceGroupManagersListErrorsResponse", "properties": { "items": { -"description": "Output only. [Output Only] The list of errors of the managed instance group.", +"description": "Output only. The list of errors of the managed instance group.", "items": { "$ref": "InstanceManagedByIgmError" }, @@ -74908,7 +75161,7 @@ false "type": "array" }, "nextPageToken": { -"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"description": "Output only. This token allows you to get the next page of results for list requests.\nIf the number of results is larger than maxResults\n, then use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", "readOnly": true, "type": "string" } @@ -84104,6 +84357,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -84112,18 +84366,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -84691,6 +84950,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -84699,18 +84959,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -88648,7 +88913,7 @@ false "enumDescriptions": [ "DNS resolver address in the subnetwork.", "VM internal/alias IP, Internal LB service IP, etc.", -"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment\u2019s IP address range.", +"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment's IP address range.", "External IP automatically reserved for Cloud NAT.", "The global external address can only be assigned to Global External\nPassthrough Network Load Balancer forwarding rules, as an Availability\nGroup 0 address.", "The global external address can only be assigned to Global External\nPassthrough Network Load Balancer forwarding rules, as an Availability\nGroup 1 address.", @@ -92237,6 +92502,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -92245,18 +92511,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -92352,9 +92623,9 @@ false "RUNNING" ], "enumDescriptions": [ -"", -"", -"" +"The operation has completed processing successfully or with an error.", +"The operation is waiting to be processed.", +"The operation is actively being processed." ], "type": "string" }, @@ -94755,7 +95026,7 @@ false "properties": { "project": { "$ref": "Project", -"description": "The project data." +"description": "The project data.\nThe returned Project data does not contain regional or zonal quota\nusage data. Global quota limits are present. For accurate, real-time quota\nusage numbers, query the global\n[projects.get](https://cloud.google.com/compute/docs/reference/rest/v1/projects/get)\nendpoint." } }, "type": "object" @@ -94949,6 +95220,22 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"networkTier": { +"description": "Network tier to be used for this prefix. All child delegated prefixes will\ninherit this field. If this field is not specified, it defaults to the\nnetwork tier of the project that the PublicAdvertisedPrefix belongs to.", +"enum": [ +"FIXED_STANDARD", +"PREMIUM", +"STANDARD", +"STANDARD_OVERRIDES_FIXED_STANDARD" +], +"enumDescriptions": [ +"Public internet quality with fixed bandwidth.", +"High quality, Google-grade network tier, support for all networking\nproducts.", +"Public internet quality, only limited support for other networking\nproducts.", +"(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier\nis expired or not configured." +], +"type": "string" +}, "pdpScope": { "description": "Specifies how child public delegated prefix will be scoped. It could\nbe one of following values:\n \n \n - `REGIONAL`: The public delegated prefix is regional only. The\n provisioning will take a few minutes.\n - `GLOBAL`: The public delegated prefix is global only. The\n provisioning will take ~4 weeks.\n - `GLOBAL_AND_REGIONAL` [output only]: The public delegated prefixes is\n BYOIP V1 legacy prefix. This is output only value and no longer\n supported in BYOIP V2.", "enum": [ @@ -95291,6 +95578,22 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"networkTier": { +"description": "Network tier of the public delegated prefix. If populated, it must match\nthe network tier of the parent public advertised prefix. If not populated,\nit defaults to the network tier of the parent public advertised prefix.", +"enum": [ +"FIXED_STANDARD", +"PREMIUM", +"STANDARD", +"STANDARD_OVERRIDES_FIXED_STANDARD" +], +"enumDescriptions": [ +"Public internet quality with fixed bandwidth.", +"High quality, Google-grade network tier, support for all networking\nproducts.", +"Public internet quality, only limited support for other networking\nproducts.", +"(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier\nis expired or not configured." +], +"type": "string" +}, "parentPrefix": { "description": "The URL of parent prefix. Either PublicAdvertisedPrefix or\nPublicDelegatedPrefix.", "type": "string" @@ -97503,7 +97806,7 @@ false "id": "RegionInstanceGroupManagersApplyUpdatesRequest", "properties": { "allInstances": { -"description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.", +"description": "Flag to update all instances instead of specified list of \"instances\".\nIf the flag is set to true then the instances may not be specified\nin the request.", "type": "boolean" }, "allowedActions": { @@ -98503,6 +98806,7 @@ false "id": "ReliabilityRisksListResponse", "properties": { "etag": { +"description": "[Output Only] An ETag of the resource.", "type": "string" }, "id": { @@ -101659,6 +101963,14 @@ false "description": "Output only. The IDs of the accelerator topologies the instance belongs to. For\nexample\nThe key will be topologies like \"4x4\", \"2x2x2\" and the value will be\nthe location ID of the topologies.", "readOnly": true, "type": "object" +}, +"networkTopologyIds": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. Key-value store for arbitrary network topology identifiers\ndefined by the underlying infrastructure.\nThe key will be the topology label and the value will be the location\nID for the topology.", +"readOnly": true, +"type": "object" } }, "type": "object" @@ -101693,6 +102005,11 @@ false "format": "int32", "type": "integer" }, +"gracefulShutdownTimestamp": { +"description": "Output only. Specifies the timestamp, when the instance will start graceful shutdown\nprocess, in RFC3339 text format.", +"readOnly": true, +"type": "string" +}, "terminationTimestamp": { "description": "Time in future when the instance will be terminated inRFC3339 text format.", "type": "string" @@ -104423,6 +104740,11 @@ false "bfdStatus": { "$ref": "BfdStatus" }, +"depreferenced": { +"description": "Output only. [Output Only] Indicates whether the BGP peer is in a depreferenced state.", +"readOnly": true, +"type": "boolean" +}, "enableIpv4": { "description": "Output only. Enable IPv4 traffic over BGP Peer.\nIt is enabled by default if the peerIpAddress is version 4.", "readOnly": true, @@ -105683,7 +106005,7 @@ false }, "preemptionNoticeDuration": { "$ref": "Duration", -"description": "Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft\n Off signal is triggered for Spot\n VMs only. If not specified, there will be no wait before the G2 Soft\n Off signal is triggered." +"description": "Specifies the Metadata Service preemption notice duration before the GCE ACPI G2\nSoft Off signal is triggered for Spot VMs only. If not specified,\nthere will be no wait before the G2 Soft Off signal is triggered." }, "provisioningModel": { "description": "Specifies the provisioning model of the instance.", @@ -111001,8 +111323,7 @@ false }, "exapoolProvisionedCapacityGb": { "$ref": "StoragePoolExapoolProvisionedCapacityGb", -"description": "Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB", -"readOnly": true +"description": "Provisioned capacities for each SKU for this Exapool in GiB" }, "id": { "description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", @@ -111091,6 +111412,10 @@ false "readOnly": true, "type": "string" }, +"shareSettings": { +"$ref": "StoragePoolShareSettings", +"description": "Share settings for the storage pool." +}, "state": { "description": "Output only. [Output Only] The status of storage pool creation.\n \n \n - CREATING: Storage pool is provisioning.\n storagePool.\n - FAILED: Storage pool creation failed.\n - READY: Storage pool is ready for use.\n - DELETING: Storage pool is deleting.", "enum": [ @@ -111835,6 +112160,31 @@ false }, "type": "object" }, +"StoragePoolShareSettings": { +"description": "Share settings for the storage pool.", +"id": "StoragePoolShareSettings", +"properties": { +"projectMap": { +"additionalProperties": { +"$ref": "StoragePoolShareSettingsProjectConfig" +}, +"description": "A map of project id and project config.", +"type": "object" +} +}, +"type": "object" +}, +"StoragePoolShareSettingsProjectConfig": { +"description": "Config for each project in the share settings.", +"id": "StoragePoolShareSettingsProjectConfig", +"properties": { +"projectId": { +"description": "The project ID, should be same as the key of this project config in the\nparent map.", +"type": "string" +} +}, +"type": "object" +}, "StoragePoolType": { "id": "StoragePoolType", "properties": { diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index 774b8ef7d7..39aa0c9b3d 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -29,6 +29,223 @@ "description": "Creates and runs virtual machines on Google Cloud Platform.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/compute/", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://compute.us-west4.rep.googleapis.com/", +"location": "us-west4" +} +], "icons": { "x16": "https://www.google.com/images/icons/product/compute_engine-16.png", "x32": "https://www.google.com/images/icons/product/compute_engine-32.png" @@ -7909,6 +8126,179 @@ } } }, +"hosts": { +"methods": { +"get": { +"description": "Retrieves information about the specified host.", +"flatPath": "projects/{project}/zones/{zone}/{association}/hosts/{host}", +"httpMethod": "GET", +"id": "compute.hosts.get", +"parameterOrder": [ +"project", +"zone", +"association", +"host" +], +"parameters": { +"association": { +"description": "The parent resource association for the Host. This field specifies the\nhierarchical context (e.g., reservation, block, sub-block) when\naccessing the host. For example, reservations/reservation_name,\nreservations/reservation_name/reservationBlocks/reservation_block_name or\nreservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name.", +"location": "path", +"required": true, +"type": "string" +}, +"host": { +"description": "The name of the host, formatted as RFC1035 or a resource ID\nnumber.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "The project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request, formatted as RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{association}/hosts/{host}", +"response": { +"$ref": "Host" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"getVersion": { +"description": "Allows customers to get SBOM versions of a host.", +"flatPath": "projects/{project}/zones/{zone}/{association}/hosts/{host}/getVersion", +"httpMethod": "POST", +"id": "compute.hosts.getVersion", +"parameterOrder": [ +"project", +"zone", +"association", +"host" +], +"parameters": { +"association": { +"description": "The parent resource association for the Host. This field specifies the\nhierarchical context (e.g., reservation, block, sub-block) when\naccessing the host.", +"location": "path", +"required": true, +"type": "string" +}, +"host": { +"description": "The name of the host, formatted as RFC1035 or a resource ID\nnumber.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.", +"location": "query", +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{association}/hosts/{host}/getVersion", +"request": { +"$ref": "HostsGetVersionRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Retrieves a list of hosts.", +"flatPath": "projects/{project}/zones/{zone}/{association}/hosts", +"httpMethod": "GET", +"id": "compute.hosts.list", +"parameterOrder": [ +"project", +"zone", +"association" +], +"parameters": { +"association": { +"description": "The parent resource association for the Host. This field specifies the\nhierarchical context (e.g., reservation, block, sub-block) when\naccessing the host. For example, reservations/reservation_name,\nreservations/reservation_name/reservationBlocks/reservation_block_name or\nreservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name.", +"location": "path", +"required": true, +"type": "string" +}, +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "The project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "The name of the zone for this request, formatted as RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{association}/hosts", +"response": { +"$ref": "HostsListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, "httpHealthChecks": { "methods": { "delete": { @@ -11799,6 +12189,11 @@ "required": true, "type": "string" }, +"noGracefulShutdown": { +"description": "If set to true, Graceful Shutdown is skipped.", +"location": "query", +"type": "boolean" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -13682,6 +14077,11 @@ "required": true, "type": "string" }, +"noGracefulShutdown": { +"description": "If set to true, Graceful Shutdown is skipped.", +"location": "query", +"type": "boolean" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -35803,6 +36203,100 @@ } } }, +"reliabilityRisks": { +"methods": { +"get": { +"description": "Returns the specified ReliabilityRisk resource.", +"flatPath": "projects/{project}/global/reliabilityRisks/{reliabilityRisk}", +"httpMethod": "GET", +"id": "compute.reliabilityRisks.get", +"parameterOrder": [ +"project", +"reliabilityRisk" +], +"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" +}, +"reliabilityRisk": { +"description": "Name of the ReliabilityRisk resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/reliabilityRisks/{reliabilityRisk}", +"response": { +"$ref": "ReliabilityRisk" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"list": { +"description": "Retrieves the list of reliabilityRisks available in the specified project.", +"flatPath": "projects/{project}/global/reliabilityRisks", +"httpMethod": "GET", +"id": "compute.reliabilityRisks.list", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/global/reliabilityRisks", +"response": { +"$ref": "ReliabilityRisksListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, "reservationBlocks": { "methods": { "get": { @@ -48221,7 +48715,7 @@ } } }, -"revision": "20260629", +"revision": "20260722", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -48948,7 +49442,7 @@ false "type": "string" }, "ipCollection": { -"description": "Reference to the source of IP addresses.\n\nIt supports the following cases:\n \n - \n Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4\n addresses. The PDP must support enhanced IPv4 allocations.\n - \n Case 2: Internal Range for global internal addresses.\n\n\n\nUse one of the following formats to specify the resource:\n\nFor a Public Delegated Prefix:\n \n - \n Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp\n - Partial URL:\n - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - regions/region/publicDelegatedPrefixes/pdp-name\n \n\n\nFor an Internal Range:\n \n - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range\n - Partial URL:projects/project/locations/global/internalRanges/internal-range", +"description": "Reference to the source of IP addresses.\n\nIt supports the following cases:\n \n - \n Case 1: PublicDelegatedPrefix (PDP) for BYOIP external\n addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4\n allocations. If an IPv6 PDP is used, the PDP must be in\n EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.\n - \n Case 2: Internal Range for global internal addresses.\n\n\n\nUse one of the following formats to specify the resource:\n\nFor a Public Delegated Prefix:\n \n - \n Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp\n - Partial URL:\n - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - regions/region/publicDelegatedPrefixes/pdp-name\n \n\n\nFor an Internal Range:\n \n - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range\n - Partial URL:projects/project/locations/global/internalRanges/internal-range", "type": "string" }, "ipVersion": { @@ -49031,7 +49525,7 @@ false "type": "integer" }, "purpose": { -"description": "The purpose of this resource, which can be one of the following values:\n \n \n - GCE_ENDPOINT for addresses that are used by VM\n instances, alias IP ranges, load balancers, and similar resources.\n - DNS_RESOLVER for a DNS resolver address in a subnetwork\n for a Cloud DNS inbound\n forwarder IP addresses (regional internal IP address in a subnet of\n a VPC network)\n - VPC_PEERING for global internal IP addresses used for\n \n private services access allocated ranges.\n - NAT_AUTO for the regional external IP addresses used by\n Cloud NAT when allocating addresses using\n \n automatic NAT IP address allocation.\n - IPSEC_INTERCONNECT for addresses created from a private\n IP range that are reserved for a VLAN attachment in an\n *HA VPN over Cloud Interconnect* configuration. These addresses\n are regional resources.\n - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned\n to multiple internal forwarding rules.\n - `PRIVATE_SERVICE_CONNECT` for a private network address that is\n used to configure Private Service Connect. Only global internal addresses\n can use this purpose.", +"description": "The purpose of this resource, which can be one of the following values:\n \n \n - GCE_ENDPOINT for addresses that are used by VM\n instances, alias IP ranges, load balancers, and similar resources.\n - DNS_RESOLVER for a DNS resolver address in a subnetwork\n for a Cloud DNS inbound\n forwarder IP addresses (regional internal IP address in a subnet of\n a VPC network)\n - VPC_PEERING for global internal IP addresses used for\n \n private services access allocated ranges.\n - NAT_AUTO for the regional external IP addresses used by\n Cloud NAT when allocating addresses using\n \n automatic NAT IP address allocation.\n - IPSEC_INTERCONNECT for addresses created from a private\n IP range that are reserved for a VLAN attachment in an\n *HA VPN over Cloud Interconnect* configuration. These addresses\n are regional resources.\n - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned\n to multiple internal forwarding rules.\n - `PRIVATE_SERVICE_CONNECT` for a private network address that is\n used to configure Private Service Connect. Only global internal addresses\n can use this purpose.\n - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses\n that can only be assigned to global external Passthrough Network Load\n Balancer forwarding rules, as an Availability Group 0 address.\n - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that\n can only be assigned to global external Passthrough Network Load Balancer\n forwarding rules, as an Availability Group 1 address.", "enum": [ "DNS_RESOLVER", "GCE_ENDPOINT", @@ -49045,7 +49539,7 @@ false "enumDescriptions": [ "DNS resolver address in the subnetwork.", "VM internal/alias IP, Internal LB service IP, etc.", -"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment\u2019s IP address range.", +"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment's IP address range.", "External IP automatically reserved for Cloud NAT.", "A private network IP address that can be used to configure Private\nService Connect. This purpose can be specified only forGLOBAL addresses of Type INTERNAL", "A regional internal IP address range reserved for Serverless.", @@ -50046,6 +50540,7 @@ false "type": "string" }, "diskType": { +"description": "Specifies the disk type used for the boot disk or an additional data\ndisk. For valid disk type values, see \nSupported types for Hyperdisk volumes and\nPersistent Disk type variables.\n\nWhen creating a single instance, you must provide either the full or\npartial URL of the disk type. For example, the following values are\nvalid: \n \n \n - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType\n - projects/project/zones/zone/diskTypes/diskType\n - zones/zone/diskTypes/diskType\n\n\n\nWhen creating an instance template, instance flexibility policy, or when\ncreating or updating an all-instances configuration, you specify the\ndisk type without a URL, for example, hyperdisk-balanced.\n\nIf you omit this field for a disk, the default disk type depends on\nthe instance's machine series, as follows.\n \n \n - For first- and second-generation machine series like N1, N2, T2, and\n M1, the\n default disk type is Standard Persistent Disk\n (pd-standard).\n - For C3, C3D, and M3 the default is Balanced Persistent Disk\n (pd-balanced). \n - For other third-generation machine\n series like A3, H3, Z3, all\n fourth-generation types like C4, N4, M4, and newer machine series,\n the default is Hyperdisk Balanced\n (hyperdisk-balanced).\n\n\n\nThe disk type you specify must be compatible with the instance's machine\nseries. For a list of machine series that support Persistent Disk, see Machine\nseries support for Persistent Disk.\n\nFor a list of machine series that support Hyperdisk, seeMachine\nseries support for Hyperdisk.", "type": "string" }, "enableConfidentialCompute": { @@ -52321,7 +52816,7 @@ false "type": "array" }, "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 and the scope is global.", +"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" }, "sessionAffinity": { @@ -54533,6 +55028,7 @@ false "MEMORY_OPTIMIZED_X4_480_8T", "MEMORY_OPTIMIZED_X4_960_12T", "MEMORY_OPTIMIZED_X4_960_16T", +"NETWORK_OPTIMIZED_C4N", "STORAGE_OPTIMIZED_Z3", "TYPE_UNSPECIFIED" ], @@ -54575,6 +55071,7 @@ false "CUD bucket for X4 machine with 480 vCPUs and 8TB of memory.", "CUD bucket for X4 machine with 960 vCPUs and 12TB of memory.", "CUD bucket for X4 machine with 960 vCPUs and 16TB of memory.", +"CUD bucket for C4N (dual Diorite) machines.", "", "Note for internal users: When adding a new enum Type for v1, make sure\nto also add it in the comment for the `optional Type type` definition.\nThis ensures that the public documentation displays the new enum Type." ], @@ -56041,15 +56538,18 @@ false "type": "string" }, "rawKey": { -"description": "Specifies a 256-bit customer-supplied\nencryption key, encoded in RFC\n4648 base64 to either encrypt or decrypt this resource. You can\nprovide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rawKey\":\n\"SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=\"", +"deprecated": true, +"description": "[DEPRECATED] CSEK is no longer supported. Use CMEK instead.\nSpecifies a 256-bit customer-supplied\nencryption key, encoded in RFC\n4648 base64 to either encrypt or decrypt this resource. You can\nprovide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rawKey\":\n\"SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=\"", "type": "string" }, "rsaEncryptedKey": { -"description": "Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit\ncustomer-supplied encryption key to either encrypt or decrypt this\nresource. You can provide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rsaEncryptedKey\":\n\"ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH\nz0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD\nD6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==\"\n\nThe key must meet the following requirements before you can provide it to \nCompute Engine: \n \n 1. The key is wrapped using a RSA public key certificate provided by \n Google. \n 2. After being wrapped, the key must be encoded in RFC 4648 base64 \n encoding. \n\nGets the RSA public key certificate provided by Google at: \n\n\nhttps://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem", +"deprecated": true, +"description": "[DEPRECATED] CSEK is no longer supported. Use CMEK instead.\nSpecifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit\ncustomer-supplied encryption key to either encrypt or decrypt this\nresource. You can provide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rsaEncryptedKey\":\n\"ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH\nz0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD\nD6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==\"\n\nThe key must meet the following requirements before you can provide it to \nCompute Engine: \n \n 1. The key is wrapped using a RSA public key certificate provided by \n Google. \n 2. After being wrapped, the key must be encoded in RFC 4648 base64 \n encoding. \n\nGets the RSA public key certificate provided by Google at: \n\n\nhttps://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem", "type": "string" }, "sha256": { -"description": "[Output only] TheRFC\n4648 base64 encoded SHA-256 hash of the customer-supplied\nencryption key that protects this resource.", +"deprecated": true, +"description": "[DEPRECATED] CSEK is no longer supported. Use CMEK instead.\n[Output only] TheRFC\n4648 base64 encoded SHA-256 hash of the customer-supplied\nencryption key that protects this resource.", "type": "string" } }, @@ -62950,7 +63450,7 @@ false "type": "string" }, "sourceRegions": { -"description": "The list of cloud regions from which health checks are performed. If any\nregions are specified, then exactly 3 regions should be specified. The\nregion names must be valid names of Google Cloud regions.\nThis can only be set for global health check.\nIf this list is non-empty, then there are restrictions\non what other health check fields are supported and what other resources\ncan use this health check:\n \n - SSL, HTTP2, and GRPC protocols are not supported.\n - The TCP request field is not supported.\n - The proxyHeader field for HTTP, HTTPS, and TCP is not\n supported.\n - The checkIntervalSec field must be at least 30.\n - The health check cannot be used with BackendService nor with managed\n instance group auto-healing.", +"description": "The list of cloud regions from which health checks are performed. If any\nregions are specified, then exactly 3 regions should be specified. The\nregion names must be valid names of Google Cloud regions.\nThis can only be set for global health check.\nIf this list is non-empty, then there are restrictions\non what other health check fields are supported and what other resources\ncan use this health check:\n \n - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported.\n - The TCP request field is not supported.\n - The proxyHeader field for HTTP, HTTPS, and TCP is not\n supported.\n - The checkIntervalSec field must be at least 30.\n - The health check cannot be used with BackendService nor with managed\n instance group auto-healing.", "items": { "type": "string" }, @@ -62968,7 +63468,7 @@ false "type": "integer" }, "type": { -"description": "Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the\nprotocol-specific health check fields must be specified, which must matchtype field.", +"description": "Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS.\nExactly one of the protocol-specific health check fields must be specified,\nwhich must match type field.", "enum": [ "GRPC", "GRPC_WITH_TLS", @@ -64801,6 +65301,108 @@ false }, "type": "object" }, +"Host": { +"description": "Represents a host resource.", +"id": "Host", +"properties": { +"aliasLinks": { +"description": "Output only. All aliases for this resource.\ne.g.\nprojects/123/zones/us-centra1-a/reservation/r1/reservationBlock/b1/hosts/h1", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"creationTimestamp": { +"description": "Output only. The creation timestamp, formatted asRFC3339 text.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "An optional description of this resource.", +"type": "string" +}, +"id": { +"description": "Output only. The unique identifier for this resource. This identifier is\ndefined by the server.", +"format": "uint64", +"readOnly": true, +"type": "string" +}, +"kind": { +"default": "compute#host", +"description": "Output only. The type of resource. Alwayscompute#host for hosts.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The name of the host.", +"readOnly": true, +"type": "string" +}, +"selfLink": { +"description": "Output only. The self link of the host.", +"readOnly": true, +"type": "string" +}, +"selfLinkWithId": { +"description": "Output only. The self link with id of the host.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The state of the host.", +"enum": [ +"ACTIVE", +"CREATING", +"DELETING", +"STATE_UNSPECIFIED", +"UNAVAILABLE" +], +"enumDescriptions": [ +"The host has allocated all its resources.", +"The resources are being allocated for the host.", +"The host is currently being deleted.", +"", +"The host is currently unavailable." +], +"readOnly": true, +"type": "string" +}, +"status": { +"$ref": "HostStatus", +"description": "Output only. The status of the host", +"readOnly": true +}, +"zone": { +"description": "Output only. The zone in which the host resides.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"HostPhysicalTopology": { +"id": "HostPhysicalTopology", +"properties": { +"block": { +"description": "The unique identifier of the capacity block within the cluster.", +"type": "string" +}, +"cluster": { +"description": "The cluster name of the reservation sub-block.", +"type": "string" +}, +"host": { +"description": "The unique identifier of the capacity host within the capacity sub-block.", +"type": "string" +}, +"subBlock": { +"description": "The unique identifier of the capacity sub-block within the capacity\nblock.", +"type": "string" +} +}, +"type": "object" +}, "HostRule": { "description": "UrlMaps\nA host-matching rule for a URL. If matched, will use the namedPathMatcher to select the BackendService.", "id": "HostRule", @@ -64823,6 +65425,212 @@ false }, "type": "object" }, +"HostStatus": { +"id": "HostStatus", +"properties": { +"physicalTopology": { +"$ref": "HostPhysicalTopology", +"description": "Output only. The physical topology of the reservation sub-block, if\npresent", +"readOnly": true +}, +"runningInstances": { +"description": "Output only. The URIs of the instances currently running on this host.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"HostsGetVersionRequest": { +"id": "HostsGetVersionRequest", +"properties": { +"sbomSelections": { +"description": "The SBOM selection to return. Duplicate values in the list will be ignored.", +"items": { +"enum": [ +"SBOM_SELECTION_CURRENT", +"SBOM_SELECTION_TARGET", +"SBOM_SELECTION_UNSPECIFIED" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"HostsListResponse": { +"id": "HostsListResponse", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "The unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of host resources.", +"items": { +"$ref": "Host" +}, +"type": "array" +}, +"kind": { +"default": "compute#hostList", +"description": "The type of resource. Always compute#host for a list of hosts.", +"type": "string" +}, +"nextPageToken": { +"description": "This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "The server-defined URL for this resource.", +"type": "string" +}, +"unreachables": { +"description": "Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"type": "array" +}, +"warning": { +"description": "An informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "HttpFaultAbort": { "description": "Specification for how requests are aborted as part of fault injection.", "id": "HttpFaultAbort", @@ -66338,6 +67146,7 @@ false "enum": [ "DEPROVISIONING", "PENDING", +"PENDING_STOP", "PROVISIONING", "REPAIRING", "RUNNING", @@ -66351,6 +67160,7 @@ false "enumDescriptions": [ "The instance is halted and we are performing tear down tasks like network\ndeprogramming, releasing quota, IP, tearing down disks etc.", "For Flex Start provisioning instance is waiting for available capacity\nfrom Dynamic Workload Scheduler (DWS).", +"The instance is gracefully shutting down.", "Resources are being allocated for the instance.", "The instance is in repair.", "The instance is running.", @@ -67877,6 +68687,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -67885,18 +68696,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -67937,6 +68753,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -67945,18 +68762,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -68271,6 +69093,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -68279,18 +69102,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -68365,6 +69193,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -68373,18 +69202,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -68678,7 +69512,7 @@ false "id": "InstanceGroupManagersApplyUpdatesRequest", "properties": { "allInstances": { -"description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.", +"description": "Flag to update all instances instead of specified list of \"instances\".\nIf the flag is set to true then the instances may not be specified\nin the request.", "type": "boolean" }, "instances": { @@ -68772,7 +69606,7 @@ false "id": "InstanceGroupManagersListErrorsResponse", "properties": { "items": { -"description": "Output only. [Output Only] The list of errors of the managed instance group.", +"description": "Output only. The list of errors of the managed instance group.", "items": { "$ref": "InstanceManagedByIgmError" }, @@ -68780,7 +69614,7 @@ false "type": "array" }, "nextPageToken": { -"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"description": "Output only. This token allows you to get the next page of results for list requests.\nIf the number of results is larger than maxResults\n, then use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", "readOnly": true, "type": "string" } @@ -70775,6 +71609,7 @@ false "enum": [ "DEPROVISIONING", "PENDING", +"PENDING_STOP", "PROVISIONING", "REPAIRING", "RUNNING", @@ -70788,6 +71623,7 @@ false "enumDescriptions": [ "The instance is halted and we are performing tear down tasks like network\ndeprogramming, releasing quota, IP, tearing down disks etc.", "For Flex Start provisioning instance is waiting for available capacity\nfrom Dynamic Workload Scheduler (DWS).", +"The instance is gracefully shutting down.", "Resources are being allocated for the instance.", "The instance is in repair.", "The instance is running.", @@ -77527,6 +78363,7 @@ false "enum": [ "DEPROVISIONING", "PENDING", +"PENDING_STOP", "PROVISIONING", "REPAIRING", "RUNNING", @@ -77540,6 +78377,7 @@ false "enumDescriptions": [ "The instance is halted and we are performing tear down tasks like network\ndeprogramming, releasing quota, IP, tearing down disks etc.", "For Flex Start provisioning instance is waiting for available capacity\nfrom Dynamic Workload Scheduler (DWS).", +"The instance is gracefully shutting down.", "Resources are being allocated for the instance.", "The instance is in repair.", "The instance is running.", @@ -77635,6 +78473,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -77643,18 +78482,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -80788,7 +81632,7 @@ false "enumDescriptions": [ "DNS resolver address in the subnetwork.", "VM internal/alias IP, Internal LB service IP, etc.", -"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment\u2019s IP address range.", +"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment's IP address range.", "External IP automatically reserved for Cloud NAT.", "A private network IP address that can be used to configure Private\nService Connect. This purpose can be specified only forGLOBAL addresses of Type INTERNAL", "A regional internal IP address range reserved for Serverless.", @@ -84341,6 +85185,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this\noperation.", "items": { +"description": "Represents a single error encountered during the processing of an\noperation.", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", @@ -84349,18 +85194,23 @@ false "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context\nspecific to the encountered error code.", "properties": { "errorInfo": { -"$ref": "ErrorInfo" +"$ref": "ErrorInfo", +"description": "Error information containing structured domain, reason, and metadata." }, "help": { -"$ref": "Help" +"$ref": "Help", +"description": "Links and information to help the user resolve the error." }, "localizedMessage": { -"$ref": "LocalizedMessage" +"$ref": "LocalizedMessage", +"description": "A localized human-readable error message intended for end users." }, "quotaInfo": { -"$ref": "QuotaExceededInfo" +"$ref": "QuotaExceededInfo", +"description": "Details about quota limits and metrics when a quota is exceeded." } }, "type": "object" @@ -84456,9 +85306,9 @@ false "RUNNING" ], "enumDescriptions": [ -"", -"", -"" +"The operation has completed processing successfully or with an error.", +"The operation is waiting to be processed.", +"The operation is actively being processed." ], "type": "string" }, @@ -89267,7 +90117,7 @@ false "id": "RegionInstanceGroupManagersApplyUpdatesRequest", "properties": { "allInstances": { -"description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.", +"description": "Flag to update all instances instead of specified list of \"instances\".\nIf the flag is set to true then the instances may not be specified\nin the request.", "type": "boolean" }, "instances": { @@ -89981,185 +90831,398 @@ false }, "type": "object" }, -"RegionNetworkEndpointGroupsAttachEndpointsRequest": { -"id": "RegionNetworkEndpointGroupsAttachEndpointsRequest", -"properties": { -"networkEndpoints": { -"description": "The list of network endpoints to be attached.", -"items": { -"$ref": "NetworkEndpoint" -}, -"type": "array" -} -}, -"type": "object" -}, -"RegionNetworkEndpointGroupsDetachEndpointsRequest": { -"id": "RegionNetworkEndpointGroupsDetachEndpointsRequest", -"properties": { -"networkEndpoints": { -"description": "The list of network endpoints to be detached.", -"items": { -"$ref": "NetworkEndpoint" -}, -"type": "array" -} -}, -"type": "object" -}, -"RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse": { -"id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", -"properties": { -"firewallPolicys": { -"description": "Output only. [Output only] Effective firewalls from firewall policy. It applies to\nRegional Network Firewall Policies in the specified region, Global Network\nFirewall Policies and Hierachial Firewall Policies which are associated\nwith the network.", -"items": { -"$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" -}, -"readOnly": true, -"type": "array" -}, -"firewalls": { -"description": "Effective firewalls on the network.", -"items": { -"$ref": "Firewall" -}, -"type": "array" -} -}, -"type": "object" -}, -"RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { -"id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy", -"properties": { -"displayName": { -"description": "Output only. [Output Only] The display name of the firewall policy.", -"readOnly": true, -"type": "string" -}, -"name": { -"description": "Output only. [Output Only] The name of the firewall policy.", -"readOnly": true, -"type": "string" -}, -"packetMirroringRules": { -"description": "Output only. [Output only] The packet mirroring rules that apply to the network.", -"items": { -"$ref": "FirewallPolicyRule" -}, -"readOnly": true, -"type": "array" -}, -"priority": { -"description": "Output only. [Output only] Priority of firewall policy association. Not applicable for\ntype=HIERARCHY.", -"format": "int32", -"readOnly": true, -"type": "integer" -}, -"rules": { -"description": "Output only. [Output only] The rules that apply to the network.", -"items": { -"$ref": "FirewallPolicyRule" -}, -"readOnly": true, -"type": "array" -}, -"type": { -"description": "Output only. [Output Only] The type of the firewall policy. Can be one of HIERARCHY,\nNETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", -"enum": [ -"HIERARCHY", -"NETWORK", -"NETWORK_REGIONAL", -"SYSTEM_GLOBAL", -"SYSTEM_REGIONAL", -"UNSPECIFIED" -], -"enumDescriptions": [ -"", -"", -"", -"", -"", -"" -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"RegionSetLabelsRequest": { -"id": "RegionSetLabelsRequest", -"properties": { -"labelFingerprint": { -"description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by Compute\nEngine and changes after every request to modify or update labels. You must\nalways provide an up-to-date fingerprint hash in order to update or change\nlabels. Make a get() request to the resource to get the latest\nfingerprint.", -"format": "byte", -"type": "string" -}, -"labels": { -"additionalProperties": { -"type": "string" -}, -"description": "The labels to set for this resource.", -"type": "object" -} -}, -"type": "object" -}, -"RegionSetPolicyRequest": { -"id": "RegionSetPolicyRequest", -"properties": { -"bindings": { -"description": "Flatten Policy to create a backwacd compatible wire-format.\nDeprecated. Use 'policy' to specify bindings.", -"items": { -"$ref": "Binding" -}, -"type": "array" -}, -"etag": { -"description": "Flatten Policy to create a backward compatible wire-format.\nDeprecated. Use 'policy' to specify the etag.", -"format": "byte", -"type": "string" -}, -"policy": { -"$ref": "Policy", -"description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of\nthe policy is limited to a few 10s of KB. An empty policy is in general a\nvalid policy but certain services (like Projects) might reject them." -} -}, -"type": "object" -}, -"RegionSnapshotUpdateKmsKeyRequest": { -"id": "RegionSnapshotUpdateKmsKeyRequest", -"properties": { -"kmsKeyName": { -"description": "Optional. The new KMS key to replace the current one on the snapshot. If empty, the\nsnapshot will be re-encrypted using the primary version of the snapshot's\ncurrent KMS key.\n\nThe KMS key can be provided in the following formats:\n \n \n - projects/project_id/locations/region/keyRings/region/cryptoKeys/key", -"type": "string" -} -}, -"type": "object" -}, -"RegionTargetHttpsProxiesSetSslCertificatesRequest": { -"id": "RegionTargetHttpsProxiesSetSslCertificatesRequest", -"properties": { -"sslCertificates": { -"description": "New set of SslCertificate resources to associate\nwith this TargetHttpsProxy resource.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"RegionUrlMapsValidateRequest": { -"id": "RegionUrlMapsValidateRequest", -"properties": { -"resource": { -"$ref": "UrlMap", -"description": "Content of the UrlMap to be validated." -} -}, -"type": "object" -}, +"RegionNetworkEndpointGroupsAttachEndpointsRequest": { +"id": "RegionNetworkEndpointGroupsAttachEndpointsRequest", +"properties": { +"networkEndpoints": { +"description": "The list of network endpoints to be attached.", +"items": { +"$ref": "NetworkEndpoint" +}, +"type": "array" +} +}, +"type": "object" +}, +"RegionNetworkEndpointGroupsDetachEndpointsRequest": { +"id": "RegionNetworkEndpointGroupsDetachEndpointsRequest", +"properties": { +"networkEndpoints": { +"description": "The list of network endpoints to be detached.", +"items": { +"$ref": "NetworkEndpoint" +}, +"type": "array" +} +}, +"type": "object" +}, +"RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse": { +"id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", +"properties": { +"firewallPolicys": { +"description": "Output only. [Output only] Effective firewalls from firewall policy. It applies to\nRegional Network Firewall Policies in the specified region, Global Network\nFirewall Policies and Hierachial Firewall Policies which are associated\nwith the network.", +"items": { +"$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" +}, +"readOnly": true, +"type": "array" +}, +"firewalls": { +"description": "Effective firewalls on the network.", +"items": { +"$ref": "Firewall" +}, +"type": "array" +} +}, +"type": "object" +}, +"RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { +"id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy", +"properties": { +"displayName": { +"description": "Output only. [Output Only] The display name of the firewall policy.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. [Output Only] The name of the firewall policy.", +"readOnly": true, +"type": "string" +}, +"packetMirroringRules": { +"description": "Output only. [Output only] The packet mirroring rules that apply to the network.", +"items": { +"$ref": "FirewallPolicyRule" +}, +"readOnly": true, +"type": "array" +}, +"priority": { +"description": "Output only. [Output only] Priority of firewall policy association. Not applicable for\ntype=HIERARCHY.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"rules": { +"description": "Output only. [Output only] The rules that apply to the network.", +"items": { +"$ref": "FirewallPolicyRule" +}, +"readOnly": true, +"type": "array" +}, +"type": { +"description": "Output only. [Output Only] The type of the firewall policy. Can be one of HIERARCHY,\nNETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", +"enum": [ +"HIERARCHY", +"NETWORK", +"NETWORK_REGIONAL", +"SYSTEM_GLOBAL", +"SYSTEM_REGIONAL", +"UNSPECIFIED" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"RegionSetLabelsRequest": { +"id": "RegionSetLabelsRequest", +"properties": { +"labelFingerprint": { +"description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by Compute\nEngine and changes after every request to modify or update labels. You must\nalways provide an up-to-date fingerprint hash in order to update or change\nlabels. Make a get() request to the resource to get the latest\nfingerprint.", +"format": "byte", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "The labels to set for this resource.", +"type": "object" +} +}, +"type": "object" +}, +"RegionSetPolicyRequest": { +"id": "RegionSetPolicyRequest", +"properties": { +"bindings": { +"description": "Flatten Policy to create a backwacd compatible wire-format.\nDeprecated. Use 'policy' to specify bindings.", +"items": { +"$ref": "Binding" +}, +"type": "array" +}, +"etag": { +"description": "Flatten Policy to create a backward compatible wire-format.\nDeprecated. Use 'policy' to specify the etag.", +"format": "byte", +"type": "string" +}, +"policy": { +"$ref": "Policy", +"description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of\nthe policy is limited to a few 10s of KB. An empty policy is in general a\nvalid policy but certain services (like Projects) might reject them." +} +}, +"type": "object" +}, +"RegionSnapshotUpdateKmsKeyRequest": { +"id": "RegionSnapshotUpdateKmsKeyRequest", +"properties": { +"kmsKeyName": { +"description": "Optional. The new KMS key to replace the current one on the snapshot. If empty, the\nsnapshot will be re-encrypted using the primary version of the snapshot's\ncurrent KMS key.\n\nThe KMS key can be provided in the following formats:\n \n \n - projects/project_id/locations/region/keyRings/region/cryptoKeys/key", +"type": "string" +} +}, +"type": "object" +}, +"RegionTargetHttpsProxiesSetSslCertificatesRequest": { +"id": "RegionTargetHttpsProxiesSetSslCertificatesRequest", +"properties": { +"sslCertificates": { +"description": "New set of SslCertificate resources to associate\nwith this TargetHttpsProxy resource.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"RegionUrlMapsValidateRequest": { +"id": "RegionUrlMapsValidateRequest", +"properties": { +"resource": { +"$ref": "UrlMap", +"description": "Content of the UrlMap to be validated." +} +}, +"type": "object" +}, +"ReliabilityRisk": { +"description": "Represents a ReliabilityRisk resource.", +"id": "ReliabilityRisk", +"properties": { +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp in RFC3339\ntext format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "An optional textual description of the resource; provided when the\nresource is created.", +"type": "string" +}, +"details": { +"$ref": "RiskDetails", +"description": "[Output Only] Details of the reliability risk resource" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#reliabilityRisk", +"description": "Output only. [Output Only] Type of resource. Always compute#reliabilityRisk\nfor reliability risks.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Name of the resource. The name must be 1-63 characters long and\ncomply with RFC1035.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"recommendation": { +"$ref": "RiskRecommendation", +"description": "The recommendation to mitigate the risk." +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for the resource.", +"readOnly": true, +"type": "string" +}, +"selfLinkWithId": { +"description": "Output only. [Output Only] Server-defined URL for this resource with the resource id.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ReliabilityRisksListResponse": { +"description": "Response message for the List method of ReliabilityRisksService.", +"id": "ReliabilityRisksListResponse", +"properties": { +"etag": { +"description": "[Output Only] An ETag of the resource.", +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of ReliabilityRisk resources.", +"items": { +"$ref": "ReliabilityRisk" +}, +"type": "array" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "RequestMirrorPolicy": { "description": "A policy that specifies how requests intended for the route's backends\nare shadowed to a separate mirrored backend service. The load balancer\ndoesn't wait for responses from the shadow service. Before sending traffic\nto the shadow service, the host or authority header is suffixed with-shadow.", "id": "RequestMirrorPolicy", @@ -93024,6 +94087,11 @@ false "scheduling": { "$ref": "ResourceStatusScheduling" }, +"shutdownDetails": { +"$ref": "ResourceStatusShutdownDetails", +"description": "Output only. [Output Only] Details about the instance stopping state.", +"readOnly": true +}, "upcomingMaintenance": { "$ref": "UpcomingMaintenance", "readOnly": true @@ -93125,6 +94193,16 @@ false "description": "Output only. [Output Only] The full resource name of the reservation that this\ninstance is consuming from.", "readOnly": true, "type": "string" +}, +"consumedReservationBlock": { +"description": "Output only. [Output Only] The full resource name of the reservation block that this\ninstance is consuming from.", +"readOnly": true, +"type": "string" +}, +"consumedReservationSubBlock": { +"description": "Output only. [Output Only] The full resource name of the reservation sub-block that\nthis instance is consuming from.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -93136,6 +94214,146 @@ false "description": "Specifies the availability domain to place the instance in. The value\nmust be a number between 1 and the number of availability domains\nspecified in the spread placement policy attached to the instance.", "format": "int32", "type": "integer" +}, +"gracefulShutdownTimestamp": { +"description": "Output only. Specifies the timestamp, when the instance will start graceful shutdown\nprocess, in RFC3339 text format.", +"readOnly": true, +"type": "string" +}, +"terminationTimestamp": { +"description": "Time in future when the instance will be terminated inRFC3339 text format.", +"type": "string" +} +}, +"type": "object" +}, +"ResourceStatusShutdownDetails": { +"description": "Specifies if the instance is in `PENDING_STOP` state or there is a\nprogrammed stop scheduled.", +"id": "ResourceStatusShutdownDetails", +"properties": { +"maxDuration": { +"$ref": "Duration", +"description": "The duration for graceful shutdown. Only applicable when\n`stop_state=PENDING_STOP`." +}, +"requestTimestamp": { +"description": "Past timestamp indicating the beginning of current `stopState` in RFC3339 text format.", +"type": "string" +}, +"stopState": { +"description": "Current stopping state of the instance.", +"enum": [ +"PENDING_STOP", +"STOPPING" +], +"enumDescriptions": [ +"The instance is gracefully shutting down.", +"The instance is stopping." +], +"type": "string" +}, +"targetState": { +"description": "Target instance state.", +"enum": [ +"DELETED", +"STOPPED" +], +"enumDescriptions": [ +"The instance will be deleted.", +"The instance will be stopped." +], +"type": "string" +} +}, +"type": "object" +}, +"RiskDetails": { +"description": "Detailed insights and metrics about a detected reliability risk.", +"id": "RiskDetails", +"properties": { +"duration": { +"description": "The duration of the risk since it was detected.", +"format": "google-duration", +"type": "string" +}, +"globalDnsInsight": { +"$ref": "RiskDetailsGlobalDnsInsight", +"description": "Insight details for global DNS risk." +}, +"lastUpdateTimestamp": { +"description": "The last time the risk was updated.", +"format": "google-datetime", +"type": "string" +}, +"severity": { +"description": "The severity of the risk.", +"enum": [ +"CRITICAL", +"HIGH", +"LOW", +"MEDIUM", +"SEVERITY_UNSPECIFIED" +], +"enumDescriptions": [ +"Critical severity.", +"High severity.", +"Low severity.", +"Medium severity.", +"No severity specified. The default value." +], +"type": "string" +}, +"type": { +"description": "The type of risk.", +"enum": [ +"GLOBAL_DNS", +"RISK_TYPE_UNSPECIFIED" +], +"enumDescriptions": [ +"Risk type related to global DNS.", +"Default value. This value is unused." +], +"type": "string" +} +}, +"type": "object" +}, +"RiskDetailsGlobalDnsInsight": { +"description": "Detailed insights for a global DNS reliability risk.", +"id": "RiskDetailsGlobalDnsInsight", +"properties": { +"projectDefaultIsGlobalDns": { +"description": "Indicates whether the project's default DNS setting is global DNS.", +"type": "boolean" +}, +"queryObservationWindow": { +"description": "The observation window for the query counts.", +"format": "google-duration", +"type": "string" +}, +"riskyQueryCount": { +"description": "The number of queries that are risky. This is always less than or\nequal to total_query_count.", +"format": "int64", +"type": "string" +}, +"totalQueryCount": { +"description": "The total number of queries in the observation window.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"RiskRecommendation": { +"description": "Recommendation for mitigating a reliability risk, including a reference URL.", +"id": "RiskRecommendation", +"properties": { +"content": { +"description": "Mitigation guide for the risk.", +"type": "string" +}, +"referenceUrl": { +"description": "URL referencing a more detailed mitigation guide.", +"type": "string" } }, "type": "object" @@ -96888,6 +98106,9 @@ false "format": "int32", "type": "integer" }, +"gracefulShutdown": { +"$ref": "SchedulingGracefulShutdown" +}, "hostErrorTimeoutSeconds": { "description": "Specify the time in seconds for host error detection, the value must be\nwithin the range of [90, 330] with the increment of 30, if unset, the\ndefault behavior of host error recovery will be used.", "format": "int32", @@ -96950,6 +98171,10 @@ false "description": "Defines whether the instance is preemptible. This can only be set during\ninstance creation or while the instance isstopped and\ntherefore, in a `TERMINATED` state. SeeInstance Life\nCycle for more information on the possible instance states.", "type": "boolean" }, +"preemptionNoticeDuration": { +"$ref": "Duration", +"description": "Specifies the Metadata Service preemption notice duration before the GCE ACPI G2\nSoft Off signal is triggered for Spot VMs only. If not specified,\nthere will be no wait before the G2 Soft Off signal is triggered." +}, "provisioningModel": { "description": "Specifies the provisioning model of the instance.", "enum": [ @@ -96977,6 +98202,21 @@ false }, "type": "object" }, +"SchedulingGracefulShutdown": { +"description": "The configuration for gracefully shutting down the instance.", +"id": "SchedulingGracefulShutdown", +"properties": { +"enabled": { +"description": "Opts-in for graceful shutdown.", +"type": "boolean" +}, +"maxDuration": { +"$ref": "Duration", +"description": "The time allotted for the instance to gracefully shut down. If the\ngraceful shutdown isn't complete after this time, then the instance\ntransitions to the STOPPING state." +} +}, +"type": "object" +}, "SchedulingNodeAffinity": { "description": "Node Affinity: the configuration of desired nodes onto which this Instance\n could be scheduled.", "id": "SchedulingNodeAffinity", @@ -101533,8 +102773,7 @@ false }, "exapoolProvisionedCapacityGb": { "$ref": "StoragePoolExapoolProvisionedCapacityGb", -"description": "Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB", -"readOnly": true +"description": "Provisioned capacities for each SKU for this Exapool in GiB" }, "id": { "description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", @@ -101623,6 +102862,10 @@ false "readOnly": true, "type": "string" }, +"shareSettings": { +"$ref": "StoragePoolShareSettings", +"description": "Share settings for the storage pool." +}, "state": { "description": "Output only. [Output Only] The status of storage pool creation.\n \n \n - CREATING: Storage pool is provisioning.\n storagePool.\n - FAILED: Storage pool creation failed.\n - READY: Storage pool is ready for use.\n - DELETING: Storage pool is deleting.", "enum": [ @@ -102367,6 +103610,31 @@ false }, "type": "object" }, +"StoragePoolShareSettings": { +"description": "Share settings for the storage pool.", +"id": "StoragePoolShareSettings", +"properties": { +"projectMap": { +"additionalProperties": { +"$ref": "StoragePoolShareSettingsProjectConfig" +}, +"description": "A map of project id and project config.", +"type": "object" +} +}, +"type": "object" +}, +"StoragePoolShareSettingsProjectConfig": { +"description": "Config for each project in the share settings.", +"id": "StoragePoolShareSettingsProjectConfig", +"properties": { +"projectId": { +"description": "The project ID, should be same as the key of this project config in the\nparent map.", +"type": "string" +} +}, +"type": "object" +}, "StoragePoolType": { "id": "StoragePoolType", "properties": { From b4624f3f948c7f5c4f4532ca28a69f1b7b608c96 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:02 +0000 Subject: [PATCH 32/84] feat(contactcenterinsights): update the api #### contactcenterinsights:v1 The following keys were added: - resources.projects.resources.locations.resources.assistantSessions.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.assistantSessions.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.assistantSessions.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.assistantSessions.methods.streamChat (Total Keys: 12) - schemas.GoogleCloudContactcenterinsightsV1AssistantChunk (Total Keys: 3) - schemas.GoogleCloudContactcenterinsightsV1AssistantMessage (Total Keys: 7) - schemas.GoogleCloudContactcenterinsightsV1AssistantSession (Total Keys: 16) - schemas.GoogleCloudContactcenterinsightsV1ListAssistantSessionsResponse (Total Keys: 5) - schemas.GoogleCloudContactcenterinsightsV1StreamChatRequest (Total Keys: 3) - schemas.GoogleCloudContactcenterinsightsV1StreamChatResponse (Total Keys: 7) --- ....projects.locations.assistantSessions.html | 283 +++++++++++++++++ ...tcenterinsights_v1.projects.locations.html | 5 + .../documents/contactcenterinsights.v1.json | 284 +++++++++++++++++- 3 files changed, 571 insertions(+), 1 deletion(-) create mode 100644 docs/dyn/contactcenterinsights_v1.projects.locations.assistantSessions.html diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.assistantSessions.html b/docs/dyn/contactcenterinsights_v1.projects.locations.assistantSessions.html new file mode 100644 index 0000000000..207b5ba082 --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.assistantSessions.html @@ -0,0 +1,283 @@ + + + +

Contact Center AI Insights API . projects . locations . assistantSessions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates an assistant session.

+

+ get(name, x__xgafv=None)

+

Gets an assistant session.

+

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

+

Lists assistant sessions.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Streams chat messages from the assistant.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, assistantSessionId=None, body=None, x__xgafv=None) +
Creates an assistant session.
+
+Args:
+  parent: string, Required. The parent resource where this assistant session will be created. Format: projects/{project}/locations/{location} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a conversation session with the Assistant Agent.
+  "createTime": "A String", # Output only. The time the session was created.
+  "displayName": "A String", # Optional. The display name of the session.
+  "messages": [ # Optional. History of messages in the session.
+    { # A message in an assistant session.
+      "chunks": [ # Required. Content of the message.
+        { # A chunk of data in an assistant message.
+          "text": "A String", # Optional. Text data.
+        },
+      ],
+      "eventTime": "A String", # Required. Timestamp when the message was sent or received.
+      "role": "A String", # Required. Role within the conversation.
+    },
+  ],
+  "name": "A String", # Identifier. Resource name of the session. Format: projects/{project}/locations/{location}/assistantSessions/{assistant_session}
+  "requester": "A String", # Output only. The user who initiated the session.
+  "state": "A String", # Output only. The status of the session.
+  "updateTime": "A String", # Output only. The time the session was last updated.
+}
+
+  assistantSessionId: string, Optional. The ID to use for the assistant session, which will become the final component of the assistant session's resource name. If not provided, a random UUID will be generated by the server. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a conversation session with the Assistant Agent.
+  "createTime": "A String", # Output only. The time the session was created.
+  "displayName": "A String", # Optional. The display name of the session.
+  "messages": [ # Optional. History of messages in the session.
+    { # A message in an assistant session.
+      "chunks": [ # Required. Content of the message.
+        { # A chunk of data in an assistant message.
+          "text": "A String", # Optional. Text data.
+        },
+      ],
+      "eventTime": "A String", # Required. Timestamp when the message was sent or received.
+      "role": "A String", # Required. Role within the conversation.
+    },
+  ],
+  "name": "A String", # Identifier. Resource name of the session. Format: projects/{project}/locations/{location}/assistantSessions/{assistant_session}
+  "requester": "A String", # Output only. The user who initiated the session.
+  "state": "A String", # Output only. The status of the session.
+  "updateTime": "A String", # Output only. The time the session was last updated.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets an assistant session.
+
+Args:
+  name: string, Required. The name of the assistant session to retrieve. Format: `projects/{project}/locations/{location}/assistantSessions/{assistant_session}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a conversation session with the Assistant Agent.
+  "createTime": "A String", # Output only. The time the session was created.
+  "displayName": "A String", # Optional. The display name of the session.
+  "messages": [ # Optional. History of messages in the session.
+    { # A message in an assistant session.
+      "chunks": [ # Required. Content of the message.
+        { # A chunk of data in an assistant message.
+          "text": "A String", # Optional. Text data.
+        },
+      ],
+      "eventTime": "A String", # Required. Timestamp when the message was sent or received.
+      "role": "A String", # Required. Role within the conversation.
+    },
+  ],
+  "name": "A String", # Identifier. Resource name of the session. Format: projects/{project}/locations/{location}/assistantSessions/{assistant_session}
+  "requester": "A String", # Output only. The user who initiated the session.
+  "state": "A String", # Output only. The status of the session.
+  "updateTime": "A String", # Output only. The time the session was last updated.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists assistant sessions.
+
+Args:
+  parent: string, Required. The parent resource, which owns this collection of assistant sessions. Format: `projects/{project}/locations/{location}` (required)
+  filter: string, Optional. A filter to reduce results to a specific subset.
+  pageSize: integer, Optional. The maximum number of assistant sessions to return in a single response. If unspecified, at most 100 assistant sessions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. A page token, received from a previous `ListAssistantSessions` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response to list assistant sessions.
+  "assistantSessions": [ # The assistant sessions.
+    { # Represents a conversation session with the Assistant Agent.
+      "createTime": "A String", # Output only. The time the session was created.
+      "displayName": "A String", # Optional. The display name of the session.
+      "messages": [ # Optional. History of messages in the session.
+        { # A message in an assistant session.
+          "chunks": [ # Required. Content of the message.
+            { # A chunk of data in an assistant message.
+              "text": "A String", # Optional. Text data.
+            },
+          ],
+          "eventTime": "A String", # Required. Timestamp when the message was sent or received.
+          "role": "A String", # Required. Role within the conversation.
+        },
+      ],
+      "name": "A String", # Identifier. Resource name of the session. Format: projects/{project}/locations/{location}/assistantSessions/{assistant_session}
+      "requester": "A String", # Output only. The user who initiated the session.
+      "state": "A String", # Output only. The status of the session.
+      "updateTime": "A String", # Output only. The time the session was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ streamChat(name, body=None, x__xgafv=None) +
Streams chat messages from the assistant.
+
+Args:
+  name: string, Required. The name of the assistant session to stream chat. Format: `projects/{project}/locations/{location}/assistantSessions/{assistant_session}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to stream chat.
+  "message": "A String", # Required. The message to send to the assistant.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response from streaming chat.
+  "chunk": { # A chunk of data in an assistant message. # A chunk of the assistant response message.
+    "text": "A String", # Optional. Text data.
+  },
+  "eventId": "A String", # The unique ID of the event.
+  "eventTime": "A String", # The time when the event occurred.
+  "statusMessage": "A String", # A status message.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html index 2699cad26b..e9835269a8 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html @@ -84,6 +84,11 @@

Instance Methods

Returns the assessmentRules Resource.

+

+ assistantSessions() +

+

Returns the assistantSessions Resource.

+

authorizedViewSets()

diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index 72b7e71d19..1acc6960a5 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -800,6 +800,137 @@ } } }, +"assistantSessions": { +"methods": { +"create": { +"description": "Creates an assistant session.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/assistantSessions", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.assistantSessions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"assistantSessionId": { +"description": "Optional. The ID to use for the assistant session, which will become the final component of the assistant session's resource name. If not provided, a random UUID will be generated by the server. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where this assistant session will be created. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/assistantSessions", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1AssistantSession" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1AssistantSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an assistant session.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/assistantSessions/{assistantSessionsId}", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.assistantSessions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the assistant session to retrieve. Format: `projects/{project}/locations/{location}/assistantSessions/{assistant_session}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/assistantSessions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1AssistantSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists assistant sessions.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/assistantSessions", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.assistantSessions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter to reduce results to a specific subset.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of assistant sessions to return in a single response. If unspecified, at most 100 assistant sessions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListAssistantSessions` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource, which owns this collection of assistant sessions. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/assistantSessions", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1ListAssistantSessionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"streamChat": { +"description": "Streams chat messages from the assistant.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/assistantSessions/{assistantSessionsId}:streamChat", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.assistantSessions.streamChat", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the assistant session to stream chat. Format: `projects/{project}/locations/{location}/assistantSessions/{assistant_session}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/assistantSessions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:streamChat", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1StreamChatRequest" +}, +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1StreamChatResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "authorizedViewSets": { "methods": { "create": { @@ -6101,7 +6232,7 @@ } } }, -"revision": "20260623", +"revision": "20260727", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudCesV1mainAgentTransfer": { @@ -6826,6 +6957,104 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1AssistantChunk": { +"description": "A chunk of data in an assistant message.", +"id": "GoogleCloudContactcenterinsightsV1AssistantChunk", +"properties": { +"text": { +"description": "Optional. Text data.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AssistantMessage": { +"description": "A message in an assistant session.", +"id": "GoogleCloudContactcenterinsightsV1AssistantMessage", +"properties": { +"chunks": { +"description": "Required. Content of the message.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1AssistantChunk" +}, +"type": "array" +}, +"eventTime": { +"description": "Required. Timestamp when the message was sent or received.", +"format": "google-datetime", +"type": "string" +}, +"role": { +"description": "Required. Role within the conversation.", +"enum": [ +"ROLE_UNSPECIFIED", +"USER", +"MODEL" +], +"enumDescriptions": [ +"Default value for unspecified.", +"The user role.", +"The model role." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1AssistantSession": { +"description": "Represents a conversation session with the Assistant Agent.", +"id": "GoogleCloudContactcenterinsightsV1AssistantSession", +"properties": { +"createTime": { +"description": "Output only. The time the session was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Optional. The display name of the session.", +"type": "string" +}, +"messages": { +"description": "Optional. History of messages in the session.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1AssistantMessage" +}, +"type": "array" +}, +"name": { +"description": "Identifier. Resource name of the session. Format: projects/{project}/locations/{location}/assistantSessions/{assistant_session}", +"type": "string" +}, +"requester": { +"description": "Output only. The user who initiated the session.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The status of the session.", +"enum": [ +"STATE_UNSPECIFIED", +"PROCESSING", +"IDLE" +], +"enumDescriptions": [ +"Unspecified state.", +"Agent is working.", +"Waiting for user input." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the session was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1AuthorizedView": { "description": "An AuthorizedView represents a view of accessible Insights resources (for example, Conversation and Scorecard). Who have read access to the AuthorizedView resource will have access to these Insight resources as well.", "id": "GoogleCloudContactcenterinsightsV1AuthorizedView", @@ -10745,6 +10974,24 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1ListAssistantSessionsResponse": { +"description": "Response to list assistant sessions.", +"id": "GoogleCloudContactcenterinsightsV1ListAssistantSessionsResponse", +"properties": { +"assistantSessions": { +"description": "The assistant sessions.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1AssistantSession" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse": { "description": "The response from a ListAuthorizedViewSet request.", "id": "GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse", @@ -12945,6 +13192,41 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1StreamChatRequest": { +"description": "Request to stream chat.", +"id": "GoogleCloudContactcenterinsightsV1StreamChatRequest", +"properties": { +"message": { +"description": "Required. The message to send to the assistant.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1StreamChatResponse": { +"description": "Response from streaming chat.", +"id": "GoogleCloudContactcenterinsightsV1StreamChatResponse", +"properties": { +"chunk": { +"$ref": "GoogleCloudContactcenterinsightsV1AssistantChunk", +"description": "A chunk of the assistant response message." +}, +"eventId": { +"description": "The unique ID of the event.", +"type": "string" +}, +"eventTime": { +"description": "The time when the event occurred.", +"format": "google-datetime", +"type": "string" +}, +"statusMessage": { +"description": "A status message.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleRequest": { "description": "The request message for testing auto labeling rules.", "id": "GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleRequest", From 82b9bb74f0d8797c0642e4ef7eace33056979a80 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:03 +0000 Subject: [PATCH 33/84] feat(container): update the api #### container:v1 The following keys were added: - schemas.ReleaseChannelConfig.properties.customVersions (Total Keys: 3) #### container:v1beta1 The following keys were added: - schemas.ReleaseChannelConfig.properties.customVersions (Total Keys: 3) --- docs/dyn/container_v1.projects.locations.html | 3 +++ docs/dyn/container_v1.projects.zones.html | 3 +++ docs/dyn/container_v1beta1.projects.locations.html | 3 +++ docs/dyn/container_v1beta1.projects.zones.html | 3 +++ .../discovery_cache/documents/container.v1.json | 10 +++++++++- .../discovery_cache/documents/container.v1beta1.json | 10 +++++++++- 6 files changed, 30 insertions(+), 2 deletions(-) diff --git a/docs/dyn/container_v1.projects.locations.html b/docs/dyn/container_v1.projects.locations.html index 73a9dee9d9..e89abd2e17 100644 --- a/docs/dyn/container_v1.projects.locations.html +++ b/docs/dyn/container_v1.projects.locations.html @@ -116,6 +116,9 @@

Method Details

"channels": [ # List of release channel configurations. { # ReleaseChannelConfig exposes configuration for a release channel. "channel": "A String", # The release channel this configuration applies to. + "customVersions": [ # Output only. List of custom versions for the channel. + "A String", + ], "defaultVersion": "A String", # The default version for newly created clusters on the channel. "upgradeTargetVersion": "A String", # The auto upgrade target version for clusters on the channel. "validVersions": [ # List of valid versions for the channel. diff --git a/docs/dyn/container_v1.projects.zones.html b/docs/dyn/container_v1.projects.zones.html index ad1a4a8d63..fd689a911f 100644 --- a/docs/dyn/container_v1.projects.zones.html +++ b/docs/dyn/container_v1.projects.zones.html @@ -116,6 +116,9 @@

Method Details

"channels": [ # List of release channel configurations. { # ReleaseChannelConfig exposes configuration for a release channel. "channel": "A String", # The release channel this configuration applies to. + "customVersions": [ # Output only. List of custom versions for the channel. + "A String", + ], "defaultVersion": "A String", # The default version for newly created clusters on the channel. "upgradeTargetVersion": "A String", # The auto upgrade target version for clusters on the channel. "validVersions": [ # List of valid versions for the channel. diff --git a/docs/dyn/container_v1beta1.projects.locations.html b/docs/dyn/container_v1beta1.projects.locations.html index 14abb8a8af..4a85e35d20 100644 --- a/docs/dyn/container_v1beta1.projects.locations.html +++ b/docs/dyn/container_v1beta1.projects.locations.html @@ -125,6 +125,9 @@

Method Details

}, ], "channel": "A String", # The release channel this configuration applies to. + "customVersions": [ # Output only. List of custom versions for the channel. + "A String", + ], "defaultVersion": "A String", # The default version for newly created clusters on the channel. "upgradeTargetVersion": "A String", # The auto upgrade target version for clusters on the channel. "validVersions": [ # List of valid versions for the channel. diff --git a/docs/dyn/container_v1beta1.projects.zones.html b/docs/dyn/container_v1beta1.projects.zones.html index d0ff99b849..de255e2692 100644 --- a/docs/dyn/container_v1beta1.projects.zones.html +++ b/docs/dyn/container_v1beta1.projects.zones.html @@ -122,6 +122,9 @@

Method Details

}, ], "channel": "A String", # The release channel this configuration applies to. + "customVersions": [ # Output only. List of custom versions for the channel. + "A String", + ], "defaultVersion": "A String", # The default version for newly created clusters on the channel. "upgradeTargetVersion": "A String", # The auto upgrade target version for clusters on the channel. "validVersions": [ # List of valid versions for the channel. diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index 4d7cb2c7ee..f7b83ed486 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2811,7 +2811,7 @@ } } }, -"revision": "20260630", +"revision": "20260727", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -8756,6 +8756,14 @@ false ], "type": "string" }, +"customVersions": { +"description": "Output only. List of custom versions for the channel.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "defaultVersion": { "description": "The default version for newly created clusters on the channel.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 40bcf451c0..a4d7dfb582 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2837,7 +2837,7 @@ } } }, -"revision": "20260630", +"revision": "20260727", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -9251,6 +9251,14 @@ false ], "type": "string" }, +"customVersions": { +"description": "Output only. List of custom versions for the channel.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "defaultVersion": { "description": "The default version for newly created clusters on the channel.", "type": "string" From 8733f709c2a45e1639eef49a43a4df2204912e89 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:03 +0000 Subject: [PATCH 34/84] feat(databasecenter): update the api #### databasecenter:v1beta The following keys were added: - schemas.QueryDatabaseResourceGroupsRequest.properties.signalProductsFilters (Total Keys: 2) --- docs/dyn/databasecenter_v1beta.v1beta.html | 13 +++++++++++++ .../documents/databasecenter.v1beta.json | 9 ++++++++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/dyn/databasecenter_v1beta.v1beta.html b/docs/dyn/databasecenter_v1beta.v1beta.html index 58657b2e7f..80548ed444 100644 --- a/docs/dyn/databasecenter_v1beta.v1beta.html +++ b/docs/dyn/databasecenter_v1beta.v1beta.html @@ -321,6 +321,19 @@

Method Details

"signalType": "A String", # Optional. Represents the type of the Signal for which the filter is for. }, ], + "signalProductsFilters": [ # Optional. Filters based on signal and product. The filter list will be ORed across pairs and ANDed within a signal and products pair. + { # SignalProductsFilters represents a signal and list of supported products. + "products": [ # Optional. Product type of the resource. The version of the product will be ignored in filtering. + { # Product specification for databasecenter resources. + "engine": "A String", # Optional. The specific engine that the underlying database is running. + "minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc. + "type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc.. + "version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc. + }, + ], + "signalType": "A String", # Optional. The type of signal. + }, + ], "signalTypeGroups": [ # Optional. Groups of signal types that are requested. { # A group of signal types that specifies what the user is interested in. Used by QueryDatabaseResourceGroups API. Example: signal_type_group { name = "AVAILABILITY" types = [SIGNAL_TYPE_NO_PROMOTABLE_REPLICA] } "displayName": "A String", # Required. The display name of a signal group. diff --git a/googleapiclient/discovery_cache/documents/databasecenter.v1beta.json b/googleapiclient/discovery_cache/documents/databasecenter.v1beta.json index 07e69fe0e9..92373a2d3e 100644 --- a/googleapiclient/discovery_cache/documents/databasecenter.v1beta.json +++ b/googleapiclient/discovery_cache/documents/databasecenter.v1beta.json @@ -364,7 +364,7 @@ } } }, -"revision": "20260702", +"revision": "20260710", "rootUrl": "https://databasecenter.googleapis.com/", "schemas": { "AdditionalDetail": { @@ -2110,6 +2110,13 @@ false }, "type": "array" }, +"signalProductsFilters": { +"description": "Optional. Filters based on signal and product. The filter list will be ORed across pairs and ANDed within a signal and products pair.", +"items": { +"$ref": "SignalProductsFilters" +}, +"type": "array" +}, "signalTypeGroups": { "description": "Optional. Groups of signal types that are requested.", "items": { From f17433e1bce7b4b16434e8887550cbee37c2ed0b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:03 +0000 Subject: [PATCH 35/84] feat(datamanager): update the api #### datamanager:v1 The following keys were added: - resources.audienceMembers.methods.removeAll (Total Keys: 8) - schemas.AddressInfo.properties.addressLine.type (Total Keys: 1) - schemas.AddressInfo.properties.administrativeArea.type (Total Keys: 1) - schemas.AddressInfo.properties.city.type (Total Keys: 1) - schemas.AudienceMember.properties.googleUserIdData.$ref (Total Keys: 1) - schemas.AudienceMember.properties.partnerProvidedIdData.$ref (Total Keys: 1) - schemas.FieldWarning (Total Keys: 4) - schemas.GoogleUserIdData (Total Keys: 4) - schemas.IngestAdEventsRequest.properties.validateOnly.deprecated (Total Keys: 1) - schemas.IngestAudienceMembersResponse.properties.fieldWarnings (Total Keys: 2) - schemas.IngestAudienceMembersStatus.properties.googleUserIdDataIngestionStatus.$ref (Total Keys: 1) - schemas.IngestAudienceMembersStatus.properties.partnerProvidedIdDataIngestionStatus.$ref (Total Keys: 1) - schemas.IngestEventsResponse.properties.fieldWarnings (Total Keys: 2) - schemas.IngestGoogleUserIdDataStatus (Total Keys: 6) - schemas.IngestPartnerProvidedIdDataStatus (Total Keys: 6) - schemas.PartnerProvidedIdData (Total Keys: 4) - schemas.RemoveAllAudienceMembersRequest (Total Keys: 7) - schemas.RemoveAllAudienceMembersResponse (Total Keys: 3) - schemas.RemoveAllAudienceMembersStatus (Total Keys: 2) - schemas.RemoveAudienceMembersStatus.properties.googleUserIdDataRemovalStatus.$ref (Total Keys: 1) - schemas.RemoveAudienceMembersStatus.properties.partnerProvidedIdDataRemovalStatus.$ref (Total Keys: 1) - schemas.RemoveGoogleUserIdDataStatus (Total Keys: 6) - schemas.RemovePartnerProvidedIdDataStatus (Total Keys: 6) - schemas.RequestStatusPerDestination.properties.removeAllAudienceMembersStatus.$ref (Total Keys: 1) --- docs/dyn/datamanager_v1.adEvents.html | 11 +- docs/dyn/datamanager_v1.audienceMembers.html | 93 +++++- docs/dyn/datamanager_v1.events.html | 17 +- docs/dyn/datamanager_v1.requestStatus.html | 18 ++ .../documents/datamanager.v1.json | 276 +++++++++++++++++- 5 files changed, 400 insertions(+), 15 deletions(-) diff --git a/docs/dyn/datamanager_v1.adEvents.html b/docs/dyn/datamanager_v1.adEvents.html index e146fa661d..d63ce386c4 100644 --- a/docs/dyn/datamanager_v1.adEvents.html +++ b/docs/dyn/datamanager_v1.adEvents.html @@ -111,12 +111,12 @@

Method Details

"attributionHint": "A String", # Optional. The partner-assumed attribution status for this ad event. This acts only as a signal for how the partner assumed attribution played out, and does not force an end result in final reports. "campaignId": "A String", # Required. The ID of the associated campaign. "campaignName": "A String", # Required. The name of the associated campaign. - "deviceInfo": { # Information about the device being used (if any) when the event happened. # Optional. Information gathered about the device being used when the ad event happened. + "deviceInfo": { # Information about the device being used (if any) when the event happened. # Required. Information gathered about the device being used when the ad event happened. "brand": "A String", # Optional. The brand of the device. "browser": "A String", # Optional. The brand or type of the browser. "browserVersion": "A String", # Optional. The version of the browser. "category": "A String", # Optional. The category of device. For example, “desktop”, “tablet”, “mobile”, “smart TV”. - "ipAddress": "A String", # Optional. The IP address of the device for the given context. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details. + "ipAddress": "A String", # Optional. The IP address of the device for the given context. Required when used in an AdEvent. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details. "languageCode": "A String", # Optional. The language the device uses in ISO 639-1 format. "model": "A String", # Optional. The model of the device. "operatingSystem": "A String", # Optional. The operating system or platform of the device. @@ -136,7 +136,7 @@

Method Details

"platformString": "A String", # String value for platform. "platformType": "A String", # Enum value for platform type. "platformTypeString": "A String", # String value for platform type. - "regionCode": "A String", # Required. The ISO 3166-2 country plus subdivision. + "regionCode": "A String", # Optional. The ISO 3166-2 country plus subdivision. "source": "A String", # Required. The platform source of the ad, akin to the Google Analytics source. "targetingType": "A String", # Enum value for targeting type. "targetingTypeString": "A String", # String value for targeting type. @@ -145,6 +145,9 @@

Method Details

"userIdentifiers": [ # Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event. { # A single identifier for the user. "address": { # Address information for the user. # The known components of a user's address. Holds a grouping of identifiers that are matched all at once. + "addressLine": "A String", # Optional. The street and number of the user's address. Used only for Google Analytics. This field is hashed and possibly encrypted. Normalize the value before hashing: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "administrativeArea": "A String", # Optional. The administrative area (state/province) of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "city": "A String", # Optional. The city of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace "familyName": "A String", # Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "givenName": "A String", # Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "postalCode": "A String", # Required. The postal code of the user's address. @@ -167,7 +170,7 @@

Method Details

}, }, ], - "encryptionInfo": { # Encryption information for the data being ingested. # Optional. Information about encryption keys which are used to encrypt the data. + "encryptionInfo": { # Encryption information for the data being ingested. # Required. Information about encryption keys which are used to encrypt the data. "awsWrappedKeyInfo": { # A data encryption key wrapped by an AWS KMS key. # Amazon Web Services wrapped key information. "encryptedDek": "A String", # Required. The base64 encoded encrypted data encryption key. "kekUri": "A String", # Required. The URI of the AWS KMS key used to decrypt the DEK. Should be in the format of `arn:{partition}:kms:{region}:{account_id}:key/{key_id}` or `aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id}` diff --git a/docs/dyn/datamanager_v1.audienceMembers.html b/docs/dyn/datamanager_v1.audienceMembers.html index 66731eebaf..0b6dd1f9f3 100644 --- a/docs/dyn/datamanager_v1.audienceMembers.html +++ b/docs/dyn/datamanager_v1.audienceMembers.html @@ -83,6 +83,9 @@

Instance Methods

remove(body=None, x__xgafv=None)

Removes a list of AudienceMember resources from the provided Destination.

+

+ removeAll(body=None, x__xgafv=None)

+

Removes all audience members from the provided destinations.

Method Details

close() @@ -112,6 +115,9 @@

Method Details

"userIdentifiers": [ # Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event. { # A single identifier for the user. "address": { # Address information for the user. # The known components of a user's address. Holds a grouping of identifiers that are matched all at once. + "addressLine": "A String", # Optional. The street and number of the user's address. Used only for Google Analytics. This field is hashed and possibly encrypted. Normalize the value before hashing: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "administrativeArea": "A String", # Optional. The administrative area (state/province) of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "city": "A String", # Optional. The city of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace "familyName": "A String", # Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "givenName": "A String", # Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "postalCode": "A String", # Required. The postal code of the user's address. @@ -130,8 +136,13 @@

Method Details

"destinationReferences": [ # Optional. Defines which Destination to send the audience member to. "A String", ], + "googleUserIdData": { # Google user id data holding encrypted google user IDs. At least one google user ID is required. # Encrypted Google User IDs. + "googleUserIds": [ # Required. The list of encrypted google user IDs. + "A String", + ], + }, "mobileData": { # Mobile IDs for the audience. At least one mobile ID is required. # Data identifying the user's mobile devices. - "mobileIds": [ # Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 `mobileIds` can be provided in a single AudienceMember. + "mobileIds": [ # Required. The list of mobile device IDs (Android advertising ID, iOS IDFA for Customer Match user lists and Android advertising ID, iOS IDFA, Xbox or Microsoft ID, Amazon Fire TV ID, Roku ID, Generic Device ID for basic user lists). At most 10 `mobileIds` can be provided in a single AudienceMember. "A String", ], }, @@ -140,6 +151,11 @@

Method Details

"A String", ], }, + "partnerProvidedIdData": { # Partner-provided data holding the partner-provided identifiers. At least one partner-provided identifier is required. # Partner-provided identifiers. + "partnerProvidedIds": [ # Required. The list of partner-provided identifiers. + "A String", + ], + }, "ppidData": { # Publisher provided identifiers data holding the ppids. At least one ppid is required. This feature is only available to data partners. # Data related to publisher provided identifiers. This feature is only available to data partners. "ppids": [ # Required. The list of publisher provided identifiers for a user. "A String", @@ -149,6 +165,9 @@

Method Details

"userIdentifiers": [ # Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event. { # A single identifier for the user. "address": { # Address information for the user. # The known components of a user's address. Holds a grouping of identifiers that are matched all at once. + "addressLine": "A String", # Optional. The street and number of the user's address. Used only for Google Analytics. This field is hashed and possibly encrypted. Normalize the value before hashing: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "administrativeArea": "A String", # Optional. The administrative area (state/province) of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "city": "A String", # Optional. The city of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace "familyName": "A String", # Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "givenName": "A String", # Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "postalCode": "A String", # Required. The postal code of the user's address. @@ -222,6 +241,13 @@

Method Details

An object of the form: { # Response from the IngestAudienceMembersRequest. + "fieldWarnings": [ # Detailed row-level warnings with field paths. + { # Detailed row-level warning with field paths. + "description": "A String", # The detailed warning message describing the issue. + "field": "A String", # The field path that triggered the warning. Uses the same format as google.rpc.BadRequest.FieldViolation.field. + "reason": "A String", # The warning reason. + }, + ], "requestId": "A String", # The auto-generated ID of the request. }
@@ -249,6 +275,9 @@

Method Details

"userIdentifiers": [ # Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event. { # A single identifier for the user. "address": { # Address information for the user. # The known components of a user's address. Holds a grouping of identifiers that are matched all at once. + "addressLine": "A String", # Optional. The street and number of the user's address. Used only for Google Analytics. This field is hashed and possibly encrypted. Normalize the value before hashing: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "administrativeArea": "A String", # Optional. The administrative area (state/province) of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "city": "A String", # Optional. The city of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace "familyName": "A String", # Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "givenName": "A String", # Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "postalCode": "A String", # Required. The postal code of the user's address. @@ -267,8 +296,13 @@

Method Details

"destinationReferences": [ # Optional. Defines which Destination to send the audience member to. "A String", ], + "googleUserIdData": { # Google user id data holding encrypted google user IDs. At least one google user ID is required. # Encrypted Google User IDs. + "googleUserIds": [ # Required. The list of encrypted google user IDs. + "A String", + ], + }, "mobileData": { # Mobile IDs for the audience. At least one mobile ID is required. # Data identifying the user's mobile devices. - "mobileIds": [ # Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 `mobileIds` can be provided in a single AudienceMember. + "mobileIds": [ # Required. The list of mobile device IDs (Android advertising ID, iOS IDFA for Customer Match user lists and Android advertising ID, iOS IDFA, Xbox or Microsoft ID, Amazon Fire TV ID, Roku ID, Generic Device ID for basic user lists). At most 10 `mobileIds` can be provided in a single AudienceMember. "A String", ], }, @@ -277,6 +311,11 @@

Method Details

"A String", ], }, + "partnerProvidedIdData": { # Partner-provided data holding the partner-provided identifiers. At least one partner-provided identifier is required. # Partner-provided identifiers. + "partnerProvidedIds": [ # Required. The list of partner-provided identifiers. + "A String", + ], + }, "ppidData": { # Publisher provided identifiers data holding the ppids. At least one ppid is required. This feature is only available to data partners. # Data related to publisher provided identifiers. This feature is only available to data partners. "ppids": [ # Required. The list of publisher provided identifiers for a user. "A String", @@ -286,6 +325,9 @@

Method Details

"userIdentifiers": [ # Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event. { # A single identifier for the user. "address": { # Address information for the user. # The known components of a user's address. Holds a grouping of identifiers that are matched all at once. + "addressLine": "A String", # Optional. The street and number of the user's address. Used only for Google Analytics. This field is hashed and possibly encrypted. Normalize the value before hashing: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "administrativeArea": "A String", # Optional. The administrative area (state/province) of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "city": "A String", # Optional. The city of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace "familyName": "A String", # Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "givenName": "A String", # Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "postalCode": "A String", # Required. The postal code of the user's address. @@ -356,4 +398,51 @@

Method Details

}
+
+ removeAll(body=None, x__xgafv=None) +
Removes all audience members from the provided destinations.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to remove all users from an audience in the provided destinations. Returns a RemoveAllAudienceMembersResponse.
+  "destinations": [ # Required. The list of destinations to remove the users from.
+    { # The Google product you're sending data to. For example, a Google Ads account.
+      "linkedAccount": { # Represents a specific account. # Optional. An account that the calling user's `login_account` has access to, through an established account link. For example, a data partner's `login_account` might have access to a client's `linked_account`. The partner might use this field to send data from the `linked_account` to another `operating_account`.
+        "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
+        "accountType": "A String", # Required. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
+        "product": "A String", # Deprecated. Use `account_type` instead.
+      },
+      "loginAccount": { # Represents a specific account. # Optional. The account used to make this API call. To add or remove data from the `operating_account`, this `login_account` must have write access to the `operating_account`. For example, a manager account of the `operating_account`, or an account with an established link to the `operating_account`.
+        "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
+        "accountType": "A String", # Required. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
+        "product": "A String", # Deprecated. Use `account_type` instead.
+      },
+      "operatingAccount": { # Represents a specific account. # Required. The account to send the data to or remove the data from.
+        "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
+        "accountType": "A String", # Required. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
+        "product": "A String", # Deprecated. Use `account_type` instead.
+      },
+      "productDestinationId": "A String", # Required. The object within the product account to ingest into. For example, a Google Ads audience ID, a Display & Video 360 audience ID or a Google Ads conversion action ID.
+      "reference": "A String", # Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest.
+    },
+  ],
+  "removeAsOfTime": "A String", # Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time. The remove as of time must not be in the future.
+  "validateOnly": True or False, # Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response from the RemoveAllAudienceMembersRequest.
+  "requestId": "A String", # The auto-generated ID of the request.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/datamanager_v1.events.html b/docs/dyn/datamanager_v1.events.html index 2ccb3046e8..5cb0ca3e48 100644 --- a/docs/dyn/datamanager_v1.events.html +++ b/docs/dyn/datamanager_v1.events.html @@ -158,7 +158,7 @@

Method Details

"browser": "A String", # Optional. The brand or type of the browser. "browserVersion": "A String", # Optional. The version of the browser. "category": "A String", # Optional. The category of device. For example, “desktop”, “tablet”, “mobile”, “smart TV”. - "ipAddress": "A String", # Optional. The IP address of the device for the given context. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details. + "ipAddress": "A String", # Optional. The IP address of the device for the given context. Required when used in an AdEvent. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details. "languageCode": "A String", # Optional. The language the device uses in ISO 639-1 format. "model": "A String", # Optional. The model of the device. "operatingSystem": "A String", # Optional. The operating system or platform of the device. @@ -240,7 +240,7 @@

Method Details

"browser": "A String", # Optional. The brand or type of the browser. "browserVersion": "A String", # Optional. The version of the browser. "category": "A String", # Optional. The category of device. For example, “desktop”, “tablet”, “mobile”, “smart TV”. - "ipAddress": "A String", # Optional. The IP address of the device for the given context. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details. + "ipAddress": "A String", # Optional. The IP address of the device for the given context. Required when used in an AdEvent. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details. "languageCode": "A String", # Optional. The language the device uses in ISO 639-1 format. "model": "A String", # Optional. The model of the device. "operatingSystem": "A String", # Optional. The operating system or platform of the device. @@ -271,6 +271,9 @@

Method Details

"userIdentifiers": [ # Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event. { # A single identifier for the user. "address": { # Address information for the user. # The known components of a user's address. Holds a grouping of identifiers that are matched all at once. + "addressLine": "A String", # Optional. The street and number of the user's address. Used only for Google Analytics. This field is hashed and possibly encrypted. Normalize the value before hashing: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "administrativeArea": "A String", # Optional. The administrative area (state/province) of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "city": "A String", # Optional. The city of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace "familyName": "A String", # Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "givenName": "A String", # Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "postalCode": "A String", # Required. The postal code of the user's address. @@ -286,6 +289,9 @@

Method Details

"userIdentifiers": [ # Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event. { # A single identifier for the user. "address": { # Address information for the user. # The known components of a user's address. Holds a grouping of identifiers that are matched all at once. + "addressLine": "A String", # Optional. The street and number of the user's address. Used only for Google Analytics. This field is hashed and possibly encrypted. Normalize the value before hashing: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "administrativeArea": "A String", # Optional. The administrative area (state/province) of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace + "city": "A String", # Optional. The city of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace "familyName": "A String", # Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "givenName": "A String", # Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. "postalCode": "A String", # Required. The postal code of the user's address. @@ -321,6 +327,13 @@

Method Details

An object of the form: { # Response from the IngestEventsRequest. + "fieldWarnings": [ # Detailed row-level warnings with field paths. + { # Detailed row-level warning with field paths. + "description": "A String", # The detailed warning message describing the issue. + "field": "A String", # The field path that triggered the warning. Uses the same format as google.rpc.BadRequest.FieldViolation.field. + "reason": "A String", # The warning reason. + }, + ], "requestId": "A String", # The auto-generated ID of the request. } diff --git a/docs/dyn/datamanager_v1.requestStatus.html b/docs/dyn/datamanager_v1.requestStatus.html index 9fda58c8dd..8d7a85031b 100644 --- a/docs/dyn/datamanager_v1.requestStatus.html +++ b/docs/dyn/datamanager_v1.requestStatus.html @@ -114,6 +114,10 @@

Method Details

"recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. "uploadMatchRateRange": "A String", # The match rate range of the upload. }, + "googleUserIdDataIngestionStatus": { # The status of the google user id data ingestion to the destination containing stats related to the ingestion. # The status of the google user id data ingestion to the destination. + "googleUserIdCount": "A String", # The total count of google user ids sent in the upload request for the destination. Includes all google user ids in the request, regardless of whether they were successfully ingested or not. + "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. + }, "mobileDataIngestionStatus": { # The status of the mobile data ingestion to the destination containing stats related to the ingestion. # The status of the mobile data ingestion to the destination. "mobileIdCount": "A String", # The total count of mobile ids sent in the upload request for the destination. Includes all mobile ids in the request, regardless of whether they were successfully ingested or not. "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. @@ -122,6 +126,10 @@

Method Details

"pairIdCount": "A String", # The total count of pair ids sent in the upload request for the destination. Includes all pair ids in the request, regardless of whether they were successfully ingested or not. "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. }, + "partnerProvidedIdDataIngestionStatus": { # The status of the partner provided id data ingestion to the destination containing stats related to the ingestion. # The status of the partner provided id data ingestion to the destination. + "partnerProvidedIdCount": "A String", # The total count of partner provided ids sent in the upload request for the destination. Includes all partner provided ids in the request, regardless of whether they were successfully ingested or not. + "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. + }, "ppidDataIngestionStatus": { # The status of the ppid data ingestion to the destination containing stats related to the ingestion. # The status of the ppid data ingestion to the destination. "ppidCount": "A String", # The total count of ppids sent in the upload request for the destination. Includes all ppids in the request, regardless of whether they were successfully ingested or not. "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. @@ -146,6 +154,10 @@

Method Details

], "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. }, + "googleUserIdDataRemovalStatus": { # The status of the google user id data removal from the destination. # The status of the google user id data removal from the destination. + "googleUserIdCount": "A String", # The total count of google user ids sent in the removal request. Includes all google user ids in the request, regardless of whether they were successfully removed or not. + "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. + }, "mobileDataRemovalStatus": { # The status of the mobile data removal from the destination. # The status of the mobile data removal from the destination. "mobileIdCount": "A String", # The total count of mobile Ids sent in the removal request. Includes all mobile ids in the request, regardless of whether they were successfully removed or not. "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. @@ -154,6 +166,10 @@

Method Details

"pairIdCount": "A String", # The total count of pair ids sent in the removal request. Includes all pair ids in the request, regardless of whether they were successfully removed or not. "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. }, + "partnerProvidedIdDataRemovalStatus": { # The status of the partner provided id data removal from the destination. # The status of the partner provided id data removal from the destination. + "partnerProvidedIdCount": "A String", # The total count of partner provided ids sent in the removal request. Includes all partner provided ids in the request, regardless of whether they were successfully removed or not. + "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. + }, "ppidDataRemovalStatus": { # The status of the ppid data removal from the destination. # The status of the ppid data removal from the destination. "ppidCount": "A String", # The total count of ppids sent in the removal request. Includes all ppids in the request, regardless of whether they were successfully removed or not. "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. @@ -197,6 +213,8 @@

Method Details

"eventsIngestionStatus": { # The status of the events ingestion to the destination. # The status of the ingest events request. "recordCount": "A String", # The total count of events sent in the upload request. Includes all events in the request, regardless of whether they were successfully ingested or not. }, + "removeAllAudienceMembersStatus": { # The status of the remove all audience members request. # The status of the remove all audience members request. + }, "requestStatus": "A String", # The request status of the destination. "warningInfo": { # Warning counts for each type of warning. # A warning info containing the warning reason and warning counts related to the upload. This field isn't populated while the request has `request_status` of `PROCESSING`. "warningCounts": [ # A list of warnings and counts per warning reason. diff --git a/googleapiclient/discovery_cache/documents/datamanager.v1.json b/googleapiclient/discovery_cache/documents/datamanager.v1.json index 6a023ef5e5..0126b08a9a 100644 --- a/googleapiclient/discovery_cache/documents/datamanager.v1.json +++ b/googleapiclient/discovery_cache/documents/datamanager.v1.json @@ -791,6 +791,24 @@ "scopes": [ "https://www.googleapis.com/auth/datamanager" ] +}, +"removeAll": { +"description": "Removes all audience members from the provided destinations.", +"flatPath": "v1/audienceMembers:removeAll", +"httpMethod": "POST", +"id": "datamanager.audienceMembers.removeAll", +"parameterOrder": [], +"parameters": {}, +"path": "v1/audienceMembers:removeAll", +"request": { +"$ref": "RemoveAllAudienceMembersRequest" +}, +"response": { +"$ref": "RemoveAllAudienceMembersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] } } }, @@ -842,7 +860,7 @@ } } }, -"revision": "20260708", +"revision": "20260729", "rootUrl": "https://datamanager.googleapis.com/", "schemas": { "AdEvent": { @@ -1005,7 +1023,7 @@ }, "deviceInfo": { "$ref": "DeviceInfo", -"description": "Optional. Information gathered about the device being used when the ad event happened." +"description": "Required. Information gathered about the device being used when the ad event happened." }, "eventId": { "description": "Optional. An ID created and managed by the caller that uniquely identifies this event. Required if you want to deduplicate ad events that are included in multiple requests. Otherwise, this field is optional.", @@ -1104,7 +1122,7 @@ "type": "string" }, "regionCode": { -"description": "Required. The ISO 3166-2 country plus subdivision.", +"description": "Optional. The ISO 3166-2 country plus subdivision.", "type": "string" }, "source": { @@ -1211,6 +1229,18 @@ "description": "Address information for the user.", "id": "AddressInfo", "properties": { +"addressLine": { +"description": "Optional. The street and number of the user's address. Used only for Google Analytics. This field is hashed and possibly encrypted. Normalize the value before hashing: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace", +"type": "string" +}, +"administrativeArea": { +"description": "Optional. The administrative area (state/province) of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace", +"type": "string" +}, +"city": { +"description": "Optional. The city of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace", +"type": "string" +}, "familyName": { "description": "Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.", "type": "string" @@ -1249,6 +1279,10 @@ }, "type": "array" }, +"googleUserIdData": { +"$ref": "GoogleUserIdData", +"description": "Encrypted Google User IDs." +}, "mobileData": { "$ref": "MobileData", "description": "Data identifying the user's mobile devices." @@ -1257,6 +1291,10 @@ "$ref": "PairData", "description": "[Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908). This feature is only available to data partners." }, +"partnerProvidedIdData": { +"$ref": "PartnerProvidedIdData", +"description": "Partner-provided identifiers." +}, "ppidData": { "$ref": "PpidData", "description": "Data related to publisher provided identifiers. This feature is only available to data partners." @@ -1551,7 +1589,7 @@ "type": "string" }, "ipAddress": { -"description": "Optional. The IP address of the device for the given context. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details.", +"description": "Optional. The IP address of the device for the given context. Required when used in an AdEvent. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details.", "type": "string" }, "languageCode": { @@ -1982,6 +2020,59 @@ }, "type": "object" }, +"FieldWarning": { +"description": "Detailed row-level warning with field paths.", +"id": "FieldWarning", +"properties": { +"description": { +"description": "The detailed warning message describing the issue.", +"type": "string" +}, +"field": { +"description": "The field path that triggered the warning. Uses the same format as google.rpc.BadRequest.FieldViolation.field.", +"type": "string" +}, +"reason": { +"description": "The warning reason.", +"enum": [ +"WARNING_REASON_UNSPECIFIED", +"WARNING_REASON_CUSTOM_VARIABLE_NOT_ENABLED", +"WARNING_REASON_CUSTOM_VARIABLE_NOT_PREDEFINED", +"WARNING_REASON_CART_DATA_NOT_SUPPORTED_WITH_GBRAID_OR_WBRAID", +"WARNING_REASON_CART_DATA_ITEM_MERCHANT_PRODUCT_ID_MISSING", +"WARNING_REASON_CART_DATA_ITEM_UNIT_PRICE_MISSING", +"WARNING_REASON_GENERIC", +"WARNING_REASON_INVALID_CLIENT_ID", +"WARNING_REASON_INVALID_SUBDIVISION_CODE", +"WARNING_REASON_INVALID_REGION_CODE", +"WARNING_REASON_INVALID_SUBCONTINENT_CODE", +"WARNING_REASON_INVALID_CONTINENT_CODE", +"WARNING_REASON_INVALID_DEVICE_CATEGORY", +"WARNING_REASON_INVALID_DEVICE_SCREEN_RESOLUTION", +"WARNING_REASON_INVALID_MERCHANT_ID" +], +"enumDescriptions": [ +"Unspecified warning reason.", +"A custom variable in `custom_variables` is not enabled in the account.", +"A custom variable value in `custom_variables` is not among the predefined allowed values configured for the custom variable on the destination account.", +"The `cart_data` is not supported with `gbraid` or `wbraid`.", +"The `merchant_product_id` is missing in the cart item.", +"The `unit_price` is missing in the cart item.", +"Generic warning reason for issues that do not fit into other specific categories.", +"The `client_id` is invalid.", +"The `subdivision_code` is invalid.", +"The `region_code` is invalid.", +"The `subcontinent_code` is invalid.", +"The `continent_code` is invalid.", +"The device `category` is invalid.", +"The device `screen_height` or `screen_width` is invalid.", +"The `merchant_id` is invalid." +], +"type": "string" +} +}, +"type": "object" +}, "GcpWrappedKeyInfo": { "description": "Information about the Google Cloud Platform wrapped key.", "id": "GcpWrappedKeyInfo", @@ -2013,6 +2104,20 @@ }, "type": "object" }, +"GoogleUserIdData": { +"description": "Google user id data holding encrypted google user IDs. At least one google user ID is required.", +"id": "GoogleUserIdData", +"properties": { +"googleUserIds": { +"description": "Required. The list of encrypted google user IDs.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "IngestAdEventsRequest": { "description": "Request to upload ad events.", "id": "IngestAdEventsRequest", @@ -2026,9 +2131,10 @@ }, "encryptionInfo": { "$ref": "EncryptionInfo", -"description": "Optional. Information about encryption keys which are used to encrypt the data." +"description": "Required. Information about encryption keys which are used to encrypt the data." }, "validateOnly": { +"deprecated": true, "description": "Optional. If true, the request is validated, but not executed.", "type": "boolean" } @@ -2096,6 +2202,13 @@ "description": "Response from the IngestAudienceMembersRequest.", "id": "IngestAudienceMembersResponse", "properties": { +"fieldWarnings": { +"description": "Detailed row-level warnings with field paths.", +"items": { +"$ref": "FieldWarning" +}, +"type": "array" +}, "requestId": { "description": "The auto-generated ID of the request.", "type": "string" @@ -2111,6 +2224,10 @@ "$ref": "IngestCompositeDataStatus", "description": "The status of the composite data ingestion to the destination." }, +"googleUserIdDataIngestionStatus": { +"$ref": "IngestGoogleUserIdDataStatus", +"description": "The status of the google user id data ingestion to the destination." +}, "mobileDataIngestionStatus": { "$ref": "IngestMobileDataStatus", "description": "The status of the mobile data ingestion to the destination." @@ -2119,6 +2236,10 @@ "$ref": "IngestPairDataStatus", "description": "The status of the pair data ingestion to the destination." }, +"partnerProvidedIdDataIngestionStatus": { +"$ref": "IngestPartnerProvidedIdDataStatus", +"description": "The status of the partner provided id data ingestion to the destination." +}, "ppidDataIngestionStatus": { "$ref": "IngestPpidDataStatus", "description": "The status of the ppid data ingestion to the destination." @@ -2234,6 +2355,13 @@ "description": "Response from the IngestEventsRequest.", "id": "IngestEventsResponse", "properties": { +"fieldWarnings": { +"description": "Detailed row-level warnings with field paths.", +"items": { +"$ref": "FieldWarning" +}, +"type": "array" +}, "requestId": { "description": "The auto-generated ID of the request.", "type": "string" @@ -2253,6 +2381,23 @@ }, "type": "object" }, +"IngestGoogleUserIdDataStatus": { +"description": "The status of the google user id data ingestion to the destination containing stats related to the ingestion.", +"id": "IngestGoogleUserIdDataStatus", +"properties": { +"googleUserIdCount": { +"description": "The total count of google user ids sent in the upload request for the destination. Includes all google user ids in the request, regardless of whether they were successfully ingested or not.", +"format": "int64", +"type": "string" +}, +"recordCount": { +"description": "The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "IngestMobileDataStatus": { "description": "The status of the mobile data ingestion to the destination containing stats related to the ingestion.", "id": "IngestMobileDataStatus", @@ -2287,6 +2432,23 @@ }, "type": "object" }, +"IngestPartnerProvidedIdDataStatus": { +"description": "The status of the partner provided id data ingestion to the destination containing stats related to the ingestion.", +"id": "IngestPartnerProvidedIdDataStatus", +"properties": { +"partnerProvidedIdCount": { +"description": "The total count of partner provided ids sent in the upload request for the destination. Includes all partner provided ids in the request, regardless of whether they were successfully ingested or not.", +"format": "int64", +"type": "string" +}, +"recordCount": { +"description": "The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "IngestPpidDataStatus": { "description": "The status of the ppid data ingestion to the destination containing stats related to the ingestion.", "id": "IngestPpidDataStatus", @@ -2409,7 +2571,7 @@ "Mobile advertising ids.", "Third party provided user ids.", "Publisher advertiser identity reconciliation ids.", -"Data Management Platform IDs: - Google User ID - Partner Provided ID - Publisher Provided ID - iOS IDFA - Android advertising ID - Roku ID - Amazon Fire TV ID - Xbox or Microsoft ID" +"Data Management Platform IDs: - Google User ID - Partner Provided ID - Publisher Provided ID - iOS IDFA - Android advertising ID - Roku ID - Amazon Fire TV ID - Xbox or Microsoft ID - Generic Device ID" ], "type": "string" }, @@ -2718,7 +2880,7 @@ "id": "MobileData", "properties": { "mobileIds": { -"description": "Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 `mobileIds` can be provided in a single AudienceMember.", +"description": "Required. The list of mobile device IDs (Android advertising ID, iOS IDFA for Customer Match user lists and Android advertising ID, iOS IDFA, Xbox or Microsoft ID, Amazon Fire TV ID, Roku ID, Generic Device ID for basic user lists). At most 10 `mobileIds` can be provided in a single AudienceMember.", "items": { "type": "string" }, @@ -2920,6 +3082,20 @@ }, "type": "object" }, +"PartnerProvidedIdData": { +"description": "Partner-provided data holding the partner-provided identifiers. At least one partner-provided identifier is required.", +"id": "PartnerProvidedIdData", +"properties": { +"partnerProvidedIds": { +"description": "Required. The list of partner-provided identifiers.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "PpidData": { "description": "Publisher provided identifiers data holding the ppids. At least one ppid is required. This feature is only available to data partners.", "id": "PpidData", @@ -3017,6 +3193,46 @@ }, "type": "object" }, +"RemoveAllAudienceMembersRequest": { +"description": "Request to remove all users from an audience in the provided destinations. Returns a RemoveAllAudienceMembersResponse.", +"id": "RemoveAllAudienceMembersRequest", +"properties": { +"destinations": { +"description": "Required. The list of destinations to remove the users from.", +"items": { +"$ref": "Destination" +}, +"type": "array" +}, +"removeAsOfTime": { +"description": "Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time. The remove as of time must not be in the future.", +"format": "google-datetime", +"type": "string" +}, +"validateOnly": { +"description": "Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.", +"type": "boolean" +} +}, +"type": "object" +}, +"RemoveAllAudienceMembersResponse": { +"description": "Response from the RemoveAllAudienceMembersRequest.", +"id": "RemoveAllAudienceMembersResponse", +"properties": { +"requestId": { +"description": "The auto-generated ID of the request.", +"type": "string" +} +}, +"type": "object" +}, +"RemoveAllAudienceMembersStatus": { +"description": "The status of the remove all audience members request.", +"id": "RemoveAllAudienceMembersStatus", +"properties": {}, +"type": "object" +}, "RemoveAudienceMembersRequest": { "description": "Request to remove users from an audience in the provided destinations. Returns a RemoveAudienceMembersResponse.", "id": "RemoveAudienceMembersRequest", @@ -3079,6 +3295,10 @@ "$ref": "RemoveCompositeDataStatus", "description": "The status of the composite data removal from the destination." }, +"googleUserIdDataRemovalStatus": { +"$ref": "RemoveGoogleUserIdDataStatus", +"description": "The status of the google user id data removal from the destination." +}, "mobileDataRemovalStatus": { "$ref": "RemoveMobileDataStatus", "description": "The status of the mobile data removal from the destination." @@ -3087,6 +3307,10 @@ "$ref": "RemovePairDataStatus", "description": "The status of the pair data removal from the destination." }, +"partnerProvidedIdDataRemovalStatus": { +"$ref": "RemovePartnerProvidedIdDataStatus", +"description": "The status of the partner provided id data removal from the destination." +}, "ppidDataRemovalStatus": { "$ref": "RemovePpidDataStatus", "description": "The status of the ppid data removal from the destination." @@ -3121,6 +3345,23 @@ }, "type": "object" }, +"RemoveGoogleUserIdDataStatus": { +"description": "The status of the google user id data removal from the destination.", +"id": "RemoveGoogleUserIdDataStatus", +"properties": { +"googleUserIdCount": { +"description": "The total count of google user ids sent in the removal request. Includes all google user ids in the request, regardless of whether they were successfully removed or not.", +"format": "int64", +"type": "string" +}, +"recordCount": { +"description": "The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "RemoveMobileDataStatus": { "description": "The status of the mobile data removal from the destination.", "id": "RemoveMobileDataStatus", @@ -3155,6 +3396,23 @@ }, "type": "object" }, +"RemovePartnerProvidedIdDataStatus": { +"description": "The status of the partner provided id data removal from the destination.", +"id": "RemovePartnerProvidedIdDataStatus", +"properties": { +"partnerProvidedIdCount": { +"description": "The total count of partner provided ids sent in the removal request. Includes all partner provided ids in the request, regardless of whether they were successfully removed or not.", +"format": "int64", +"type": "string" +}, +"recordCount": { +"description": "The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "RemovePpidDataStatus": { "description": "The status of the ppid data removal from the destination.", "id": "RemovePpidDataStatus", @@ -3230,6 +3488,10 @@ "$ref": "IngestEventsStatus", "description": "The status of the ingest events request." }, +"removeAllAudienceMembersStatus": { +"$ref": "RemoveAllAudienceMembersStatus", +"description": "The status of the remove all audience members request." +}, "requestStatus": { "description": "The request status of the destination.", "enum": [ From 014387ed88d5957a0537aa3544414b3c526714d2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:03 +0000 Subject: [PATCH 36/84] feat(datamigration): update the api #### datamigration:v1 The following keys were added: - schemas.MappingRule.properties.setTablePrimaryKey.deprecated (Total Keys: 1) - schemas.SetTablePrimaryKey.deprecated (Total Keys: 1) --- ....locations.conversionWorkspaces.mappingRules.html | 8 ++++---- .../discovery_cache/documents/datamigration.v1.json | 12 +++++++----- .../documents/datamigration.v1beta1.json | 6 +++--- 3 files changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html index 708fb9613b..edb4636b7b 100644 --- a/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html +++ b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html @@ -217,7 +217,7 @@

Method Details

"revisionId": "A String", # Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string. "ruleOrder": "A String", # Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden. "ruleScope": "A String", # Required. The rule scope - "setTablePrimaryKey": { # Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. # Optional. Rule to specify the primary key for a table + "setTablePrimaryKey": { # Deprecated: Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. # Optional. Deprecated: This rule is no longer supported. "primaryKey": "A String", # Optional. Name for the primary key "primaryKeyColumns": [ # Required. List of column names for the primary key "A String", @@ -374,7 +374,7 @@

Method Details

"revisionId": "A String", # Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string. "ruleOrder": "A String", # Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden. "ruleScope": "A String", # Required. The rule scope - "setTablePrimaryKey": { # Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. # Optional. Rule to specify the primary key for a table + "setTablePrimaryKey": { # Deprecated: Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. # Optional. Deprecated: This rule is no longer supported. "primaryKey": "A String", # Optional. Name for the primary key "primaryKeyColumns": [ # Required. List of column names for the primary key "A String", @@ -555,7 +555,7 @@

Method Details

"revisionId": "A String", # Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string. "ruleOrder": "A String", # Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden. "ruleScope": "A String", # Required. The rule scope - "setTablePrimaryKey": { # Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. # Optional. Rule to specify the primary key for a table + "setTablePrimaryKey": { # Deprecated: Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. # Optional. Deprecated: This rule is no longer supported. "primaryKey": "A String", # Optional. Name for the primary key "primaryKeyColumns": [ # Required. List of column names for the primary key "A String", @@ -770,7 +770,7 @@

Method Details

"revisionId": "A String", # Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string. "ruleOrder": "A String", # Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden. "ruleScope": "A String", # Required. The rule scope - "setTablePrimaryKey": { # Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. # Optional. Rule to specify the primary key for a table + "setTablePrimaryKey": { # Deprecated: Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. # Optional. Deprecated: This rule is no longer supported. "primaryKey": "A String", # Optional. Name for the primary key "primaryKeyColumns": [ # Required. List of column names for the primary key "A String", diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index 6da2473b4f..527e8f83a1 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -2587,7 +2587,7 @@ } } }, -"revision": "20260620", +"revision": "20260718", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -4338,7 +4338,7 @@ "type": "object" }, "reason": { -"description": "The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", +"description": "The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", "type": "string" } }, @@ -4402,7 +4402,7 @@ "description": "Provides a localized error message for field-level errors that is safe to return to the API consumer." }, "reason": { -"description": "The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", +"description": "The reason for the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", "type": "string" } }, @@ -5145,7 +5145,8 @@ }, "setTablePrimaryKey": { "$ref": "SetTablePrimaryKey", -"description": "Optional. Rule to specify the primary key for a table" +"deprecated": true, +"description": "Optional. Deprecated: This rule is no longer supported." }, "singleColumnChange": { "$ref": "SingleColumnChange", @@ -6748,7 +6749,8 @@ "type": "object" }, "SetTablePrimaryKey": { -"description": "Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table.", +"deprecated": true, +"description": "Deprecated: Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table.", "id": "SetTablePrimaryKey", "properties": { "primaryKey": { diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json index 8ac4d8c810..9aaf1d75cd 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json @@ -1297,7 +1297,7 @@ } } }, -"revision": "20260511", +"revision": "20260718", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": { @@ -1678,7 +1678,7 @@ "type": "object" }, "reason": { -"description": "The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", +"description": "The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", "type": "string" } }, @@ -1724,7 +1724,7 @@ "description": "Provides a localized error message for field-level errors that is safe to return to the API consumer." }, "reason": { -"description": "The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", +"description": "The reason for the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", "type": "string" } }, From 6272bb90285dd11754f76b51a72ca3eb38e3fc13 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:03 +0000 Subject: [PATCH 37/84] feat(dataplex): update the api #### dataplex:v1 The following keys were deleted: - schemas.GoogleCloudDataplexV1LookupContextRequest.properties.context.type (Total Keys: 1) --- docs/dyn/dataplex_v1.projects.locations.html | 1 - googleapiclient/discovery_cache/documents/dataplex.v1.json | 6 +----- 2 files changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html index 5cc6dc2bfc..08a56fb1b2 100644 --- a/docs/dyn/dataplex_v1.projects.locations.html +++ b/docs/dyn/dataplex_v1.projects.locations.html @@ -280,7 +280,6 @@

Method Details

The object takes the form of: { # Lookup Context using permissions in the source system. - "context": "A String", # Optional. The text representing contextual information for which metadata context is being requested. "options": { # Optional. Allows to configure the context.Supported options: format - The format of the context (one of yaml, xml, json, default is yaml). context_budget - If provided, the output will be intelligently truncated on a best-effort basis to contain approximately the desired amount of characters. There is no guarantee to achieve the specific amount. all_schema_fields - If set to true, all schema fields will be returned in the context (regardless of context_budget value). Otherwise, the list of schema fields is truncated. Default is false. "a_key": "A String", }, diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 226445fe1f..e060e0f3f1 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -8038,7 +8038,7 @@ } } }, -"revision": "20260623", +"revision": "20260713", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -14645,10 +14645,6 @@ "description": "Lookup Context using permissions in the source system.", "id": "GoogleCloudDataplexV1LookupContextRequest", "properties": { -"context": { -"description": "Optional. The text representing contextual information for which metadata context is being requested.", -"type": "string" -}, "options": { "additionalProperties": { "type": "string" From f32ca396e8c6efd0e7349275cbe323703f2b4236 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:03 +0000 Subject: [PATCH 38/84] fix(dataportability): update the api #### dataportability:v1 The following keys were changed: - resources.accessType.methods.check.scopes (Total Keys: 1) - resources.archiveJobs.methods.cancel.scopes (Total Keys: 1) - resources.archiveJobs.methods.getPortabilityArchiveState.scopes (Total Keys: 1) - resources.archiveJobs.methods.retry.scopes (Total Keys: 1) - resources.authorization.methods.reset.scopes (Total Keys: 1) - resources.portabilityArchive.methods.initiate.scopes (Total Keys: 1) #### dataportability:v1beta The following keys were changed: - resources.accessType.methods.check.scopes (Total Keys: 1) - resources.archiveJobs.methods.cancel.scopes (Total Keys: 1) - resources.archiveJobs.methods.getPortabilityArchiveState.scopes (Total Keys: 1) - resources.archiveJobs.methods.retry.scopes (Total Keys: 1) - resources.authorization.methods.reset.scopes (Total Keys: 1) - resources.portabilityArchive.methods.initiate.scopes (Total Keys: 1) --- .../discovery_cache/documents/dataportability.v1.json | 11 ++++++++++- .../documents/dataportability.v1beta.json | 11 ++++++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/dataportability.v1.json b/googleapiclient/discovery_cache/documents/dataportability.v1.json index 5da90f6fa0..1df843b92f 100644 --- a/googleapiclient/discovery_cache/documents/dataportability.v1.json +++ b/googleapiclient/discovery_cache/documents/dataportability.v1.json @@ -107,6 +107,9 @@ "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations": { "description": "Move a copy of your food purchase and reservation activity" }, +"https://www.googleapis.com/auth/dataportability.pixel.device_data": { +"description": "Usage and diagnostic data from your Pixel devices." +}, "https://www.googleapis.com/auth/dataportability.play.devices": { "description": "Move a copy of information about your devices with Google Play Store installed" }, @@ -370,6 +373,7 @@ "https://www.googleapis.com/auth/dataportability.nest.store", "https://www.googleapis.com/auth/dataportability.nest.user", "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", +"https://www.googleapis.com/auth/dataportability.pixel.device_data", "https://www.googleapis.com/auth/dataportability.play.devices", "https://www.googleapis.com/auth/dataportability.play.grouping", "https://www.googleapis.com/auth/dataportability.play.installs", @@ -473,6 +477,7 @@ "https://www.googleapis.com/auth/dataportability.nest.store", "https://www.googleapis.com/auth/dataportability.nest.user", "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", +"https://www.googleapis.com/auth/dataportability.pixel.device_data", "https://www.googleapis.com/auth/dataportability.play.devices", "https://www.googleapis.com/auth/dataportability.play.grouping", "https://www.googleapis.com/auth/dataportability.play.installs", @@ -569,6 +574,7 @@ "https://www.googleapis.com/auth/dataportability.nest.store", "https://www.googleapis.com/auth/dataportability.nest.user", "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", +"https://www.googleapis.com/auth/dataportability.pixel.device_data", "https://www.googleapis.com/auth/dataportability.play.devices", "https://www.googleapis.com/auth/dataportability.play.grouping", "https://www.googleapis.com/auth/dataportability.play.installs", @@ -668,6 +674,7 @@ "https://www.googleapis.com/auth/dataportability.nest.store", "https://www.googleapis.com/auth/dataportability.nest.user", "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", +"https://www.googleapis.com/auth/dataportability.pixel.device_data", "https://www.googleapis.com/auth/dataportability.play.devices", "https://www.googleapis.com/auth/dataportability.play.grouping", "https://www.googleapis.com/auth/dataportability.play.installs", @@ -761,6 +768,7 @@ "https://www.googleapis.com/auth/dataportability.nest.store", "https://www.googleapis.com/auth/dataportability.nest.user", "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", +"https://www.googleapis.com/auth/dataportability.pixel.device_data", "https://www.googleapis.com/auth/dataportability.play.devices", "https://www.googleapis.com/auth/dataportability.play.grouping", "https://www.googleapis.com/auth/dataportability.play.installs", @@ -854,6 +862,7 @@ "https://www.googleapis.com/auth/dataportability.nest.store", "https://www.googleapis.com/auth/dataportability.nest.user", "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", +"https://www.googleapis.com/auth/dataportability.pixel.device_data", "https://www.googleapis.com/auth/dataportability.play.devices", "https://www.googleapis.com/auth/dataportability.play.grouping", "https://www.googleapis.com/auth/dataportability.play.installs", @@ -896,7 +905,7 @@ } } }, -"revision": "20260105", +"revision": "20260719", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "CancelPortabilityArchiveRequest": { diff --git a/googleapiclient/discovery_cache/documents/dataportability.v1beta.json b/googleapiclient/discovery_cache/documents/dataportability.v1beta.json index 446d1e4737..342301a139 100644 --- a/googleapiclient/discovery_cache/documents/dataportability.v1beta.json +++ b/googleapiclient/discovery_cache/documents/dataportability.v1beta.json @@ -107,6 +107,9 @@ "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations": { "description": "Move a copy of your food purchase and reservation activity" }, +"https://www.googleapis.com/auth/dataportability.pixel.device_data": { +"description": "Usage and diagnostic data from your Pixel devices." +}, "https://www.googleapis.com/auth/dataportability.play.devices": { "description": "Move a copy of information about your devices with Google Play Store installed" }, @@ -370,6 +373,7 @@ "https://www.googleapis.com/auth/dataportability.nest.store", "https://www.googleapis.com/auth/dataportability.nest.user", "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", +"https://www.googleapis.com/auth/dataportability.pixel.device_data", "https://www.googleapis.com/auth/dataportability.play.devices", "https://www.googleapis.com/auth/dataportability.play.grouping", "https://www.googleapis.com/auth/dataportability.play.installs", @@ -473,6 +477,7 @@ "https://www.googleapis.com/auth/dataportability.nest.store", "https://www.googleapis.com/auth/dataportability.nest.user", "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", +"https://www.googleapis.com/auth/dataportability.pixel.device_data", "https://www.googleapis.com/auth/dataportability.play.devices", "https://www.googleapis.com/auth/dataportability.play.grouping", "https://www.googleapis.com/auth/dataportability.play.installs", @@ -569,6 +574,7 @@ "https://www.googleapis.com/auth/dataportability.nest.store", "https://www.googleapis.com/auth/dataportability.nest.user", "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", +"https://www.googleapis.com/auth/dataportability.pixel.device_data", "https://www.googleapis.com/auth/dataportability.play.devices", "https://www.googleapis.com/auth/dataportability.play.grouping", "https://www.googleapis.com/auth/dataportability.play.installs", @@ -668,6 +674,7 @@ "https://www.googleapis.com/auth/dataportability.nest.store", "https://www.googleapis.com/auth/dataportability.nest.user", "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", +"https://www.googleapis.com/auth/dataportability.pixel.device_data", "https://www.googleapis.com/auth/dataportability.play.devices", "https://www.googleapis.com/auth/dataportability.play.grouping", "https://www.googleapis.com/auth/dataportability.play.installs", @@ -761,6 +768,7 @@ "https://www.googleapis.com/auth/dataportability.nest.store", "https://www.googleapis.com/auth/dataportability.nest.user", "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", +"https://www.googleapis.com/auth/dataportability.pixel.device_data", "https://www.googleapis.com/auth/dataportability.play.devices", "https://www.googleapis.com/auth/dataportability.play.grouping", "https://www.googleapis.com/auth/dataportability.play.installs", @@ -854,6 +862,7 @@ "https://www.googleapis.com/auth/dataportability.nest.store", "https://www.googleapis.com/auth/dataportability.nest.user", "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", +"https://www.googleapis.com/auth/dataportability.pixel.device_data", "https://www.googleapis.com/auth/dataportability.play.devices", "https://www.googleapis.com/auth/dataportability.play.grouping", "https://www.googleapis.com/auth/dataportability.play.installs", @@ -896,7 +905,7 @@ } } }, -"revision": "20260105", +"revision": "20260719", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "CancelPortabilityArchiveRequest": { From d54ceb36481c073a17f423e583a81c117c9342e6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:03 +0000 Subject: [PATCH 39/84] feat(dataproc): update the api #### dataproc:v1 The following keys were added: - resources.projects.resources.locations.resources.batches.resources.sparkApplications.methods.accessNativeBuildInfo (Total Keys: 13) - resources.projects.resources.locations.resources.batches.resources.sparkApplications.methods.accessNativeSqlQuery (Total Keys: 16) - resources.projects.resources.locations.resources.batches.resources.sparkApplications.methods.computeTuningConfig (Total Keys: 18) - resources.projects.resources.locations.resources.batches.resources.sparkApplications.methods.searchNativeSqlQueries (Total Keys: 18) - resources.projects.resources.locations.resources.sessions.resources.sparkApplications.methods.accessNativeBuildInfo (Total Keys: 13) - resources.projects.resources.locations.resources.sessions.resources.sparkApplications.methods.accessNativeSqlQuery (Total Keys: 16) - resources.projects.resources.locations.resources.sessions.resources.sparkApplications.methods.searchNativeSqlQueries (Total Keys: 18) - schemas.AccessSessionSparkApplicationNativeBuildInfoResponse (Total Keys: 3) - schemas.AccessSessionSparkApplicationNativeSqlQueryResponse (Total Keys: 3) - schemas.AccessSparkApplicationNativeBuildInfoResponse (Total Keys: 3) - schemas.AccessSparkApplicationNativeSqlQueryResponse (Total Keys: 3) - schemas.AttachmentOperationMetadata (Total Keys: 20) - schemas.ComputeTuningConfigResponse (Total Keys: 4) - schemas.IdentityConfig.properties.enableSsh.type (Total Keys: 1) - schemas.SearchSessionSparkApplicationNativeSqlQueriesResponse (Total Keys: 6) - schemas.SearchSparkApplicationNativeSqlQueriesResponse (Total Keys: 6) --- ...s.locations.batches.sparkApplications.html | 151 ++++++ ....locations.sessions.sparkApplications.html | 124 +++++ ....projects.locations.workflowTemplates.html | 7 + ...dataproc_v1.projects.regions.clusters.html | 4 + ...v1.projects.regions.workflowTemplates.html | 7 + .../documents/dataproc.v1.json | 438 +++++++++++++++++- 6 files changed, 730 insertions(+), 1 deletion(-) diff --git a/docs/dyn/dataproc_v1.projects.locations.batches.sparkApplications.html b/docs/dyn/dataproc_v1.projects.locations.batches.sparkApplications.html index 4b7637c169..3e9b726778 100644 --- a/docs/dyn/dataproc_v1.projects.locations.batches.sparkApplications.html +++ b/docs/dyn/dataproc_v1.projects.locations.batches.sparkApplications.html @@ -83,6 +83,12 @@

Instance Methods

accessJob(name, jobId=None, parent=None, x__xgafv=None)

Obtain data corresponding to a spark job for a Spark Application.

+

+ accessNativeBuildInfo(name, parent=None, x__xgafv=None)

+

Obtain build data for Native Job

+

+ accessNativeSqlQuery(name, executionId=None, parent=None, x__xgafv=None)

+

Obtain data corresponding to a particular Native SQL Query for a Spark Application.

accessSqlPlan(name, executionId=None, parent=None, x__xgafv=None)

Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.

@@ -98,6 +104,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ computeTuningConfig(name, executionId=None, parent=None, semanticQueryId=None, x__xgafv=None)

+

Returns autotuning configuration for a specific query plan id and cohort id. Called by Spark during query planning.

search(parent, applicationStatus=None, maxEndTime=None, maxTime=None, minEndTime=None, minTime=None, pageSize=None, pageToken=None, x__xgafv=None)

Obtain high level information and list of Spark Applications corresponding to a batch

@@ -119,6 +128,12 @@

Instance Methods

searchJobs_next()

Retrieves the next page of results.

+

+ searchNativeSqlQueries(name, pageSize=None, pageToken=None, parent=None, x__xgafv=None)

+

Obtain data corresponding to Native SQL Queries for a Spark Application.

+

+ searchNativeSqlQueries_next()

+

Retrieves the next page of results.

searchSqlQueries(name, details=None, pageSize=None, pageToken=None, parent=None, planDescription=None, x__xgafv=None)

Obtain data corresponding to SQL Queries for a Spark Application.

@@ -313,6 +328,67 @@

Method Details

} +
+ accessNativeBuildInfo(name, parent=None, x__xgafv=None) +
Obtain build data for Native Job
+
+Args:
+  name: string, Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" (required)
+  parent: string, Required. Parent (Batch) resource reference.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Details of Native Build Info for a Spark Application
+  "buildInfo": { # Native Build Info Data
+    "buildClass": "A String", # Optional. Build class of Native.
+    "buildInfo": [ # Optional. Build related details.
+      { # Native Build Info
+        "buildKey": "A String", # Optional. Build key.
+        "buildValue": "A String", # Optional. Build value.
+      },
+    ],
+  },
+}
+
+ +
+ accessNativeSqlQuery(name, executionId=None, parent=None, x__xgafv=None) +
Obtain data corresponding to a particular Native SQL Query for a Spark Application.
+
+Args:
+  name: string, Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" (required)
+  executionId: string, Required. Execution ID
+  parent: string, Required. Parent (Batch) resource reference.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Details of a query for a Spark Application
+  "executionData": { # Native SQL Execution Data # Native SQL Execution Data
+    "description": "A String", # Optional. Description of the execution.
+    "executionId": "A String", # Required. Execution ID of the Native SQL Execution.
+    "fallbackDescription": "A String", # Optional. Description of the fallback.
+    "fallbackNodeToReason": [ # Optional. Fallback node to reason.
+      { # Native SQL Execution Data
+        "fallbackNode": "A String", # Optional. Fallback node information.
+        "fallbackReason": "A String", # Optional. Fallback to Spark reason.
+      },
+    ],
+    "numFallbackNodes": 42, # Optional. Number of nodes fallen back to Spark.
+    "numNativeNodes": 42, # Optional. Number of nodes in Native.
+  },
+}
+
+
accessSqlPlan(name, executionId=None, parent=None, x__xgafv=None)
Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.
@@ -1141,6 +1217,30 @@ 

Method Details

Close httplib2 connections.
+
+ computeTuningConfig(name, executionId=None, parent=None, semanticQueryId=None, x__xgafv=None) +
Returns autotuning configuration for a specific query plan id and cohort id. Called by Spark during query planning.
+
+Args:
+  name: string, Required. The fully qualified name of the spark application to retrieve autotuning configuration for in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" (required)
+  executionId: string, Required. Spark execution ID for the query.
+  parent: string, Required. Parent (Batch) resource reference.
+  semanticQueryId: string, Required. Spark semantic query ID.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ComputeTuningConfig RPC.
+  "recommendedProperties": { # Recommended Spark properties for the query (e.g., {"spark.sql.shuffle.partitions": "500"}).
+    "a_key": "A String",
+  },
+}
+
+
search(parent, applicationStatus=None, maxEndTime=None, maxTime=None, minEndTime=None, minTime=None, pageSize=None, pageToken=None, x__xgafv=None)
Obtain high level information and list of Spark Applications corresponding to a batch
@@ -1434,6 +1534,57 @@ 

Method Details

+
+ searchNativeSqlQueries(name, pageSize=None, pageToken=None, parent=None, x__xgafv=None) +
Obtain data corresponding to Native SQL Queries for a Spark Application.
+
+Args:
+  name: string, Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" (required)
+  pageSize: integer, Optional. Maximum number of queries to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.
+  pageToken: string, Optional. A page token received from a previous SearchSparkApplicationNativeSqlQueries call. Provide this token to retrieve the subsequent page.
+  parent: string, Required. Parent (Batch) resource reference.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # List of all Native SQL queries details for a Spark Application.
+  "nextPageToken": "A String", # This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationNativeSqlQueriesRequest.
+  "sparkApplicationNativeSqlQueries": [ # Output only. Native SQL Execution Data
+    { # Native SQL Execution Data
+      "description": "A String", # Optional. Description of the execution.
+      "executionId": "A String", # Required. Execution ID of the Native SQL Execution.
+      "fallbackDescription": "A String", # Optional. Description of the fallback.
+      "fallbackNodeToReason": [ # Optional. Fallback node to reason.
+        { # Native SQL Execution Data
+          "fallbackNode": "A String", # Optional. Fallback node information.
+          "fallbackReason": "A String", # Optional. Fallback to Spark reason.
+        },
+      ],
+      "numFallbackNodes": 42, # Optional. Number of nodes fallen back to Spark.
+      "numNativeNodes": 42, # Optional. Number of nodes in Native.
+    },
+  ],
+}
+
+ +
+ searchNativeSqlQueries_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+
searchSqlQueries(name, details=None, pageSize=None, pageToken=None, parent=None, planDescription=None, x__xgafv=None)
Obtain data corresponding to SQL Queries for a Spark Application.
diff --git a/docs/dyn/dataproc_v1.projects.locations.sessions.sparkApplications.html b/docs/dyn/dataproc_v1.projects.locations.sessions.sparkApplications.html
index cf478170c2..0fc0f9ae9b 100644
--- a/docs/dyn/dataproc_v1.projects.locations.sessions.sparkApplications.html
+++ b/docs/dyn/dataproc_v1.projects.locations.sessions.sparkApplications.html
@@ -83,6 +83,12 @@ 

Instance Methods

accessJob(name, jobId=None, parent=None, x__xgafv=None)

Obtain data corresponding to a spark job for a Spark Application.

+

+ accessNativeBuildInfo(name, parent=None, x__xgafv=None)

+

Obtain data corresponding to Native Build Information for a Spark Application.

+

+ accessNativeSqlQuery(name, executionId=None, parent=None, x__xgafv=None)

+

Obtain data corresponding to a particular Native SQL Query for a Spark Application.

accessSqlPlan(name, executionId=None, parent=None, x__xgafv=None)

Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.

@@ -119,6 +125,12 @@

Instance Methods

searchJobs_next()

Retrieves the next page of results.

+

+ searchNativeSqlQueries(name, pageSize=None, pageToken=None, parent=None, x__xgafv=None)

+

Obtain data corresponding to Native SQL Queries for a Spark Application.

+

+ searchNativeSqlQueries_next()

+

Retrieves the next page of results.

searchSqlQueries(name, details=None, operationIds=None, pageSize=None, pageToken=None, parent=None, planDescription=None, x__xgafv=None)

Obtain data corresponding to SQL Queries for a Spark Application.

@@ -313,6 +325,67 @@

Method Details

}
+
+ accessNativeBuildInfo(name, parent=None, x__xgafv=None) +
Obtain data corresponding to Native Build Information for a Spark Application.
+
+Args:
+  name: string, Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" (required)
+  parent: string, Required. Parent (Session) resource reference.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Details of a native build info for a Spark Application
+  "executionData": { # Native SQL Execution Data
+    "buildClass": "A String", # Optional. Build class of Native.
+    "buildInfo": [ # Optional. Build related details.
+      { # Native Build Info
+        "buildKey": "A String", # Optional. Build key.
+        "buildValue": "A String", # Optional. Build value.
+      },
+    ],
+  },
+}
+
+ +
+ accessNativeSqlQuery(name, executionId=None, parent=None, x__xgafv=None) +
Obtain data corresponding to a particular Native SQL Query for a Spark Application.
+
+Args:
+  name: string, Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" (required)
+  executionId: string, Required. Execution ID
+  parent: string, Required. Parent (Session) resource reference.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Details of a native query for a Spark Application
+  "executionData": { # Native SQL Execution Data # Native SQL Execution Data
+    "description": "A String", # Optional. Description of the execution.
+    "executionId": "A String", # Required. Execution ID of the Native SQL Execution.
+    "fallbackDescription": "A String", # Optional. Description of the fallback.
+    "fallbackNodeToReason": [ # Optional. Fallback node to reason.
+      { # Native SQL Execution Data
+        "fallbackNode": "A String", # Optional. Fallback node information.
+        "fallbackReason": "A String", # Optional. Fallback to Spark reason.
+      },
+    ],
+    "numFallbackNodes": 42, # Optional. Number of nodes fallen back to Spark.
+    "numNativeNodes": 42, # Optional. Number of nodes in Native.
+  },
+}
+
+
accessSqlPlan(name, executionId=None, parent=None, x__xgafv=None)
Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.
@@ -1435,6 +1508,57 @@ 

Method Details

+
+ searchNativeSqlQueries(name, pageSize=None, pageToken=None, parent=None, x__xgafv=None) +
Obtain data corresponding to Native SQL Queries for a Spark Application.
+
+Args:
+  name: string, Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" (required)
+  pageSize: integer, Optional. Maximum number of queries to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.
+  pageToken: string, Optional. A page token received from a previous SearchSessionSparkApplicationSqlQueries call. Provide this token to retrieve the subsequent page.
+  parent: string, Required. Parent (Session) resource reference.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # List of all Native queries for a Spark Application.
+  "nextPageToken": "A String", # This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationSqlQueriesRequest.
+  "sparkApplicationNativeSqlQueries": [ # Output only. Native SQL Execution Data
+    { # Native SQL Execution Data
+      "description": "A String", # Optional. Description of the execution.
+      "executionId": "A String", # Required. Execution ID of the Native SQL Execution.
+      "fallbackDescription": "A String", # Optional. Description of the fallback.
+      "fallbackNodeToReason": [ # Optional. Fallback node to reason.
+        { # Native SQL Execution Data
+          "fallbackNode": "A String", # Optional. Fallback node information.
+          "fallbackReason": "A String", # Optional. Fallback to Spark reason.
+        },
+      ],
+      "numFallbackNodes": 42, # Optional. Number of nodes fallen back to Spark.
+      "numNativeNodes": 42, # Optional. Number of nodes in Native.
+    },
+  ],
+}
+
+ +
+ searchNativeSqlQueries_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+
searchSqlQueries(name, details=None, operationIds=None, pageSize=None, pageToken=None, parent=None, planDescription=None, x__xgafv=None)
Obtain data corresponding to SQL Queries for a Spark Application.
diff --git a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html
index d39eabbaec..736409fa5a 100644
--- a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html
+++ b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html
@@ -811,6 +811,7 @@ 

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -1636,6 +1637,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -2488,6 +2490,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -3404,6 +3407,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -4270,6 +4274,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -5204,6 +5209,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -6029,6 +6035,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.html b/docs/dyn/dataproc_v1.projects.regions.clusters.html index 6ac6476b00..684d2fdf0d 100644 --- a/docs/dyn/dataproc_v1.projects.regions.clusters.html +++ b/docs/dyn/dataproc_v1.projects.regions.clusters.html @@ -555,6 +555,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -1330,6 +1331,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -2066,6 +2068,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -2722,6 +2725,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, diff --git a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html index 803fbd4f33..81c26c28e5 100644 --- a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html @@ -811,6 +811,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -1636,6 +1637,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -2488,6 +2490,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -3404,6 +3407,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -4270,6 +4274,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -5204,6 +5209,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, @@ -6029,6 +6035,7 @@

Method Details

}, "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security settings for the cluster. "identityConfig": { # Identity related configuration, including service account based secure multi-tenancy user mappings. # Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + "enableSsh": True or False, # Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later. "userServiceAccountMapping": { # Required. Map of user to service account. "a_key": "A String", }, diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index a0d5534f98..375fb7b1f0 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -722,6 +722,76 @@ "https://www.googleapis.com/auth/dataproc.read-only" ] }, +"accessNativeBuildInfo": { +"description": "Obtain build data for Native Job", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessNativeBuildInfo", +"httpMethod": "GET", +"id": "dataproc.projects.locations.batches.sparkApplications.accessNativeBuildInfo", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Required. Parent (Batch) resource reference.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:accessNativeBuildInfo", +"response": { +"$ref": "AccessSparkApplicationNativeBuildInfoResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" +] +}, +"accessNativeSqlQuery": { +"description": "Obtain data corresponding to a particular Native SQL Query for a Spark Application.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessNativeSqlQuery", +"httpMethod": "GET", +"id": "dataproc.projects.locations.batches.sparkApplications.accessNativeSqlQuery", +"parameterOrder": [ +"name" +], +"parameters": { +"executionId": { +"description": "Required. Execution ID", +"format": "int64", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Required. Parent (Batch) resource reference.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:accessNativeSqlQuery", +"response": { +"$ref": "AccessSparkApplicationNativeSqlQueryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" +] +}, "accessSqlPlan": { "description": "Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessSqlPlan", @@ -896,6 +966,49 @@ "https://www.googleapis.com/auth/dataproc.read-only" ] }, +"computeTuningConfig": { +"description": "Returns autotuning configuration for a specific query plan id and cohort id. Called by Spark during query planning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:computeTuningConfig", +"httpMethod": "GET", +"id": "dataproc.projects.locations.batches.sparkApplications.computeTuningConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"executionId": { +"description": "Required. Spark execution ID for the query.", +"format": "int64", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The fully qualified name of the spark application to retrieve autotuning configuration for in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Required. Parent (Batch) resource reference.", +"location": "query", +"type": "string" +}, +"semanticQueryId": { +"description": "Required. Spark semantic query ID.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:computeTuningConfig", +"response": { +"$ref": "ComputeTuningConfigResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" +] +}, "search": { "description": "Obtain high level information and list of Spark Applications corresponding to a batch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications:search", @@ -1148,6 +1261,49 @@ "https://www.googleapis.com/auth/dataproc.read-only" ] }, +"searchNativeSqlQueries": { +"description": "Obtain data corresponding to Native SQL Queries for a Spark Application.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchNativeSqlQueries", +"httpMethod": "GET", +"id": "dataproc.projects.locations.batches.sparkApplications.searchNativeSqlQueries", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of queries to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token received from a previous SearchSparkApplicationNativeSqlQueries call. Provide this token to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent (Batch) resource reference.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:searchNativeSqlQueries", +"response": { +"$ref": "SearchSparkApplicationNativeSqlQueriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" +] +}, "searchSqlQueries": { "description": "Obtain data corresponding to SQL Queries for a Spark Application.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchSqlQueries", @@ -2146,6 +2302,76 @@ "https://www.googleapis.com/auth/dataproc.read-only" ] }, +"accessNativeBuildInfo": { +"description": "Obtain data corresponding to Native Build Information for a Spark Application.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessNativeBuildInfo", +"httpMethod": "GET", +"id": "dataproc.projects.locations.sessions.sparkApplications.accessNativeBuildInfo", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Required. Parent (Session) resource reference.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:accessNativeBuildInfo", +"response": { +"$ref": "AccessSessionSparkApplicationNativeBuildInfoResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" +] +}, +"accessNativeSqlQuery": { +"description": "Obtain data corresponding to a particular Native SQL Query for a Spark Application.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessNativeSqlQuery", +"httpMethod": "GET", +"id": "dataproc.projects.locations.sessions.sparkApplications.accessNativeSqlQuery", +"parameterOrder": [ +"name" +], +"parameters": { +"executionId": { +"description": "Required. Execution ID", +"format": "int64", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Required. Parent (Session) resource reference.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:accessNativeSqlQuery", +"response": { +"$ref": "AccessSessionSparkApplicationNativeSqlQueryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" +] +}, "accessSqlPlan": { "description": "Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessSqlPlan", @@ -2579,6 +2805,49 @@ "https://www.googleapis.com/auth/dataproc.read-only" ] }, +"searchNativeSqlQueries": { +"description": "Obtain data corresponding to Native SQL Queries for a Spark Application.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchNativeSqlQueries", +"httpMethod": "GET", +"id": "dataproc.projects.locations.sessions.sparkApplications.searchNativeSqlQueries", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of queries to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token received from a previous SearchSessionSparkApplicationSqlQueries call. Provide this token to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent (Session) resource reference.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:searchNativeSqlQueries", +"response": { +"$ref": "SearchSessionSparkApplicationNativeSqlQueriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataproc", +"https://www.googleapis.com/auth/dataproc.read-only" +] +}, "searchSqlQueries": { "description": "Obtain data corresponding to SQL Queries for a Spark Application.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchSqlQueries", @@ -5229,7 +5498,7 @@ } } }, -"revision": "20260625", +"revision": "20260715", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -5271,6 +5540,28 @@ }, "type": "object" }, +"AccessSessionSparkApplicationNativeBuildInfoResponse": { +"description": "Details of a native build info for a Spark Application", +"id": "AccessSessionSparkApplicationNativeBuildInfoResponse", +"properties": { +"executionData": { +"$ref": "NativeBuildInfoUiData", +"description": "Native SQL Execution Data" +} +}, +"type": "object" +}, +"AccessSessionSparkApplicationNativeSqlQueryResponse": { +"description": "Details of a native query for a Spark Application", +"id": "AccessSessionSparkApplicationNativeSqlQueryResponse", +"properties": { +"executionData": { +"$ref": "NativeSqlExecutionUiData", +"description": "Native SQL Execution Data" +} +}, +"type": "object" +}, "AccessSessionSparkApplicationResponse": { "description": "A summary of Spark Application", "id": "AccessSessionSparkApplicationResponse", @@ -5351,6 +5642,28 @@ }, "type": "object" }, +"AccessSparkApplicationNativeBuildInfoResponse": { +"description": "Details of Native Build Info for a Spark Application", +"id": "AccessSparkApplicationNativeBuildInfoResponse", +"properties": { +"buildInfo": { +"$ref": "NativeBuildInfoUiData", +"description": "Native Build Info Data" +} +}, +"type": "object" +}, +"AccessSparkApplicationNativeSqlQueryResponse": { +"description": "Details of a query for a Spark Application", +"id": "AccessSparkApplicationNativeSqlQueryResponse", +"properties": { +"executionData": { +"$ref": "NativeSqlExecutionUiData", +"description": "Native SQL Execution Data" +} +}, +"type": "object" +}, "AccessSparkApplicationResponse": { "description": "A summary of Spark Application", "id": "AccessSparkApplicationResponse", @@ -5700,6 +6013,73 @@ }, "type": "object" }, +"AttachmentOperationMetadata": { +"description": "Metadata describing the Attachment operation.", +"id": "AttachmentOperationMetadata", +"properties": { +"attachment": { +"description": "Output only. Name of the attachment for the operation.", +"readOnly": true, +"type": "string" +}, +"attachmentUuid": { +"description": "Output only. Attachment UUID for the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time when the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Output only. Short description of the operation.", +"readOnly": true, +"type": "string" +}, +"doneTime": { +"description": "Output only. The time when the operation finished.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. Labels associated with the operation.", +"readOnly": true, +"type": "object" +}, +"operationType": { +"description": "Output only. The operation type.", +"enum": [ +"ATTACHMENT_OPERATION_TYPE_UNSPECIFIED", +"CREATE", +"UPDATE", +"DELETE" +], +"enumDescriptions": [ +"Attachment operation type is unknown.", +"Create Attachment operation type.", +"Update Attachment operation type.", +"Delete Attachment operation type." +], +"readOnly": true, +"type": "string" +}, +"warnings": { +"description": "Output only. Warnings encountered during operation execution.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "AuthenticationConfig": { "description": "Authentication configuration for a workload is used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s).", "id": "AuthenticationConfig", @@ -6567,6 +6947,20 @@ }, "type": "object" }, +"ComputeTuningConfigResponse": { +"description": "Response for ComputeTuningConfig RPC.", +"id": "ComputeTuningConfigResponse", +"properties": { +"recommendedProperties": { +"additionalProperties": { +"type": "string" +}, +"description": "Recommended Spark properties for the query (e.g., {\"spark.sql.shuffle.partitions\": \"500\"}).", +"type": "object" +} +}, +"type": "object" +}, "ConfidentialInstanceConfig": { "description": "Confidential Instance Config for clusters using Confidential VMs (https://cloud.google.com/confidential-computing/confidential-vm/docs)", "id": "ConfidentialInstanceConfig", @@ -7757,6 +8151,10 @@ "description": "Identity related configuration, including service account based secure multi-tenancy user mappings.", "id": "IdentityConfig", "properties": { +"enableSsh": { +"description": "Optional. Whether to enable SSH access for the cluster. The default is true for image versions prior to 3.1 and false for image versions 3.1 and later. The default behavior can be changed when creating clusters using image versions 2.3.30 and later.", +"type": "boolean" +}, "userServiceAccountMapping": { "additionalProperties": { "type": "string" @@ -10330,6 +10728,25 @@ }, "type": "object" }, +"SearchSessionSparkApplicationNativeSqlQueriesResponse": { +"description": "List of all Native queries for a Spark Application.", +"id": "SearchSessionSparkApplicationNativeSqlQueriesResponse", +"properties": { +"nextPageToken": { +"description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationSqlQueriesRequest.", +"type": "string" +}, +"sparkApplicationNativeSqlQueries": { +"description": "Output only. Native SQL Execution Data", +"items": { +"$ref": "NativeSqlExecutionUiData" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "SearchSessionSparkApplicationSqlQueriesResponse": { "description": "List of all queries for a Spark Application.", "id": "SearchSessionSparkApplicationSqlQueriesResponse", @@ -10480,6 +10897,25 @@ }, "type": "object" }, +"SearchSparkApplicationNativeSqlQueriesResponse": { +"description": "List of all Native SQL queries details for a Spark Application.", +"id": "SearchSparkApplicationNativeSqlQueriesResponse", +"properties": { +"nextPageToken": { +"description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationNativeSqlQueriesRequest.", +"type": "string" +}, +"sparkApplicationNativeSqlQueries": { +"description": "Output only. Native SQL Execution Data", +"items": { +"$ref": "NativeSqlExecutionUiData" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "SearchSparkApplicationSqlQueriesResponse": { "description": "List of all queries for a Spark Application.", "id": "SearchSparkApplicationSqlQueriesResponse", From a2199a206ae26b100431594377645e5fe0eece84 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:03 +0000 Subject: [PATCH 40/84] feat(datastream): update the api #### datastream:v1 The following keys were added: - schemas.ConnectionProfile.properties.workdayProfile.$ref (Total Keys: 1) - schemas.OauthRefreshTokenCredentials (Total Keys: 4) - schemas.SourceConfig.properties.workdaySourceConfig.$ref (Total Keys: 1) - schemas.WorkdayProfile (Total Keys: 5) - schemas.WorkdaySourceConfig (Total Keys: 6) --- ...projects.locations.connectionProfiles.html | 85 +++++++++++ ...astream_v1.projects.locations.streams.html | 140 ++++++++++++++++++ .../documents/datastream.v1.json | 68 ++++++++- .../documents/datastream.v1alpha1.json | 6 +- 4 files changed, 293 insertions(+), 6 deletions(-) diff --git a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html index 337a3f5be3..63e2c6bb15 100644 --- a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html +++ b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html @@ -312,6 +312,23 @@

Method Details

"staticServiceIpConnectivity": { # Static IP address connectivity. Used when the source database is configured to allow incoming connections from the Datastream public IP addresses for the region specified in the connection profile. # Static Service IP connectivity. }, "updateTime": "A String", # Output only. The update time of the resource. + "workdayProfile": { # Profile for connecting to a Workday source. # Optional. Profile for connecting to a Workday source. + "host": "A String", # Required. Host for the Workday connection. Must be a valid hostname (e.g., `wd3-impl-services1.workday.com`). + "oauthRefreshTokenCredentials": { # OAuth Refresh Token Credentials. # Required. Credentials for authenticating with the Workday API. OAuth Refresh Token credentials for authenticating with the Workday API. + "oauthClientCredentials": { # OAuth Client Credentials. # Required. Specifies the OAuth Client Credentials. + "clientId": "A String", # Required. Client ID for OAuth Client Credentials. + "clientSecret": { # A confidential piece of information where the actual value is either directly specified in the message as a raw string or stored in GCP secret manager. # Required. Client secret for OAuth Client Credentials. + "rawValue": "A String", # Optional. Input only. The actual raw value of the secret as plain text. + "secretVersion": "A String", # Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats: * projects/{project}/locations/{location}/secrets/{secret}/versions/{version} * projects/{project}/secrets/{secret}/versions/{version} + }, + }, + "refreshToken": { # A confidential piece of information where the actual value is either directly specified in the message as a raw string or stored in GCP secret manager. # Required. Specifies the OAuth Refresh Token. + "rawValue": "A String", # Optional. Input only. The actual raw value of the secret as plain text. + "secretVersion": "A String", # Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats: * projects/{project}/locations/{location}/secrets/{secret}/versions/{version} * projects/{project}/secrets/{secret}/versions/{version} + }, + }, + "tenant": "A String", # Required. Tenant for the Workday connection (e.g., `google12`). + }, } connectionProfileId: string, Required. The connection profile identifier. @@ -592,6 +609,23 @@

Method Details

"staticServiceIpConnectivity": { # Static IP address connectivity. Used when the source database is configured to allow incoming connections from the Datastream public IP addresses for the region specified in the connection profile. # Static Service IP connectivity. }, "updateTime": "A String", # Output only. The update time of the resource. + "workdayProfile": { # Profile for connecting to a Workday source. # Optional. Profile for connecting to a Workday source. + "host": "A String", # Required. Host for the Workday connection. Must be a valid hostname (e.g., `wd3-impl-services1.workday.com`). + "oauthRefreshTokenCredentials": { # OAuth Refresh Token Credentials. # Required. Credentials for authenticating with the Workday API. OAuth Refresh Token credentials for authenticating with the Workday API. + "oauthClientCredentials": { # OAuth Client Credentials. # Required. Specifies the OAuth Client Credentials. + "clientId": "A String", # Required. Client ID for OAuth Client Credentials. + "clientSecret": { # A confidential piece of information where the actual value is either directly specified in the message as a raw string or stored in GCP secret manager. # Required. Client secret for OAuth Client Credentials. + "rawValue": "A String", # Optional. Input only. The actual raw value of the secret as plain text. + "secretVersion": "A String", # Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats: * projects/{project}/locations/{location}/secrets/{secret}/versions/{version} * projects/{project}/secrets/{secret}/versions/{version} + }, + }, + "refreshToken": { # A confidential piece of information where the actual value is either directly specified in the message as a raw string or stored in GCP secret manager. # Required. Specifies the OAuth Refresh Token. + "rawValue": "A String", # Optional. Input only. The actual raw value of the secret as plain text. + "secretVersion": "A String", # Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats: * projects/{project}/locations/{location}/secrets/{secret}/versions/{version} * projects/{project}/secrets/{secret}/versions/{version} + }, + }, + "tenant": "A String", # Required. Tenant for the Workday connection (e.g., `google12`). + }, }, "connectionProfileName": "A String", # Optional. A reference to an existing connection profile. "fullHierarchy": True or False, # Optional. Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE). @@ -1153,6 +1187,23 @@

Method Details

"staticServiceIpConnectivity": { # Static IP address connectivity. Used when the source database is configured to allow incoming connections from the Datastream public IP addresses for the region specified in the connection profile. # Static Service IP connectivity. }, "updateTime": "A String", # Output only. The update time of the resource. + "workdayProfile": { # Profile for connecting to a Workday source. # Optional. Profile for connecting to a Workday source. + "host": "A String", # Required. Host for the Workday connection. Must be a valid hostname (e.g., `wd3-impl-services1.workday.com`). + "oauthRefreshTokenCredentials": { # OAuth Refresh Token Credentials. # Required. Credentials for authenticating with the Workday API. OAuth Refresh Token credentials for authenticating with the Workday API. + "oauthClientCredentials": { # OAuth Client Credentials. # Required. Specifies the OAuth Client Credentials. + "clientId": "A String", # Required. Client ID for OAuth Client Credentials. + "clientSecret": { # A confidential piece of information where the actual value is either directly specified in the message as a raw string or stored in GCP secret manager. # Required. Client secret for OAuth Client Credentials. + "rawValue": "A String", # Optional. Input only. The actual raw value of the secret as plain text. + "secretVersion": "A String", # Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats: * projects/{project}/locations/{location}/secrets/{secret}/versions/{version} * projects/{project}/secrets/{secret}/versions/{version} + }, + }, + "refreshToken": { # A confidential piece of information where the actual value is either directly specified in the message as a raw string or stored in GCP secret manager. # Required. Specifies the OAuth Refresh Token. + "rawValue": "A String", # Optional. Input only. The actual raw value of the secret as plain text. + "secretVersion": "A String", # Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats: * projects/{project}/locations/{location}/secrets/{secret}/versions/{version} * projects/{project}/secrets/{secret}/versions/{version} + }, + }, + "tenant": "A String", # Required. Tenant for the Workday connection (e.g., `google12`). + }, }
@@ -1375,6 +1426,23 @@

Method Details

"staticServiceIpConnectivity": { # Static IP address connectivity. Used when the source database is configured to allow incoming connections from the Datastream public IP addresses for the region specified in the connection profile. # Static Service IP connectivity. }, "updateTime": "A String", # Output only. The update time of the resource. + "workdayProfile": { # Profile for connecting to a Workday source. # Optional. Profile for connecting to a Workday source. + "host": "A String", # Required. Host for the Workday connection. Must be a valid hostname (e.g., `wd3-impl-services1.workday.com`). + "oauthRefreshTokenCredentials": { # OAuth Refresh Token Credentials. # Required. Credentials for authenticating with the Workday API. OAuth Refresh Token credentials for authenticating with the Workday API. + "oauthClientCredentials": { # OAuth Client Credentials. # Required. Specifies the OAuth Client Credentials. + "clientId": "A String", # Required. Client ID for OAuth Client Credentials. + "clientSecret": { # A confidential piece of information where the actual value is either directly specified in the message as a raw string or stored in GCP secret manager. # Required. Client secret for OAuth Client Credentials. + "rawValue": "A String", # Optional. Input only. The actual raw value of the secret as plain text. + "secretVersion": "A String", # Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats: * projects/{project}/locations/{location}/secrets/{secret}/versions/{version} * projects/{project}/secrets/{secret}/versions/{version} + }, + }, + "refreshToken": { # A confidential piece of information where the actual value is either directly specified in the message as a raw string or stored in GCP secret manager. # Required. Specifies the OAuth Refresh Token. + "rawValue": "A String", # Optional. Input only. The actual raw value of the secret as plain text. + "secretVersion": "A String", # Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats: * projects/{project}/locations/{location}/secrets/{secret}/versions/{version} * projects/{project}/secrets/{secret}/versions/{version} + }, + }, + "tenant": "A String", # Required. Tenant for the Workday connection (e.g., `google12`). + }, }, ], "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. @@ -1606,6 +1674,23 @@

Method Details

"staticServiceIpConnectivity": { # Static IP address connectivity. Used when the source database is configured to allow incoming connections from the Datastream public IP addresses for the region specified in the connection profile. # Static Service IP connectivity. }, "updateTime": "A String", # Output only. The update time of the resource. + "workdayProfile": { # Profile for connecting to a Workday source. # Optional. Profile for connecting to a Workday source. + "host": "A String", # Required. Host for the Workday connection. Must be a valid hostname (e.g., `wd3-impl-services1.workday.com`). + "oauthRefreshTokenCredentials": { # OAuth Refresh Token Credentials. # Required. Credentials for authenticating with the Workday API. OAuth Refresh Token credentials for authenticating with the Workday API. + "oauthClientCredentials": { # OAuth Client Credentials. # Required. Specifies the OAuth Client Credentials. + "clientId": "A String", # Required. Client ID for OAuth Client Credentials. + "clientSecret": { # A confidential piece of information where the actual value is either directly specified in the message as a raw string or stored in GCP secret manager. # Required. Client secret for OAuth Client Credentials. + "rawValue": "A String", # Optional. Input only. The actual raw value of the secret as plain text. + "secretVersion": "A String", # Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats: * projects/{project}/locations/{location}/secrets/{secret}/versions/{version} * projects/{project}/secrets/{secret}/versions/{version} + }, + }, + "refreshToken": { # A confidential piece of information where the actual value is either directly specified in the message as a raw string or stored in GCP secret manager. # Required. Specifies the OAuth Refresh Token. + "rawValue": "A String", # Optional. Input only. The actual raw value of the secret as plain text. + "secretVersion": "A String", # Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats: * projects/{project}/locations/{location}/secrets/{secret}/versions/{version} * projects/{project}/secrets/{secret}/versions/{version} + }, + }, + "tenant": "A String", # Required. Tenant for the Workday connection (e.g., `google12`). + }, } force: boolean, Optional. Update the connection profile without validating it. diff --git a/docs/dyn/datastream_v1.projects.locations.streams.html b/docs/dyn/datastream_v1.projects.locations.streams.html index 41ca6c4391..dc9ea3997a 100644 --- a/docs/dyn/datastream_v1.projects.locations.streams.html +++ b/docs/dyn/datastream_v1.projects.locations.streams.html @@ -868,6 +868,41 @@

Method Details

"transactionLogs": { # Configuration to use Transaction Logs CDC read method. # CDC reader reads from transaction logs. }, }, + "workdaySourceConfig": { # Configuration for syncing data from a Workday source. # Optional. Workday data source configuration. + "excludeObjects": { # Source catalog. # Optional. The objects to exclude from the stream. + "objects": [ # Optional. Source objects in the catalog. + { # Source object. + "objectName": "A String", # Required. The object name. + "properties": [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Source property. + "primaryKey": True or False, # Optional. Whether or not the property is a primary key. + "properties": [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + # Object with schema name: SourceProperty + ], + "propertyName": "A String", # Required. The property name. + }, + ], + }, + ], + }, + "includeObjects": { # Source catalog. # Optional. The objects to retrieve from the source. + "objects": [ # Optional. Source objects in the catalog. + { # Source object. + "objectName": "A String", # Required. The object name. + "properties": [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Source property. + "primaryKey": True or False, # Optional. Whether or not the property is a primary key. + "properties": [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + # Object with schema name: SourceProperty + ], + "propertyName": "A String", # Required. The property name. + }, + ], + }, + ], + }, + "pollingInterval": "A String", # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive. + }, }, "state": "A String", # The state of the stream. "updateTime": "A String", # Output only. The last update time of the stream. @@ -1706,6 +1741,41 @@

Method Details

"transactionLogs": { # Configuration to use Transaction Logs CDC read method. # CDC reader reads from transaction logs. }, }, + "workdaySourceConfig": { # Configuration for syncing data from a Workday source. # Optional. Workday data source configuration. + "excludeObjects": { # Source catalog. # Optional. The objects to exclude from the stream. + "objects": [ # Optional. Source objects in the catalog. + { # Source object. + "objectName": "A String", # Required. The object name. + "properties": [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Source property. + "primaryKey": True or False, # Optional. Whether or not the property is a primary key. + "properties": [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + # Object with schema name: SourceProperty + ], + "propertyName": "A String", # Required. The property name. + }, + ], + }, + ], + }, + "includeObjects": { # Source catalog. # Optional. The objects to retrieve from the source. + "objects": [ # Optional. Source objects in the catalog. + { # Source object. + "objectName": "A String", # Required. The object name. + "properties": [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Source property. + "primaryKey": True or False, # Optional. Whether or not the property is a primary key. + "properties": [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + # Object with schema name: SourceProperty + ], + "propertyName": "A String", # Required. The property name. + }, + ], + }, + ], + }, + "pollingInterval": "A String", # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive. + }, }, "state": "A String", # The state of the stream. "updateTime": "A String", # Output only. The last update time of the stream. @@ -2483,6 +2553,41 @@

Method Details

"transactionLogs": { # Configuration to use Transaction Logs CDC read method. # CDC reader reads from transaction logs. }, }, + "workdaySourceConfig": { # Configuration for syncing data from a Workday source. # Optional. Workday data source configuration. + "excludeObjects": { # Source catalog. # Optional. The objects to exclude from the stream. + "objects": [ # Optional. Source objects in the catalog. + { # Source object. + "objectName": "A String", # Required. The object name. + "properties": [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Source property. + "primaryKey": True or False, # Optional. Whether or not the property is a primary key. + "properties": [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + # Object with schema name: SourceProperty + ], + "propertyName": "A String", # Required. The property name. + }, + ], + }, + ], + }, + "includeObjects": { # Source catalog. # Optional. The objects to retrieve from the source. + "objects": [ # Optional. Source objects in the catalog. + { # Source object. + "objectName": "A String", # Required. The object name. + "properties": [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Source property. + "primaryKey": True or False, # Optional. Whether or not the property is a primary key. + "properties": [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + # Object with schema name: SourceProperty + ], + "propertyName": "A String", # Required. The property name. + }, + ], + }, + ], + }, + "pollingInterval": "A String", # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive. + }, }, "state": "A String", # The state of the stream. "updateTime": "A String", # Output only. The last update time of the stream. @@ -3267,6 +3372,41 @@

Method Details

"transactionLogs": { # Configuration to use Transaction Logs CDC read method. # CDC reader reads from transaction logs. }, }, + "workdaySourceConfig": { # Configuration for syncing data from a Workday source. # Optional. Workday data source configuration. + "excludeObjects": { # Source catalog. # Optional. The objects to exclude from the stream. + "objects": [ # Optional. Source objects in the catalog. + { # Source object. + "objectName": "A String", # Required. The object name. + "properties": [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Source property. + "primaryKey": True or False, # Optional. Whether or not the property is a primary key. + "properties": [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + # Object with schema name: SourceProperty + ], + "propertyName": "A String", # Required. The property name. + }, + ], + }, + ], + }, + "includeObjects": { # Source catalog. # Optional. The objects to retrieve from the source. + "objects": [ # Optional. Source objects in the catalog. + { # Source object. + "objectName": "A String", # Required. The object name. + "properties": [ # Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + { # Source property. + "primaryKey": True or False, # Optional. Whether or not the property is a primary key. + "properties": [ # Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + # Object with schema name: SourceProperty + ], + "propertyName": "A String", # Required. The property name. + }, + ], + }, + ], + }, + "pollingInterval": "A String", # Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive. + }, }, "state": "A String", # The state of the stream. "updateTime": "A String", # Output only. The last update time of the stream. diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index c500b853ad..33683f588b 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -1493,7 +1493,7 @@ } } }, -"revision": "20260623", +"revision": "20260719", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -1909,6 +1909,10 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"workdayProfile": { +"$ref": "WorkdayProfile", +"description": "Optional. Profile for connecting to a Workday source." } }, "type": "object" @@ -2198,7 +2202,7 @@ "type": "object" }, "reason": { -"description": "The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", +"description": "The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", "type": "string" } }, @@ -2250,7 +2254,7 @@ "description": "Provides a localized error message for field-level errors that is safe to return to the API consumer." }, "reason": { -"description": "The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", +"description": "The reason for the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", "type": "string" } }, @@ -3206,6 +3210,21 @@ }, "type": "object" }, +"OauthRefreshTokenCredentials": { +"description": "OAuth Refresh Token Credentials.", +"id": "OauthRefreshTokenCredentials", +"properties": { +"oauthClientCredentials": { +"$ref": "OauthClientCredentials", +"description": "Required. Specifies the OAuth Client Credentials." +}, +"refreshToken": { +"$ref": "Secret", +"description": "Required. Specifies the OAuth Refresh Token." +} +}, +"type": "object" +}, "ObjectFilter": { "description": "Object filter to apply the rules to.", "id": "ObjectFilter", @@ -4394,6 +4413,10 @@ "sqlServerSourceConfig": { "$ref": "SqlServerSourceConfig", "description": "SQLServer data source configuration." +}, +"workdaySourceConfig": { +"$ref": "WorkdaySourceConfig", +"description": "Optional. Workday data source configuration." } }, "type": "object" @@ -5344,6 +5367,45 @@ } }, "type": "object" +}, +"WorkdayProfile": { +"description": "Profile for connecting to a Workday source.", +"id": "WorkdayProfile", +"properties": { +"host": { +"description": "Required. Host for the Workday connection. Must be a valid hostname (e.g., `wd3-impl-services1.workday.com`).", +"type": "string" +}, +"oauthRefreshTokenCredentials": { +"$ref": "OauthRefreshTokenCredentials", +"description": "Required. Credentials for authenticating with the Workday API. OAuth Refresh Token credentials for authenticating with the Workday API." +}, +"tenant": { +"description": "Required. Tenant for the Workday connection (e.g., `google12`).", +"type": "string" +} +}, +"type": "object" +}, +"WorkdaySourceConfig": { +"description": "Configuration for syncing data from a Workday source.", +"id": "WorkdaySourceConfig", +"properties": { +"excludeObjects": { +"$ref": "SourceCatalog", +"description": "Optional. The objects to exclude from the stream." +}, +"includeObjects": { +"$ref": "SourceCatalog", +"description": "Optional. The objects to retrieve from the source." +}, +"pollingInterval": { +"description": "Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json index 3f8f499b8c..d6fa332b7b 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json @@ -1462,7 +1462,7 @@ } } }, -"revision": "20260623", +"revision": "20260719", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AvroFileFormat": { @@ -1777,7 +1777,7 @@ "type": "object" }, "reason": { -"description": "The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", +"description": "The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", "type": "string" } }, @@ -1838,7 +1838,7 @@ "description": "Provides a localized error message for field-level errors that is safe to return to the API consumer." }, "reason": { -"description": "The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", +"description": "The reason for the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", "type": "string" } }, From 5c85b8a1cd35efd41db902f9ef37a5322a322c8c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:03 +0000 Subject: [PATCH 41/84] feat(developerknowledge): update the api #### developerknowledge:v1 The following keys were added: - resources.v1.methods.answerQuery (Total Keys: 8) - schemas.Answer (Total Keys: 30) - schemas.CitationSource (Total Keys: 5) - schemas.DocumentReference (Total Keys: 4) --- docs/dyn/developerknowledge_v1.documents.html | 2 +- docs/dyn/developerknowledge_v1.html | 5 + docs/dyn/developerknowledge_v1.v1.html | 149 ++++++++++++++++++ .../developerknowledge_v1alpha.documents.html | 2 +- .../documents/developerknowledge.v1.json | 139 +++++++++++++++- .../documents/developerknowledge.v1alpha.json | 4 +- 6 files changed, 295 insertions(+), 6 deletions(-) create mode 100644 docs/dyn/developerknowledge_v1.v1.html diff --git a/docs/dyn/developerknowledge_v1.documents.html b/docs/dyn/developerknowledge_v1.documents.html index 3689f8318b..a465c3f67b 100644 --- a/docs/dyn/developerknowledge_v1.documents.html +++ b/docs/dyn/developerknowledge_v1.documents.html @@ -170,7 +170,7 @@

Method Details

Searches for developer knowledge across Google's developer documentation. Returns DocumentChunks based on the user's query. There may be many chunks from the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results.
 
 Args:
-  filter: string, Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `content_length_bytes` (INTEGER): The length of the `Document.content` field in bytes. * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * Filter by `Document.content_length_bytes`: `content_length_bytes < 50000` * `data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"` * `data_source != "firebase.google.com"` * `update_time < "2024-01-01T00:00:00Z"` * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")` * `uri = "https://docs.cloud.google.com/release-notes"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.
+  filter: string, Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. Note: Field names must be in `snake_case` (e.g., `data_source`). Values on the right-hand side of filtering expressions must be string literals enclosed in double quotes (e.g., `"docs.cloud.google.com"`). You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * `data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"` * `data_source != "firebase.google.com"` * `update_time < "2024-01-01T00:00:00Z"` * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")` * `uri = "https://docs.cloud.google.com/release-notes"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.
   pageSize: integer, Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 100; values above 100 will be coerced to 100.
   pageToken: string, Optional. Contains a page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page.
   query: string, Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?".
diff --git a/docs/dyn/developerknowledge_v1.html b/docs/dyn/developerknowledge_v1.html
index d569342e71..7117f84c00 100644
--- a/docs/dyn/developerknowledge_v1.html
+++ b/docs/dyn/developerknowledge_v1.html
@@ -79,6 +79,11 @@ 

Instance Methods

Returns the documents Resource.

+

+ v1() +

+

Returns the v1 Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/developerknowledge_v1.v1.html b/docs/dyn/developerknowledge_v1.v1.html new file mode 100644 index 0000000000..07c36c42a0 --- /dev/null +++ b/docs/dyn/developerknowledge_v1.v1.html @@ -0,0 +1,149 @@ + + + +

Developer Knowledge API . v1

+

Instance Methods

+

+ answerQuery(body=None, x__xgafv=None)

+

Answers a query using grounded generation.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ answerQuery(body=None, x__xgafv=None) +
Answers a query using grounded generation.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for DeveloperKnowledge.AnswerQuery.
+  "query": "A String", # Required. The query to answer.
+}
+
+  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 DeveloperKnowledge.AnswerQuery.
+  "answer": { # An answer to a query. # The answer to the query.
+    "answerText": "A String", # Contains the text of the answer.
+    "citations": [ # Output only. Contains citations for the answer.
+      { # Citation info for a segment.
+        "endIndex": 42, # Output only. Indicates the end of the segment, measured in bytes (UTF-8 unicode), exclusive. If there are multi-byte characters, such as non-ASCII characters, the index measurement is longer than the string length.
+        "sources": [ # Output only. Contains citation sources for the attributed segment.
+          { # Citation source.
+            "referenceIndex": 42, # Output only. Contains the index of the Answer.AnswerReference in the `references` repeated field.
+          },
+        ],
+        "startIndex": 42, # Output only. Indicates the start of the segment, measured in bytes (UTF-8 unicode), inclusive. If there are multi-byte characters, such as non-ASCII characters, the index measurement is longer than the string length.
+      },
+    ],
+    "references": [ # Output only. Contains references for the answer.
+      { # Represents a reference to a source.
+        "documentReference": { # Represents a reference to a document. # Output only. The reference document.
+          "documentChunk": { # A DocumentChunk represents a piece of content from a Document in the DeveloperKnowledge corpus. To fetch the entire document content, pass the `parent` to DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments. # Output only. Contains the document chunk. The `document_chunk.id` field is not set and will be empty.
+            "content": "A String", # Output only. Contains the content of the document chunk.
+            "document": { # A Document represents a piece of content from the Developer Knowledge corpus. # Output only. Represents metadata about the Document this chunk is from. The DocumentView of this Document message will be set to `DOCUMENT_VIEW_BASIC`. It is included here for convenience so that clients do not need to call DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments if they only need the metadata fields. Otherwise, clients should use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to fetch the full document content.
+              "content": "A String", # Output only. Contains the full content of the document in Markdown format.
+              "contentLengthBytes": 42, # Output only. The length of the `content` field in bytes.
+              "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com`
+              "description": "A String", # Output only. Provides a description of the document.
+              "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`.
+              "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.
+            "parent": "A String", # Output only. Contains the resource name of the document this chunk is from. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`
+          },
+        },
+      },
+    ],
+  },
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/developerknowledge_v1alpha.documents.html b/docs/dyn/developerknowledge_v1alpha.documents.html index 445505f9c5..4169515292 100644 --- a/docs/dyn/developerknowledge_v1alpha.documents.html +++ b/docs/dyn/developerknowledge_v1alpha.documents.html @@ -170,7 +170,7 @@

Method Details

Searches for developer knowledge across Google's developer documentation. Returns DocumentChunks based on the user's query. There may be many chunks from the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results.
 
 Args:
-  filter: string, Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `content_length_bytes` (INTEGER): The length of the `Document.content` field in bytes. * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * Filter by `Document.content_length_bytes`: `content_length_bytes < 50000` * `data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"` * `data_source != "firebase.google.com"` * `update_time < "2024-01-01T00:00:00Z"` * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")` * `uri = "https://docs.cloud.google.com/release-notes"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.
+  filter: string, Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. Note: Field names must be in `snake_case` (e.g., `data_source`). Values on the right-hand side of filtering expressions must be string literals enclosed in double quotes (e.g., `"docs.cloud.google.com"`). You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * `data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"` * `data_source != "firebase.google.com"` * `update_time < "2024-01-01T00:00:00Z"` * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")` * `uri = "https://docs.cloud.google.com/release-notes"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.
   pageSize: integer, Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 100; values above 100 will be coerced to 100.
   pageToken: string, Optional. Contains a page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page.
   query: string, Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?".
diff --git a/googleapiclient/discovery_cache/documents/developerknowledge.v1.json b/googleapiclient/discovery_cache/documents/developerknowledge.v1.json
index d02b004311..ea89be391b 100644
--- a/googleapiclient/discovery_cache/documents/developerknowledge.v1.json
+++ b/googleapiclient/discovery_cache/documents/developerknowledge.v1.json
@@ -196,7 +196,7 @@
 "parameterOrder": [],
 "parameters": {
 "filter": {
-"description": "Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `content_length_bytes` (INTEGER): The length of the `Document.content` field in bytes. * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `\"2025-01-01T00:00:00Z\"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * Filter by `Document.content_length_bytes`: `content_length_bytes < 50000` * `data_source = \"docs.cloud.google.com\" OR data_source = \"firebase.google.com\"` * `data_source != \"firebase.google.com\"` * `update_time < \"2024-01-01T00:00:00Z\"` * `update_time >= \"2025-01-22T00:00:00Z\" AND (data_source = \"developer.chrome.com\" OR data_source = \"web.dev\")` * `uri = \"https://docs.cloud.google.com/release-notes\"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.",
+"description": "Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `\"2025-01-01T00:00:00Z\"`. Note: Field names must be in `snake_case` (e.g., `data_source`). Values on the right-hand side of filtering expressions must be string literals enclosed in double quotes (e.g., `\"docs.cloud.google.com\"`). You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * `data_source = \"docs.cloud.google.com\" OR data_source = \"firebase.google.com\"` * `data_source != \"firebase.google.com\"` * `update_time < \"2024-01-01T00:00:00Z\"` * `update_time >= \"2025-01-22T00:00:00Z\" AND (data_source = \"developer.chrome.com\" OR data_source = \"web.dev\")` * `uri = \"https://docs.cloud.google.com/release-notes\"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.",
 "location": "query",
 "type": "string"
 },
@@ -226,11 +226,121 @@
 ]
 }
 }
+},
+"v1": {
+"methods": {
+"answerQuery": {
+"description": "Answers a query using grounded generation.",
+"flatPath": "v1:answerQuery",
+"httpMethod": "POST",
+"id": "developerknowledge.answerQuery",
+"parameterOrder": [],
+"parameters": {},
+"path": "v1:answerQuery",
+"request": {
+"$ref": "AnswerQueryRequest"
+},
+"response": {
+"$ref": "AnswerQueryResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
 }
 },
-"revision": "20260705",
+"revision": "20260719",
 "rootUrl": "https://developerknowledge.googleapis.com/",
 "schemas": {
+"Answer": {
+"description": "An answer to a query.",
+"id": "Answer",
+"properties": {
+"answerText": {
+"description": "Contains the text of the answer.",
+"type": "string"
+},
+"citations": {
+"description": "Output only. Contains citations for the answer.",
+"items": {
+"$ref": "AnswerCitation"
+},
+"readOnly": true,
+"type": "array"
+},
+"references": {
+"description": "Output only. Contains references for the answer.",
+"items": {
+"$ref": "AnswerReference"
+},
+"readOnly": true,
+"type": "array"
+}
+},
+"type": "object"
+},
+"AnswerCitation": {
+"description": "Citation info for a segment.",
+"id": "AnswerCitation",
+"properties": {
+"endIndex": {
+"description": "Output only. Indicates the end of the segment, measured in bytes (UTF-8 unicode), exclusive. If there are multi-byte characters, such as non-ASCII characters, the index measurement is longer than the string length.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"sources": {
+"description": "Output only. Contains citation sources for the attributed segment.",
+"items": {
+"$ref": "CitationSource"
+},
+"readOnly": true,
+"type": "array"
+},
+"startIndex": {
+"description": "Output only. Indicates the start of the segment, measured in bytes (UTF-8 unicode), inclusive. If there are multi-byte characters, such as non-ASCII characters, the index measurement is longer than the string length.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+}
+},
+"type": "object"
+},
+"AnswerQueryRequest": {
+"description": "Request message for DeveloperKnowledge.AnswerQuery.",
+"id": "AnswerQueryRequest",
+"properties": {
+"query": {
+"description": "Required. The query to answer.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"AnswerQueryResponse": {
+"description": "Response message for DeveloperKnowledge.AnswerQuery.",
+"id": "AnswerQueryResponse",
+"properties": {
+"answer": {
+"$ref": "Answer",
+"description": "The answer to the query."
+}
+},
+"type": "object"
+},
+"AnswerReference": {
+"description": "Represents a reference to a source.",
+"id": "AnswerReference",
+"properties": {
+"documentReference": {
+"$ref": "DocumentReference",
+"description": "Output only. The reference document.",
+"readOnly": true
+}
+},
+"type": "object"
+},
 "BatchGetDocumentsResponse": {
 "description": "Response message for DeveloperKnowledge.BatchGetDocuments.",
 "id": "BatchGetDocumentsResponse",
@@ -245,6 +355,19 @@
 },
 "type": "object"
 },
+"CitationSource": {
+"description": "Citation source.",
+"id": "CitationSource",
+"properties": {
+"referenceIndex": {
+"description": "Output only. Contains the index of the Answer.AnswerReference in the `references` repeated field.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+}
+},
+"type": "object"
+},
 "Document": {
 "description": "A Document represents a piece of content from the Developer Knowledge corpus.",
 "id": "Document",
@@ -337,6 +460,18 @@
 },
 "type": "object"
 },
+"DocumentReference": {
+"description": "Represents a reference to a document.",
+"id": "DocumentReference",
+"properties": {
+"documentChunk": {
+"$ref": "DocumentChunk",
+"description": "Output only. Contains the document chunk. The `document_chunk.id` field is not set and will be empty.",
+"readOnly": true
+}
+},
+"type": "object"
+},
 "SearchDocumentChunksResponse": {
 "description": "Response message for DeveloperKnowledge.SearchDocumentChunks.",
 "id": "SearchDocumentChunksResponse",
diff --git a/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json b/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json
index ad4e78dac5..a8f9c752a7 100644
--- a/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json
@@ -196,7 +196,7 @@
 "parameterOrder": [],
 "parameters": {
 "filter": {
-"description": "Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `content_length_bytes` (INTEGER): The length of the `Document.content` field in bytes. * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `\"2025-01-01T00:00:00Z\"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * Filter by `Document.content_length_bytes`: `content_length_bytes < 50000` * `data_source = \"docs.cloud.google.com\" OR data_source = \"firebase.google.com\"` * `data_source != \"firebase.google.com\"` * `update_time < \"2024-01-01T00:00:00Z\"` * `update_time >= \"2025-01-22T00:00:00Z\" AND (data_source = \"developer.chrome.com\" OR data_source = \"web.dev\")` * `uri = \"https://docs.cloud.google.com/release-notes\"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.",
+"description": "Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `\"2025-01-01T00:00:00Z\"`. Note: Field names must be in `snake_case` (e.g., `data_source`). Values on the right-hand side of filtering expressions must be string literals enclosed in double quotes (e.g., `\"docs.cloud.google.com\"`). You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * `data_source = \"docs.cloud.google.com\" OR data_source = \"firebase.google.com\"` * `data_source != \"firebase.google.com\"` * `update_time < \"2024-01-01T00:00:00Z\"` * `update_time >= \"2025-01-22T00:00:00Z\" AND (data_source = \"developer.chrome.com\" OR data_source = \"web.dev\")` * `uri = \"https://docs.cloud.google.com/release-notes\"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.",
 "location": "query",
 "type": "string"
 },
@@ -250,7 +250,7 @@
 }
 }
 },
-"revision": "20260705",
+"revision": "20260719",
 "rootUrl": "https://developerknowledge.googleapis.com/",
 "schemas": {
 "Answer": {

From 5fea8f0b70a0225db6b93f3b2f02dc76f7185b36 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Aug 2026 07:58:04 +0000
Subject: [PATCH 42/84] feat(dfareporting): update the api

#### dfareporting:v5

The following keys were added:
- resources.reportData.methods.query (Total Keys: 12)
- schemas.ColumnHeader (Total Keys: 6)
- schemas.Creative.properties.syntheticContentAttestationStatus.type (Total Keys: 1)
- schemas.ReportDataQueryRequest (Total Keys: 14)
- schemas.ReportDataResponse (Total Keys: 12)
- schemas.ReportDataRow (Total Keys: 5)
- schemas.SortBy (Total Keys: 4)
---
 docs/dyn/dfareporting_v5.creatives.html       |   8 +
 docs/dyn/dfareporting_v5.html                 |   5 +
 docs/dyn/dfareporting_v5.reportData.html      | 179 ++++++++++++++++
 .../dfareporting_v5.tvCampaignDetails.html    |   2 +-
 .../dfareporting_v5.tvCampaignSummaries.html  |   2 +-
 .../documents/dfareporting.v5.json            | 200 +++++++++++++++++-
 6 files changed, 390 insertions(+), 6 deletions(-)
 create mode 100644 docs/dyn/dfareporting_v5.reportData.html

diff --git a/docs/dyn/dfareporting_v5.creatives.html b/docs/dyn/dfareporting_v5.creatives.html
index 8b59ea6b76..3f895e74e9 100644
--- a/docs/dyn/dfareporting_v5.creatives.html
+++ b/docs/dyn/dfareporting_v5.creatives.html
@@ -466,6 +466,7 @@ 

Method Details

"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. + "syntheticContentAttestationStatus": "A String", # Optional. Whether to add a label to the creative as created or edited using AI when served in regions with local AI labeling regulations. [Learn more about labeling requirements in AI regulations.](https://support.google.com/campaignmanager/answer/17232030) "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. @@ -880,6 +881,7 @@

Method Details

"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. + "syntheticContentAttestationStatus": "A String", # Optional. Whether to add a label to the creative as created or edited using AI when served in regions with local AI labeling regulations. [Learn more about labeling requirements in AI regulations.](https://support.google.com/campaignmanager/answer/17232030) "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. @@ -1292,6 +1294,7 @@

Method Details

"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. + "syntheticContentAttestationStatus": "A String", # Optional. Whether to add a label to the creative as created or edited using AI when served in regions with local AI labeling regulations. [Learn more about labeling requirements in AI regulations.](https://support.google.com/campaignmanager/answer/17232030) "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. @@ -1761,6 +1764,7 @@

Method Details

"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. + "syntheticContentAttestationStatus": "A String", # Optional. Whether to add a label to the creative as created or edited using AI when served in regions with local AI labeling regulations. [Learn more about labeling requirements in AI regulations.](https://support.google.com/campaignmanager/answer/17232030) "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. @@ -2194,6 +2198,7 @@

Method Details

"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. + "syntheticContentAttestationStatus": "A String", # Optional. Whether to add a label to the creative as created or edited using AI when served in regions with local AI labeling regulations. [Learn more about labeling requirements in AI regulations.](https://support.google.com/campaignmanager/answer/17232030) "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. @@ -2606,6 +2611,7 @@

Method Details

"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. + "syntheticContentAttestationStatus": "A String", # Optional. Whether to add a label to the creative as created or edited using AI when served in regions with local AI labeling regulations. [Learn more about labeling requirements in AI regulations.](https://support.google.com/campaignmanager/answer/17232030) "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. @@ -3020,6 +3026,7 @@

Method Details

"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. + "syntheticContentAttestationStatus": "A String", # Optional. Whether to add a label to the creative as created or edited using AI when served in regions with local AI labeling regulations. [Learn more about labeling requirements in AI regulations.](https://support.google.com/campaignmanager/answer/17232030) "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. @@ -3432,6 +3439,7 @@

Method Details

"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. + "syntheticContentAttestationStatus": "A String", # Optional. Whether to add a label to the creative as created or edited using AI when served in regions with local AI labeling regulations. [Learn more about labeling requirements in AI regulations.](https://support.google.com/campaignmanager/answer/17232030) "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. diff --git a/docs/dyn/dfareporting_v5.html b/docs/dyn/dfareporting_v5.html index edcffc8bfe..133aa67a5f 100644 --- a/docs/dyn/dfareporting_v5.html +++ b/docs/dyn/dfareporting_v5.html @@ -329,6 +329,11 @@

Instance Methods

Returns the remarketingLists Resource.

+

+ reportData() +

+

Returns the reportData Resource.

+

reports()

diff --git a/docs/dyn/dfareporting_v5.reportData.html b/docs/dyn/dfareporting_v5.reportData.html new file mode 100644 index 0000000000..a0e6308fd9 --- /dev/null +++ b/docs/dyn/dfareporting_v5.reportData.html @@ -0,0 +1,179 @@ + + + +

Campaign Manager 360 API . reportData

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ query(profileId, body=None, x__xgafv=None)

+

Executes an ad-hoc query and returns structured JSON payload data.

+

+ query_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ query(profileId, body=None, x__xgafv=None) +
Executes an ad-hoc query and returns structured JSON payload data.
+
+Args:
+  profileId: string, Required. The Campaign Manager 360 user profile ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request body containing ad-hoc query parameters.
+  "dateRange": { # Represents a date range. # Optional. The requested date range covering the report duration.
+    "endDate": "A String",
+    "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+    "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+    "startDate": "A String",
+  },
+  "dimensionFilters": [ # Optional. The list of dimension values on which report lines are filtered. Utilizes the existing legacy filter message `DimensionValue`.
+    { # Represents a DimensionValue resource.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "id": "A String", # The ID associated with the value if available.
+      "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+      "value": "A String", # The value of the dimension.
+    },
+  ],
+  "dimensionNames": [ # Optional. The list of dimension names to group by.
+    "A String",
+  ],
+  "maxResults": 42, # Optional. Maximum number of result rows to return per page. The default value is 100. The maximum allowed value is 1000. Values above 1000 will be coerced (clamped) down to 1000. Negative values will be rejected.
+  "metricNames": [ # Required. The list of metric names to include.
+    "A String",
+  ],
+  "pageToken": "A String", # Optional. Continuation token for paginating results.
+  "sortBys": [ # Optional. Sort options across either requested dimensions or metrics.
+    { # Specifies the sort configuration for a specific field in the report.
+      "name": "A String", # Required. The dimension or metric field name to sort on.
+      "sortOrder": "A String", # Optional. The sort order of this column.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a response to report data request.
+  "columnHeaders": [ # Output only. Ordered descriptors of the requested column fields.
+    { # A column header in the report.
+      "name": "A String", # Output only. The column name.
+      "type": "A String", # Output only. The column type.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. Token to retrieve the next page of rows, or empty if end of results.
+  "rows": [ # Output only. The resulting set of matching data rows.
+    { # A row of report data.
+      "values": [ # Output only. A single sequential list of all cell values matching column_headers indices exactly. - Metric cells that are suppressed due to Minimum Reporting Standard (MRS) privacy protection constraints return "-".
+        "A String",
+      ],
+    },
+  ],
+  "totalRow": { # A row of report data. # Output only. Singular aggregate total row for the entire query matching the criteria. Column headers apply in the exact same order as data rows. In the total_row: - All dimension columns contain an empty string (""), as aggregation does not apply. - Non-summable metric columns (e.g. Reach metrics) contain an empty string (""), as grand total aggregation cannot be mathematically/logically computed for them.
+    "values": [ # Output only. A single sequential list of all cell values matching column_headers indices exactly. - Metric cells that are suppressed due to Minimum Reporting Standard (MRS) privacy protection constraints return "-".
+      "A String",
+    ],
+  },
+}
+
+ +
+ query_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v5.tvCampaignDetails.html b/docs/dyn/dfareporting_v5.tvCampaignDetails.html index 6cd7425a3f..08fa38dd5b 100644 --- a/docs/dyn/dfareporting_v5.tvCampaignDetails.html +++ b/docs/dyn/dfareporting_v5.tvCampaignDetails.html @@ -98,7 +98,7 @@

Method Details

tvDataProvider: string, Optional. TV data provider. If not specified, defaults to `COMSCORE_NATIONAL_US`. Allowed values INVALID_TV_DATA_PROVIDER - - INTAGE_JP - + INTAGE_JP - Allows populating multiple tvCampaignId filters and tvCampaignEndDate filter on the report. IBOPE_AR - IBOPE_BR - IBOPE_CL - diff --git a/docs/dyn/dfareporting_v5.tvCampaignSummaries.html b/docs/dyn/dfareporting_v5.tvCampaignSummaries.html index c795f0eb6a..f09cbff28e 100644 --- a/docs/dyn/dfareporting_v5.tvCampaignSummaries.html +++ b/docs/dyn/dfareporting_v5.tvCampaignSummaries.html @@ -98,7 +98,7 @@

Method Details

tvDataProvider: string, Optional. TV data provider. If not specified, defaults to `COMSCORE_NATIONAL_US`. Allowed values INVALID_TV_DATA_PROVIDER - - INTAGE_JP - + INTAGE_JP - Allows populating multiple tvCampaignId filters and tvCampaignEndDate filter on the report. IBOPE_AR - IBOPE_BR - IBOPE_CL - diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v5.json b/googleapiclient/discovery_cache/documents/dfareporting.v5.json index 5aa1986df6..aa1eb00b48 100644 --- a/googleapiclient/discovery_cache/documents/dfareporting.v5.json +++ b/googleapiclient/discovery_cache/documents/dfareporting.v5.json @@ -7987,6 +7987,38 @@ } } }, +"reportData": { +"methods": { +"query": { +"description": "Executes an ad-hoc query and returns structured JSON payload data.", +"flatPath": "userprofiles/{profileId}/reportdata/query", +"httpMethod": "POST", +"id": "dfareporting.reportData.query", +"parameterOrder": [ +"profileId" +], +"parameters": { +"profileId": { +"description": "Required. The Campaign Manager 360 user profile ID.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "userprofiles/{profileId}/reportdata/query", +"request": { +"$ref": "ReportDataQueryRequest" +}, +"response": { +"$ref": "ReportDataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/dfareporting" +] +} +} +}, "reports": { "methods": { "delete": { @@ -9485,7 +9517,7 @@ ], "enumDescriptions": [ "", -"", +"Allows populating multiple tvCampaignId filters and tvCampaignEndDate filter on the report.", "", "", "", @@ -9561,7 +9593,7 @@ ], "enumDescriptions": [ "", -"", +"Allows populating multiple tvCampaignId filters and tvCampaignEndDate filter on the report.", "", "", "", @@ -10091,7 +10123,7 @@ } } }, -"revision": "20260527", +"revision": "20260721", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -11911,6 +11943,33 @@ }, "type": "object" }, +"ColumnHeader": { +"description": "A column header in the report.", +"id": "ColumnHeader", +"properties": { +"name": { +"description": "Output only. The column name.", +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Output only. The column type.", +"enum": [ +"COLUMN_TYPE_UNSPECIFIED", +"DIMENSION", +"METRIC" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Dimension.", +"Metric." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "CompanionClickThroughOverride": { "description": "Companion Click-through override.", "id": "CompanionClickThroughOverride", @@ -12495,7 +12554,7 @@ ], "enumDescriptions": [ "", -"", +"Allows populating multiple tvCampaignId filters and tvCampaignEndDate filter on the report.", "", "", "", @@ -12980,6 +13039,20 @@ "format": "int64", "type": "string" }, +"syntheticContentAttestationStatus": { +"description": "Optional. Whether to add a label to the creative as created or edited using AI when served in regions with local AI labeling regulations. [Learn more about labeling requirements in AI regulations.](https://support.google.com/campaignmanager/answer/17232030)", +"enum": [ +"SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED", +"IS_SYNTHETIC", +"NOT_SYNTHETIC" +], +"enumDescriptions": [ +"No attestation has been provided.", +"Attested as created or edited using AI.", +"Attested as not created or edited using AI." +], +"type": "string" +}, "thirdPartyBackupImageImpressionsUrl": { "description": "Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.", "type": "string" @@ -20103,6 +20176,102 @@ }, "type": "object" }, +"ReportDataQueryRequest": { +"description": "The request body containing ad-hoc query parameters.", +"id": "ReportDataQueryRequest", +"properties": { +"dateRange": { +"$ref": "DateRange", +"description": "Optional. The requested date range covering the report duration." +}, +"dimensionFilters": { +"description": "Optional. The list of dimension values on which report lines are filtered. Utilizes the existing legacy filter message `DimensionValue`.", +"items": { +"$ref": "DimensionValue" +}, +"type": "array" +}, +"dimensionNames": { +"description": "Optional. The list of dimension names to group by.", +"items": { +"type": "string" +}, +"type": "array" +}, +"maxResults": { +"description": "Optional. Maximum number of result rows to return per page. The default value is 100. The maximum allowed value is 1000. Values above 1000 will be coerced (clamped) down to 1000. Negative values will be rejected.", +"format": "int32", +"type": "integer" +}, +"metricNames": { +"description": "Required. The list of metric names to include.", +"items": { +"type": "string" +}, +"type": "array" +}, +"pageToken": { +"description": "Optional. Continuation token for paginating results.", +"type": "string" +}, +"sortBys": { +"description": "Optional. Sort options across either requested dimensions or metrics.", +"items": { +"$ref": "SortBy" +}, +"type": "array" +} +}, +"type": "object" +}, +"ReportDataResponse": { +"description": "Represents a response to report data request.", +"id": "ReportDataResponse", +"properties": { +"columnHeaders": { +"description": "Output only. Ordered descriptors of the requested column fields.", +"items": { +"$ref": "ColumnHeader" +}, +"readOnly": true, +"type": "array" +}, +"nextPageToken": { +"description": "Output only. Token to retrieve the next page of rows, or empty if end of results.", +"readOnly": true, +"type": "string" +}, +"rows": { +"description": "Output only. The resulting set of matching data rows.", +"items": { +"$ref": "ReportDataRow" +}, +"readOnly": true, +"type": "array" +}, +"totalRow": { +"$ref": "ReportDataRow", +"description": "Output only. Singular aggregate total row for the entire query matching the criteria. Column headers apply in the exact same order as data rows. In the total_row: - All dimension columns contain an empty string (\"\"), as aggregation does not apply. - Non-summable metric columns (e.g. Reach metrics) contain an empty string (\"\"), as grand total aggregation cannot be mathematically/logically computed for them.", +"readOnly": true +} +}, +"type": "object" +}, +"ReportDataRow": { +"description": "A row of report data.", +"id": "ReportDataRow", +"properties": { +"values": { +"description": "Output only. A single sequential list of all cell values matching column_headers indices exactly. - Metric cells that are suppressed due to Minimum Reporting Standard (MRS) privacy protection constraints return \"-\".", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "ReportList": { "description": "Represents the list of reports.", "id": "ReportList", @@ -20583,6 +20752,29 @@ }, "type": "object" }, +"SortBy": { +"description": "Specifies the sort configuration for a specific field in the report.", +"id": "SortBy", +"properties": { +"name": { +"description": "Required. The dimension or metric field name to sort on.", +"type": "string" +}, +"sortOrder": { +"description": "Optional. The sort order of this column.", +"enum": [ +"ASCENDING", +"DESCENDING" +], +"enumDescriptions": [ +"Ascending order.", +"Descending order." +], +"type": "string" +} +}, +"type": "object" +}, "SortedDimension": { "description": "Represents a sorted dimension.", "id": "SortedDimension", From 47bab8a127d11d7cdf4fd032df50042ec527b8b0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:04 +0000 Subject: [PATCH 43/84] feat(dialogflow): update the api #### dialogflow:v2 The following keys were added: - schemas.GoogleCloudDialogflowV2ProbeDetails (Total Keys: 10) - schemas.GoogleCloudDialogflowV2SipHostname (Total Keys: 22) - schemas.GoogleCloudDialogflowV2SipTrunk.properties.googleRootCertFile.type (Total Keys: 1) - schemas.GoogleCloudDialogflowV2SipTrunk.properties.peerHostnames (Total Keys: 2) #### dialogflow:v2beta1 The following keys were added: - schemas.GoogleCloudDialogflowV2beta1ProbeDetails (Total Keys: 10) - schemas.GoogleCloudDialogflowV2beta1SipHostname (Total Keys: 22) - schemas.GoogleCloudDialogflowV2beta1SipTrunk.properties.googleRootCertFile.type (Total Keys: 1) - schemas.GoogleCloudDialogflowV2beta1SipTrunk.properties.peerHostnames (Total Keys: 2) --- ...gflow_v2.projects.locations.sipTrunks.html | 114 +++++++++++++++ ..._v2beta1.projects.locations.sipTrunks.html | 114 +++++++++++++++ .../documents/dialogflow.v2.json | 133 +++++++++++++++++- .../documents/dialogflow.v2beta1.json | 133 +++++++++++++++++- 4 files changed, 492 insertions(+), 2 deletions(-) diff --git a/docs/dyn/dialogflow_v2.projects.locations.sipTrunks.html b/docs/dyn/dialogflow_v2.projects.locations.sipTrunks.html index 01ad42edbc..8696d8e21b 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.sipTrunks.html +++ b/docs/dyn/dialogflow_v2.projects.locations.sipTrunks.html @@ -126,7 +126,26 @@

Method Details

"expectedHostname": [ "A String", ], + "googleRootCertFile": "A String", "name": "A String", + "peerHostnames": [ + { + "connectionState": "A String", + "enabledSipPing": True or False, + "errorDetails": { + "certificateState": "A String", + "errorMessage": "A String", + }, + "peerHostname": "A String", + "peerSocketAddress": "A String", + "pingInterval": "A String", + "probeDetails": { + "initTime": "A String", + "optionsLatency": "A String", + "probeStatus": "A String", + }, + }, + ], } x__xgafv: string, V1 error format. @@ -153,7 +172,26 @@

Method Details

"expectedHostname": [ "A String", ], + "googleRootCertFile": "A String", "name": "A String", + "peerHostnames": [ + { + "connectionState": "A String", + "enabledSipPing": True or False, + "errorDetails": { + "certificateState": "A String", + "errorMessage": "A String", + }, + "peerHostname": "A String", + "peerSocketAddress": "A String", + "pingInterval": "A String", + "probeDetails": { + "initTime": "A String", + "optionsLatency": "A String", + "probeStatus": "A String", + }, + }, + ], }
@@ -205,7 +243,26 @@

Method Details

"expectedHostname": [ "A String", ], + "googleRootCertFile": "A String", "name": "A String", + "peerHostnames": [ + { + "connectionState": "A String", + "enabledSipPing": True or False, + "errorDetails": { + "certificateState": "A String", + "errorMessage": "A String", + }, + "peerHostname": "A String", + "peerSocketAddress": "A String", + "pingInterval": "A String", + "probeDetails": { + "initTime": "A String", + "optionsLatency": "A String", + "probeStatus": "A String", + }, + }, + ], }
@@ -244,7 +301,26 @@

Method Details

"expectedHostname": [ "A String", ], + "googleRootCertFile": "A String", "name": "A String", + "peerHostnames": [ + { + "connectionState": "A String", + "enabledSipPing": True or False, + "errorDetails": { + "certificateState": "A String", + "errorMessage": "A String", + }, + "peerHostname": "A String", + "peerSocketAddress": "A String", + "pingInterval": "A String", + "probeDetails": { + "initTime": "A String", + "optionsLatency": "A String", + "probeStatus": "A String", + }, + }, + ], }, ], } @@ -289,7 +365,26 @@

Method Details

"expectedHostname": [ "A String", ], + "googleRootCertFile": "A String", "name": "A String", + "peerHostnames": [ + { + "connectionState": "A String", + "enabledSipPing": True or False, + "errorDetails": { + "certificateState": "A String", + "errorMessage": "A String", + }, + "peerHostname": "A String", + "peerSocketAddress": "A String", + "pingInterval": "A String", + "probeDetails": { + "initTime": "A String", + "optionsLatency": "A String", + "probeStatus": "A String", + }, + }, + ], } updateMask: string, A parameter @@ -317,7 +412,26 @@

Method Details

"expectedHostname": [ "A String", ], + "googleRootCertFile": "A String", "name": "A String", + "peerHostnames": [ + { + "connectionState": "A String", + "enabledSipPing": True or False, + "errorDetails": { + "certificateState": "A String", + "errorMessage": "A String", + }, + "peerHostname": "A String", + "peerSocketAddress": "A String", + "pingInterval": "A String", + "probeDetails": { + "initTime": "A String", + "optionsLatency": "A String", + "probeStatus": "A String", + }, + }, + ], } diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.sipTrunks.html b/docs/dyn/dialogflow_v2beta1.projects.locations.sipTrunks.html index 1bd2cae1c0..aef305dfe7 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.sipTrunks.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.sipTrunks.html @@ -126,7 +126,26 @@

Method Details

"expectedHostname": [ "A String", ], + "googleRootCertFile": "A String", "name": "A String", + "peerHostnames": [ + { + "connectionState": "A String", + "enabledSipPing": True or False, + "errorDetails": { + "certificateState": "A String", + "errorMessage": "A String", + }, + "peerHostname": "A String", + "peerSocketAddress": "A String", + "pingInterval": "A String", + "probeDetails": { + "initTime": "A String", + "optionsLatency": "A String", + "probeStatus": "A String", + }, + }, + ], } x__xgafv: string, V1 error format. @@ -153,7 +172,26 @@

Method Details

"expectedHostname": [ "A String", ], + "googleRootCertFile": "A String", "name": "A String", + "peerHostnames": [ + { + "connectionState": "A String", + "enabledSipPing": True or False, + "errorDetails": { + "certificateState": "A String", + "errorMessage": "A String", + }, + "peerHostname": "A String", + "peerSocketAddress": "A String", + "pingInterval": "A String", + "probeDetails": { + "initTime": "A String", + "optionsLatency": "A String", + "probeStatus": "A String", + }, + }, + ], } @@ -205,7 +243,26 @@

Method Details

"expectedHostname": [ "A String", ], + "googleRootCertFile": "A String", "name": "A String", + "peerHostnames": [ + { + "connectionState": "A String", + "enabledSipPing": True or False, + "errorDetails": { + "certificateState": "A String", + "errorMessage": "A String", + }, + "peerHostname": "A String", + "peerSocketAddress": "A String", + "pingInterval": "A String", + "probeDetails": { + "initTime": "A String", + "optionsLatency": "A String", + "probeStatus": "A String", + }, + }, + ], } @@ -244,7 +301,26 @@

Method Details

"expectedHostname": [ "A String", ], + "googleRootCertFile": "A String", "name": "A String", + "peerHostnames": [ + { + "connectionState": "A String", + "enabledSipPing": True or False, + "errorDetails": { + "certificateState": "A String", + "errorMessage": "A String", + }, + "peerHostname": "A String", + "peerSocketAddress": "A String", + "pingInterval": "A String", + "probeDetails": { + "initTime": "A String", + "optionsLatency": "A String", + "probeStatus": "A String", + }, + }, + ], }, ], } @@ -289,7 +365,26 @@

Method Details

"expectedHostname": [ "A String", ], + "googleRootCertFile": "A String", "name": "A String", + "peerHostnames": [ + { + "connectionState": "A String", + "enabledSipPing": True or False, + "errorDetails": { + "certificateState": "A String", + "errorMessage": "A String", + }, + "peerHostname": "A String", + "peerSocketAddress": "A String", + "pingInterval": "A String", + "probeDetails": { + "initTime": "A String", + "optionsLatency": "A String", + "probeStatus": "A String", + }, + }, + ], } updateMask: string, A parameter @@ -317,7 +412,26 @@

Method Details

"expectedHostname": [ "A String", ], + "googleRootCertFile": "A String", "name": "A String", + "peerHostnames": [ + { + "connectionState": "A String", + "enabledSipPing": True or False, + "errorDetails": { + "certificateState": "A String", + "errorMessage": "A String", + }, + "peerHostname": "A String", + "peerSocketAddress": "A String", + "pingInterval": "A String", + "probeDetails": { + "initTime": "A String", + "optionsLatency": "A String", + "probeStatus": "A String", + }, + }, + ], } diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 0372cd4b8a..c8ad416b48 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -8780,7 +8780,7 @@ } } }, -"revision": "20260701", +"revision": "20260716", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -17990,6 +17990,36 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2ProbeDetails": { +"id": "GoogleCloudDialogflowV2ProbeDetails", +"properties": { +"initTime": { +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"optionsLatency": { +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"probeStatus": { +"enum": [ +"PROBE_STATUS_UNSPECIFIED", +"PROBE_STATUS_SUCCESS", +"PROBE_STATUS_FAILED" +], +"enumDescriptions": [ +"", +"", +"" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2QueryInput": { "id": "GoogleCloudDialogflowV2QueryInput", "properties": { @@ -18739,6 +18769,90 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2SipHostname": { +"id": "GoogleCloudDialogflowV2SipHostname", +"properties": { +"connectionState": { +"enum": [ +"CONNECTION_STATE_UNSPECIFIED", +"CONNECTED", +"DISCONNECTED", +"AUTHENTICATION_FAILED", +"KEEPALIVE" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"readOnly": true, +"type": "string" +}, +"enabledSipPing": { +"readOnly": true, +"type": "boolean" +}, +"errorDetails": { +"$ref": "GoogleCloudDialogflowV2SipHostnameHostnameErrorDetails", +"readOnly": true +}, +"peerHostname": { +"type": "string" +}, +"peerSocketAddress": { +"readOnly": true, +"type": "string" +}, +"pingInterval": { +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"probeDetails": { +"$ref": "GoogleCloudDialogflowV2ProbeDetails", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SipHostnameHostnameErrorDetails": { +"id": "GoogleCloudDialogflowV2SipHostnameHostnameErrorDetails", +"properties": { +"certificateState": { +"enum": [ +"HOSTNAME_CERTIFICATE_STATE_UNSPECIFIED", +"VALID", +"INVALID", +"EXPIRED", +"HOSTNAME_NOT_FOUND", +"UNAUTHENTICATED", +"TRUST_STORE_NOT_FOUND", +"HOSTNAME_INVALID_FORMAT", +"QUOTA_EXCEEDED" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"readOnly": true, +"type": "string" +}, +"errorMessage": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2SipTrunk": { "id": "GoogleCloudDialogflowV2SipTrunk", "properties": { @@ -18758,8 +18872,25 @@ false }, "type": "array" }, +"googleRootCertFile": { +"enum": [ +"CERT_FILE_UNSPECIFIED", +"EXTERNAL_PRIVATE_CA" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +}, "name": { "type": "string" +}, +"peerHostnames": { +"items": { +"$ref": "GoogleCloudDialogflowV2SipHostname" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index b6af10b9cc..898afc56a9 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -8431,7 +8431,7 @@ } } }, -"revision": "20260701", +"revision": "20260716", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -20457,6 +20457,36 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2beta1ProbeDetails": { +"id": "GoogleCloudDialogflowV2beta1ProbeDetails", +"properties": { +"initTime": { +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"optionsLatency": { +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"probeStatus": { +"enum": [ +"PROBE_STATUS_UNSPECIFIED", +"PROBE_STATUS_SUCCESS", +"PROBE_STATUS_FAILED" +], +"enumDescriptions": [ +"", +"", +"" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1QueryInput": { "id": "GoogleCloudDialogflowV2beta1QueryInput", "properties": { @@ -21321,6 +21351,90 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2beta1SipHostname": { +"id": "GoogleCloudDialogflowV2beta1SipHostname", +"properties": { +"connectionState": { +"enum": [ +"CONNECTION_STATE_UNSPECIFIED", +"CONNECTED", +"DISCONNECTED", +"AUTHENTICATION_FAILED", +"KEEPALIVE" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"readOnly": true, +"type": "string" +}, +"enabledSipPing": { +"readOnly": true, +"type": "boolean" +}, +"errorDetails": { +"$ref": "GoogleCloudDialogflowV2beta1SipHostnameHostnameErrorDetails", +"readOnly": true +}, +"peerHostname": { +"type": "string" +}, +"peerSocketAddress": { +"readOnly": true, +"type": "string" +}, +"pingInterval": { +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"probeDetails": { +"$ref": "GoogleCloudDialogflowV2beta1ProbeDetails", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SipHostnameHostnameErrorDetails": { +"id": "GoogleCloudDialogflowV2beta1SipHostnameHostnameErrorDetails", +"properties": { +"certificateState": { +"enum": [ +"HOSTNAME_CERTIFICATE_STATE_UNSPECIFIED", +"VALID", +"INVALID", +"EXPIRED", +"HOSTNAME_NOT_FOUND", +"UNAUTHENTICATED", +"TRUST_STORE_NOT_FOUND", +"HOSTNAME_INVALID_FORMAT", +"QUOTA_EXCEEDED" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"readOnly": true, +"type": "string" +}, +"errorMessage": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1SipTrunk": { "id": "GoogleCloudDialogflowV2beta1SipTrunk", "properties": { @@ -21340,8 +21454,25 @@ false }, "type": "array" }, +"googleRootCertFile": { +"enum": [ +"CERT_FILE_UNSPECIFIED", +"EXTERNAL_PRIVATE_CA" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +}, "name": { "type": "string" +}, +"peerHostnames": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SipHostname" +}, +"type": "array" } }, "type": "object" From 4f724e98da7ed69ea3a7931b2871c11cc24b6452 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:04 +0000 Subject: [PATCH 44/84] feat(discoveryengine): update the api #### discoveryengine:v1 The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.parameters.modelInfoView (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.parameters.modelInfoView (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.parameters.modelInfoView (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.metadata.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.tag.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1LicenseConfig.properties.lastUserUpdateTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1WidgetConfig.properties.batchAuthStatuses (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1WidgetConfigBatchAuthStatus (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1WidgetConfigUiSettings.properties.sourceAdminDisplayNameEnabled.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.metadata.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.tag.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.iconUri (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaLicenseConfig.properties.lastUserUpdateTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaLicenseConfig.properties.lastUserUpdateTime (Total Keys: 2) #### discoveryengine:v1alpha The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.get.parameters.view (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.list.parameters.view (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.parameters.modelInfoView (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.parameters.modelInfoView (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.methods.get.parameters.view (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.methods.list.parameters.view (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.parameters.modelInfoView (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.metadata.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.tag.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1LicenseConfig.properties.lastUserUpdateTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaAgent.properties.creationFailureReason (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaCompletionConfig.properties.filterPiiSuggestionsUsingDlp.deprecated (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.metadata.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.tag.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.iconUri (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaLicenseConfig.properties.lastUserUpdateTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult.properties.retrievalSignals.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRetrievalSignals (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.batchAuthStatuses (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigBatchAuthStatus (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.sourceAdminDisplayNameEnabled.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaLicenseConfig.properties.lastUserUpdateTime (Total Keys: 2) #### discoveryengine:v1beta The following keys were added: - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.metadata.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.tag.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1LicenseConfig.properties.lastUserUpdateTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.metadata.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.tag.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.iconUri (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaLicenseConfig.properties.lastUserUpdateTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaLicenseConfig.properties.lastUserUpdateTime (Total Keys: 2) --- ...Accounts.billingAccountLicenseConfigs.html | 2 + ...llections.dataStores.completionConfig.html | 4 +- ...collections.dataStores.servingConfigs.html | 12 +- ...ons.collections.dataStores.userEvents.html | 12 +- ....collections.dataStores.widgetConfigs.html | 81 +++- ....collections.engines.completionConfig.html | 4 +- ...rojects.locations.collections.engines.html | 10 +- ...ns.collections.engines.servingConfigs.html | 12 +- ...ons.collections.engines.widgetConfigs.html | 81 +++- ...ine_v1.projects.locations.collections.html | 33 +- ...locations.dataStores.completionConfig.html | 4 +- ...s.locations.dataStores.servingConfigs.html | 12 +- ...jects.locations.dataStores.userEvents.html | 12 +- ...ts.locations.dataStores.widgetConfigs.html | 81 +++- ...discoveryengine_v1.projects.locations.html | 22 +- ..._v1.projects.locations.licenseConfigs.html | 6 + ...gine_v1.projects.locations.userEvents.html | 12 +- ...Accounts.billingAccountLicenseConfigs.html | 2 + ...llections.dataStores.completionConfig.html | 4 +- ....collections.dataStores.conversations.html | 6 + ...ects.locations.collections.dataStores.html | 35 +- ...collections.dataStores.servingConfigs.html | 36 +- ...ons.collections.dataStores.userEvents.html | 12 +- ....collections.dataStores.widgetConfigs.html | 81 +++- ...collections.engines.assistants.agents.html | 6 + ....collections.engines.completionConfig.html | 8 +- ...ons.collections.engines.conversations.html | 6 + ...rojects.locations.collections.engines.html | 20 +- ...ns.collections.engines.servingConfigs.html | 36 +- ...gines.sessions.alphaEvolveExperiments.html | 4 +- ...ons.collections.engines.widgetConfigs.html | 81 +++- ...1alpha.projects.locations.collections.html | 66 ++- ...locations.dataStores.completionConfig.html | 4 +- ...ts.locations.dataStores.conversations.html | 6 + ...v1alpha.projects.locations.dataStores.html | 35 +- ...s.locations.dataStores.servingConfigs.html | 36 +- ...jects.locations.dataStores.userEvents.html | 12 +- ...ts.locations.dataStores.widgetConfigs.html | 81 +++- ...1alpha.projects.locations.evaluations.html | 12 +- ...veryengine_v1alpha.projects.locations.html | 22 +- ...pha.projects.locations.licenseConfigs.html | 6 + ...v1alpha.projects.locations.userEvents.html | 12 +- ...Accounts.billingAccountLicenseConfigs.html | 2 + ...llections.dataStores.completionConfig.html | 4 +- ...collections.dataStores.servingConfigs.html | 12 +- ...ons.collections.dataStores.userEvents.html | 12 +- ....collections.engines.completionConfig.html | 8 +- ...rojects.locations.collections.engines.html | 14 +- ...ns.collections.engines.servingConfigs.html | 12 +- ...locations.dataStores.completionConfig.html | 4 +- ...s.locations.dataStores.servingConfigs.html | 12 +- ...jects.locations.dataStores.userEvents.html | 12 +- ...v1beta.projects.locations.evaluations.html | 12 +- ...eta.projects.locations.licenseConfigs.html | 6 + ..._v1beta.projects.locations.userEvents.html | 12 +- .../documents/discoveryengine.v1.json | 257 ++++++++++-- .../documents/discoveryengine.v1alpha.json | 376 ++++++++++++++++-- .../documents/discoveryengine.v1beta.json | 158 ++++++-- 58 files changed, 1523 insertions(+), 419 deletions(-) diff --git a/docs/dyn/discoveryengine_v1.billingAccounts.billingAccountLicenseConfigs.html b/docs/dyn/discoveryengine_v1.billingAccounts.billingAccountLicenseConfigs.html index 0e9b110d2d..b4e723d6cc 100644 --- a/docs/dyn/discoveryengine_v1.billingAccounts.billingAccountLicenseConfigs.html +++ b/docs/dyn/discoveryengine_v1.billingAccounts.billingAccountLicenseConfigs.html @@ -129,6 +129,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -182,6 +183,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html index d5f3a17e82..203f4aa35e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html @@ -120,8 +120,8 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. 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 b91bb69b38..54053eec7b 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -1528,8 +1528,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -1811,8 +1811,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2280,8 +2280,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html index 30530a8693..b2897fad1a 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html @@ -285,8 +285,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -512,8 +512,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -664,8 +664,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. 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 36fe60b7e7..1659060046 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, x__xgafv=None)

+ get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, modelInfoView=None, x__xgafv=None)

Gets a WidgetConfig.

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

@@ -90,7 +90,7 @@

Method Details

- get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, x__xgafv=None) + get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, modelInfoView=None, x__xgafv=None)
Gets a WidgetConfig.
 
 Args:
@@ -98,6 +98,11 @@ 

Method Details

acceptCache: boolean, Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. getWidgetConfigRequestOption_turnOffCollectionComponents: boolean, Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. languageCode: string, Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English). + modelInfoView: string, Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`). + Allowed values + MODEL_INFO_VIEW_UNSPECIFIED - Not specified. + END_USER_WEB - The end-user web model selector view. + ADMIN - The Cloud Console admin "Feature Control" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -126,11 +131,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -146,8 +162,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -307,7 +323,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -348,6 +364,7 @@

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. + "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. }
@@ -382,11 +399,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -402,8 +430,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -563,7 +591,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -604,6 +632,7 @@

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. + "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. } @@ -637,11 +666,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -657,8 +697,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -818,7 +858,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -859,6 +899,7 @@

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. + "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.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html index 0e2b606a83..c64d3b103a 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html @@ -120,8 +120,8 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html index 7429d6c45c..4f82361019 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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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 19111866d1..bf56980c0a 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -1528,8 +1528,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -1811,8 +1811,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2280,8 +2280,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. 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 bad7175e05..c62c7287c3 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, x__xgafv=None)

+ get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, modelInfoView=None, x__xgafv=None)

Gets a WidgetConfig.

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

@@ -90,7 +90,7 @@

Method Details

- get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, x__xgafv=None) + get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, modelInfoView=None, x__xgafv=None)
Gets a WidgetConfig.
 
 Args:
@@ -98,6 +98,11 @@ 

Method Details

acceptCache: boolean, Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. getWidgetConfigRequestOption_turnOffCollectionComponents: boolean, Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. languageCode: string, Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English). + modelInfoView: string, Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`). + Allowed values + MODEL_INFO_VIEW_UNSPECIFIED - Not specified. + END_USER_WEB - The end-user web model selector view. + ADMIN - The Cloud Console admin "Feature Control" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -126,11 +131,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -146,8 +162,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -307,7 +323,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -348,6 +364,7 @@

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. + "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. }
@@ -382,11 +399,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -402,8 +430,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -563,7 +591,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -604,6 +632,7 @@

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. + "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. } @@ -637,11 +666,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -657,8 +697,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -818,7 +858,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -859,6 +899,7 @@

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. + "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 ec5223a247..3755cfb371 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.html @@ -224,7 +224,7 @@

Method Details

"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. "createTime": "A String", # Output only. Timestamp the DataConnector was created at. - "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` + "dataSource": "A String", # Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -337,6 +337,14 @@

Method Details

"kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + "metadata": { # User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note). # Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. + "authenticatedAccount": "A String", # Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. + "author": "A String", # Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). + "description": "A String", # Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. + "note": "A String", # Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. + "shortDescription": "A String", # Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). + "title": "A String", # Optional. Display title of the connector. + }, "name": "A String", # Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. @@ -386,6 +394,7 @@

Method Details

], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. + "tag": "A String", # Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. } @@ -463,7 +472,7 @@

Method Details

"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. "createTime": "A String", # Output only. Timestamp the DataConnector was created at. - "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` + "dataSource": "A String", # Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -576,6 +585,14 @@

Method Details

"kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + "metadata": { # User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note). # Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. + "authenticatedAccount": "A String", # Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. + "author": "A String", # Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). + "description": "A String", # Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. + "note": "A String", # Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. + "shortDescription": "A String", # Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). + "title": "A String", # Optional. Display title of the connector. + }, "name": "A String", # Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. @@ -625,6 +642,7 @@

Method Details

], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. + "tag": "A String", # Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. } @@ -701,7 +719,7 @@

Method Details

"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. "createTime": "A String", # Output only. Timestamp the DataConnector was created at. - "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` + "dataSource": "A String", # Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -814,6 +832,14 @@

Method Details

"kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + "metadata": { # User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note). # Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. + "authenticatedAccount": "A String", # Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. + "author": "A String", # Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). + "description": "A String", # Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. + "note": "A String", # Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. + "shortDescription": "A String", # Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). + "title": "A String", # Optional. Display title of the connector. + }, "name": "A String", # Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. @@ -863,6 +889,7 @@

Method Details

], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. + "tag": "A String", # Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. } diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html index df48afb344..c568a09400 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html @@ -120,8 +120,8 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index d4f0e2bf3e..8c1680a1d9 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -1528,8 +1528,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -1811,8 +1811,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2280,8 +2280,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html index 06fa8adf02..fda56a0ab1 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html @@ -285,8 +285,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -512,8 +512,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -664,8 +664,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html index bc4ffbe1d0..a768d8e1d5 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, x__xgafv=None)

+ get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, modelInfoView=None, x__xgafv=None)

Gets a WidgetConfig.

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

@@ -90,7 +90,7 @@

Method Details

- get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, x__xgafv=None) + get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, modelInfoView=None, x__xgafv=None)
Gets a WidgetConfig.
 
 Args:
@@ -98,6 +98,11 @@ 

Method Details

acceptCache: boolean, Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. getWidgetConfigRequestOption_turnOffCollectionComponents: boolean, Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. languageCode: string, Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English). + modelInfoView: string, Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`). + Allowed values + MODEL_INFO_VIEW_UNSPECIFIED - Not specified. + END_USER_WEB - The end-user web model selector view. + ADMIN - The Cloud Console admin "Feature Control" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -126,11 +131,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -146,8 +162,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -307,7 +323,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -348,6 +364,7 @@

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. + "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. }
@@ -382,11 +399,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -402,8 +430,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -563,7 +591,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -604,6 +632,7 @@

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. + "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. } @@ -637,11 +666,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -657,8 +697,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -818,7 +858,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -859,6 +899,7 @@

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. + "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.html b/docs/dyn/discoveryengine_v1.projects.locations.html index deb7cd726d..27437350be 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.html @@ -286,7 +286,7 @@

Method Details

"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. "createTime": "A String", # Output only. Timestamp the DataConnector was created at. - "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` + "dataSource": "A String", # Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -399,6 +399,14 @@

Method Details

"kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + "metadata": { # User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note). # Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. + "authenticatedAccount": "A String", # Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. + "author": "A String", # Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). + "description": "A String", # Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. + "note": "A String", # Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. + "shortDescription": "A String", # Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). + "title": "A String", # Optional. Display title of the connector. + }, "name": "A String", # Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. @@ -448,6 +456,7 @@

Method Details

], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. + "tag": "A String", # Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. }, @@ -554,7 +563,7 @@

Method Details

"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. "createTime": "A String", # Output only. Timestamp the DataConnector was created at. - "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` + "dataSource": "A String", # Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -667,6 +676,14 @@

Method Details

"kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + "metadata": { # User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note). # Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. + "authenticatedAccount": "A String", # Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. + "author": "A String", # Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). + "description": "A String", # Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. + "note": "A String", # Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. + "shortDescription": "A String", # Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). + "title": "A String", # Optional. Display title of the connector. + }, "name": "A String", # Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. @@ -716,6 +733,7 @@

Method Details

], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. + "tag": "A String", # Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. } diff --git a/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html index 300a0f7d18..24204da724 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html @@ -122,6 +122,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -158,6 +159,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -200,6 +202,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -247,6 +250,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -301,6 +305,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -337,6 +342,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html index 77070df043..517a7d143c 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html @@ -282,8 +282,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -466,8 +466,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -618,8 +618,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html b/docs/dyn/discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html index 2fd853af47..131fd88060 100644 --- a/docs/dyn/discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html @@ -157,6 +157,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -344,6 +345,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html index c54ac8e68d..3f0bf98c9b 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html @@ -120,8 +120,8 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html index 819640fefc..293c0fb0af 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html @@ -542,6 +542,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], } diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index ec343cbf39..49d49546f4 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -168,7 +168,7 @@

Instance Methods

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

Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.

- get(name, x__xgafv=None)

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

Gets a DataStore.

getCompletionConfig(name, x__xgafv=None)

@@ -180,7 +180,7 @@

Instance Methods

getSiteSearchEngine(name, x__xgafv=None)

Gets the SiteSearchEngine.

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

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

Lists all the DataStores associated with the project.

list_next()

@@ -202,7 +202,7 @@

Instance Methods

Updates the CompletionConfigs.

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

-

Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.

+

Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleton resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. The `update_mask` query parameter is not supported; if it is set the request returns an error. To update mutable fields, omit `update_mask` and send the full DocumentProcessingConfig as the request body. The entire resource is overwritten, so include all values you want to retain. For example, to update the layout parser, set DocumentProcessingConfig.default_parsing_config (or DocumentProcessingConfig.parsing_config_overrides) and omit `update_mask`. Some fields, such as DocumentProcessingConfig.chunking_config, are immutable and return an error if changed.

Method Details

addPatientFilter(dataStore, body=None, x__xgafv=None) @@ -432,6 +432,7 @@

Method Details

"A String", ], }, + "iconUri": "A String", # Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively. "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. @@ -606,11 +607,16 @@

Method Details

- get(name, x__xgafv=None) + get(name, view=None, x__xgafv=None)
Gets a DataStore.
 
 Args:
   name: string, Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. (required)
+  view: string, Optional. The view to apply to the returned DataStore. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for a connector-backed data store. Resolving the connector icon requires extra lookups, so request it only when the caller renders the icon.
+    Allowed values
+      DATA_STORE_VIEW_UNSPECIFIED - The default / unset value. The API defaults to DataStoreView.DATA_STORE_VIEW_BASIC.
+      DATA_STORE_VIEW_BASIC - Does not populate DataStore.icon_uri. This is the default view.
+      DATA_STORE_VIEW_FULL - Additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request this view only when the icons are rendered.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -757,6 +763,7 @@ 

Method Details

"A String", ], }, + "iconUri": "A String", # Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively. "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. @@ -836,7 +843,7 @@

Method Details

{ # Config to customize Autocomplete API response for both engines and data stores. Some fields are applicable to only one of them. "enableMode": "A String", # The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored for Engine. - "filterPiiSuggestionsUsingDlp": True or False, # If true, with best effort, try to detect and remove the suggestions containing certain types of PII information. This detection is performated by [DLP](https://cloud.google.com/security/products/dlp) under the hood. + "filterPiiSuggestionsUsingDlp": True or False, # Deprecated: this field has no effect. As of May 2025, PII suggestion filtering using [DLP](https://cloud.google.com/security/products/dlp) is always on for all data stores and can't be configured per data store. "matchingOrder": "A String", # The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of-order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` specified would suggest `red shoes`. Currently supported values: * `out-of-order` * `exact-prefix` Default value: `exact-prefix`. "maxSuggestions": 42, # The maximum number of autocomplete suggestions returned per term. max_suggestions must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 suggestions. "minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. @@ -951,7 +958,7 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists all the DataStores associated with the project.
 
 Args:
@@ -959,6 +966,11 @@ 

Method Details

filter: string, Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` pageSize: integer, Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. pageToken: string, A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + view: string, Optional. The view to apply to the returned DataStores. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request it only when the caller renders the icons. + Allowed values + DATA_STORE_VIEW_UNSPECIFIED - The default / unset value. The API defaults to DataStoreView.DATA_STORE_VIEW_BASIC. + DATA_STORE_VIEW_BASIC - Does not populate DataStore.icon_uri. This is the default view. + DATA_STORE_VIEW_FULL - Additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request this view only when the icons are rendered. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1107,6 +1119,7 @@

Method Details

"A String", ], }, + "iconUri": "A String", # Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively. "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. @@ -1334,6 +1347,7 @@

Method Details

"A String", ], }, + "iconUri": "A String", # Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively. "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. @@ -1543,6 +1557,7 @@

Method Details

"A String", ], }, + "iconUri": "A String", # Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively. "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. @@ -1759,7 +1774,7 @@

Method Details

{ # Config to customize Autocomplete API response for both engines and data stores. Some fields are applicable to only one of them. "enableMode": "A String", # The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored for Engine. - "filterPiiSuggestionsUsingDlp": True or False, # If true, with best effort, try to detect and remove the suggestions containing certain types of PII information. This detection is performated by [DLP](https://cloud.google.com/security/products/dlp) under the hood. + "filterPiiSuggestionsUsingDlp": True or False, # Deprecated: this field has no effect. As of May 2025, PII suggestion filtering using [DLP](https://cloud.google.com/security/products/dlp) is always on for all data stores and can't be configured per data store. "matchingOrder": "A String", # The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of-order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` specified would suggest `red shoes`. Currently supported values: * `out-of-order` * `exact-prefix` Default value: `exact-prefix`. "maxSuggestions": 42, # The maximum number of autocomplete suggestions returned per term. max_suggestions must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 suggestions. "minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. @@ -1781,7 +1796,7 @@

Method Details

{ # Config to customize Autocomplete API response for both engines and data stores. Some fields are applicable to only one of them. "enableMode": "A String", # The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored for Engine. - "filterPiiSuggestionsUsingDlp": True or False, # If true, with best effort, try to detect and remove the suggestions containing certain types of PII information. This detection is performated by [DLP](https://cloud.google.com/security/products/dlp) under the hood. + "filterPiiSuggestionsUsingDlp": True or False, # Deprecated: this field has no effect. As of May 2025, PII suggestion filtering using [DLP](https://cloud.google.com/security/products/dlp) is always on for all data stores and can't be configured per data store. "matchingOrder": "A String", # The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of-order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` specified would suggest `red shoes`. Currently supported values: * `out-of-order` * `exact-prefix` Default value: `exact-prefix`. "maxSuggestions": 42, # The maximum number of autocomplete suggestions returned per term. max_suggestions must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 suggestions. "minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. @@ -1795,7 +1810,7 @@

Method Details

updateDocumentProcessingConfig(name, body=None, updateMask=None, x__xgafv=None) -
Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.
+  
Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleton resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. The `update_mask` query parameter is not supported; if it is set the request returns an error. To update mutable fields, omit `update_mask` and send the full DocumentProcessingConfig as the request body. The entire resource is overwritten, so include all values you want to retain. For example, to update the layout parser, set DocumentProcessingConfig.default_parsing_config (or DocumentProcessingConfig.parsing_config_overrides) and omit `update_mask`. Some fields, such as DocumentProcessingConfig.chunking_config, are immutable and return an error if changed.
 
 Args:
   name: string, The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. (required)
@@ -1870,7 +1885,7 @@ 

Method Details

}, } - updateMask: string, Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. + updateMask: string, Not supported. If `update_mask` is set, the request returns an `UnsupportedFieldError`. To update mutable fields, omit `update_mask`; the full DocumentProcessingConfig in the request body then overwrites the existing resource. See the method description for details. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html index 7453bcd6d7..739f57463f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -1776,8 +1776,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2096,8 +2096,8 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2328,6 +2328,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], }, @@ -2458,6 +2464,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], "searchLinkPromotions": [ # Promotions for site search. @@ -2763,8 +2775,8 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2995,6 +3007,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], }, @@ -3125,6 +3143,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], "searchLinkPromotions": [ # Promotions for site search. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html index 1501bb7ea7..ab7336fb19 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html @@ -318,8 +318,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -578,8 +578,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -763,8 +763,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. 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 3c73f5e074..affb5689cd 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, x__xgafv=None)

+ get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, modelInfoView=None, x__xgafv=None)

Gets a WidgetConfig.

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

@@ -90,7 +90,7 @@

Method Details

- get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, x__xgafv=None) + get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, modelInfoView=None, x__xgafv=None)
Gets a WidgetConfig.
 
 Args:
@@ -98,6 +98,11 @@ 

Method Details

acceptCache: boolean, Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. getWidgetConfigRequestOption_turnOffCollectionComponents: boolean, Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. languageCode: string, Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English). + modelInfoView: string, Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`). + Allowed values + MODEL_INFO_VIEW_UNSPECIFIED - Not specified. + END_USER_WEB - The end-user web model selector view. + ADMIN - The Cloud Console admin "Feature Control" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -126,11 +131,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -148,8 +164,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -312,7 +328,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -358,6 +374,7 @@

Method Details

"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. }
@@ -392,11 +409,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -414,8 +442,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -578,7 +606,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -624,6 +652,7 @@

Method Details

"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. } @@ -657,11 +686,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -679,8 +719,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -843,7 +883,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -889,6 +929,7 @@

Method Details

"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.engines.assistants.agents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html index dbf6252eaf..9722a2f89e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html @@ -140,6 +140,7 @@

Method Details

], }, "createTime": "A String", # Output only. Timestamp when this Agent was created. + "creationFailureReason": "A String", # Output only. The reason why the agent creation (provisioning) failed. Only set if the state is CREATION_FAILED. "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text. "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED. "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query. @@ -201,6 +202,7 @@

Method Details

], }, "createTime": "A String", # Output only. Timestamp when this Agent was created. + "creationFailureReason": "A String", # Output only. The reason why the agent creation (provisioning) failed. Only set if the state is CREATION_FAILED. "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text. "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED. "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query. @@ -304,6 +306,7 @@

Method Details

], }, "createTime": "A String", # Output only. Timestamp when this Agent was created. + "creationFailureReason": "A String", # Output only. The reason why the agent creation (provisioning) failed. Only set if the state is CREATION_FAILED. "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text. "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED. "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query. @@ -378,6 +381,7 @@

Method Details

], }, "createTime": "A String", # Output only. Timestamp when this Agent was created. + "creationFailureReason": "A String", # Output only. The reason why the agent creation (provisioning) failed. Only set if the state is CREATION_FAILED. "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text. "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED. "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query. @@ -458,6 +462,7 @@

Method Details

], }, "createTime": "A String", # Output only. Timestamp when this Agent was created. + "creationFailureReason": "A String", # Output only. The reason why the agent creation (provisioning) failed. Only set if the state is CREATION_FAILED. "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text. "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED. "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query. @@ -520,6 +525,7 @@

Method Details

], }, "createTime": "A String", # Output only. Timestamp when this Agent was created. + "creationFailureReason": "A String", # Output only. The reason why the agent creation (provisioning) failed. Only set if the state is CREATION_FAILED. "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text. "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED. "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html index 578d8414c1..09680e11b0 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html @@ -123,8 +123,8 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -299,8 +299,8 @@

Method Details

"removeTime": "A String", # Required. Time at which the suggestion was removed. If not set, the current time will be used. "searchHistorySuggestion": "A String", # The search history suggestion to be removed. "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html index 7b4c8d8e9b..98893908a0 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html @@ -542,6 +542,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], } diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html index f9a66bc38f..9a83b9e73e 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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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. @@ -509,7 +509,7 @@

Method Details

{ # Config to customize Autocomplete API response for both engines and data stores. Some fields are applicable to only one of them. "enableMode": "A String", # The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored for Engine. - "filterPiiSuggestionsUsingDlp": True or False, # If true, with best effort, try to detect and remove the suggestions containing certain types of PII information. This detection is performated by [DLP](https://cloud.google.com/security/products/dlp) under the hood. + "filterPiiSuggestionsUsingDlp": True or False, # Deprecated: this field has no effect. As of May 2025, PII suggestion filtering using [DLP](https://cloud.google.com/security/products/dlp) is always on for all data stores and can't be configured per data store. "matchingOrder": "A String", # The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of-order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` specified would suggest `red shoes`. Currently supported values: * `out-of-order` * `exact-prefix` Default value: `exact-prefix`. "maxSuggestions": 42, # The maximum number of autocomplete suggestions returned per term. max_suggestions must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 suggestions. "minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. @@ -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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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. @@ -1369,7 +1369,7 @@

Method Details

{ # Config to customize Autocomplete API response for both engines and data stores. Some fields are applicable to only one of them. "enableMode": "A String", # The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored for Engine. - "filterPiiSuggestionsUsingDlp": True or False, # If true, with best effort, try to detect and remove the suggestions containing certain types of PII information. This detection is performated by [DLP](https://cloud.google.com/security/products/dlp) under the hood. + "filterPiiSuggestionsUsingDlp": True or False, # Deprecated: this field has no effect. As of May 2025, PII suggestion filtering using [DLP](https://cloud.google.com/security/products/dlp) is always on for all data stores and can't be configured per data store. "matchingOrder": "A String", # The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of-order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` specified would suggest `red shoes`. Currently supported values: * `out-of-order` * `exact-prefix` Default value: `exact-prefix`. "maxSuggestions": 42, # The maximum number of autocomplete suggestions returned per term. max_suggestions must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 suggestions. "minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. @@ -1391,7 +1391,7 @@

Method Details

{ # Config to customize Autocomplete API response for both engines and data stores. Some fields are applicable to only one of them. "enableMode": "A String", # The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored for Engine. - "filterPiiSuggestionsUsingDlp": True or False, # If true, with best effort, try to detect and remove the suggestions containing certain types of PII information. This detection is performated by [DLP](https://cloud.google.com/security/products/dlp) under the hood. + "filterPiiSuggestionsUsingDlp": True or False, # Deprecated: this field has no effect. As of May 2025, PII suggestion filtering using [DLP](https://cloud.google.com/security/products/dlp) is always on for all data stores and can't be configured per data store. "matchingOrder": "A String", # The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of-order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` specified would suggest `red shoes`. Currently supported values: * `out-of-order` * `exact-prefix` Default value: `exact-prefix`. "maxSuggestions": 42, # The maximum number of autocomplete suggestions returned per term. max_suggestions must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 suggestions. "minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index 45ee15e757..a767dbbddf 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -1776,8 +1776,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2096,8 +2096,8 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2328,6 +2328,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], }, @@ -2458,6 +2464,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], "searchLinkPromotions": [ # Promotions for site search. @@ -2763,8 +2775,8 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2995,6 +3007,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], }, @@ -3125,6 +3143,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], "searchLinkPromotions": [ # Promotions for site search. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.html index 73be348b2e..6b9ab80e94 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.html @@ -98,7 +98,7 @@

Instance Methods

Deletes an experiment provided the experiment is in an end state (e.g. created, failed, succeeded).

get(name, x__xgafv=None)

-

Get an existing Experiment.

+

Get an existing AlphaEvolveExperiment.

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

List all AlphaEvolveExperiments in a given session.

@@ -303,7 +303,7 @@

Method Details

get(name, x__xgafv=None) -
Get an existing Experiment.
+  
Get an existing AlphaEvolveExperiment.
 
 Args:
   name: string, Required. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` (required)
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 e1e92b6346..50ee13c515 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html
@@ -78,7 +78,7 @@ 

Instance Methods

close()

Close httplib2 connections.

- get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, x__xgafv=None)

+ get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, modelInfoView=None, x__xgafv=None)

Gets a WidgetConfig.

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

@@ -90,7 +90,7 @@

Method Details

- get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, x__xgafv=None) + get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, modelInfoView=None, x__xgafv=None)
Gets a WidgetConfig.
 
 Args:
@@ -98,6 +98,11 @@ 

Method Details

acceptCache: boolean, Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. getWidgetConfigRequestOption_turnOffCollectionComponents: boolean, Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. languageCode: string, Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English). + modelInfoView: string, Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`). + Allowed values + MODEL_INFO_VIEW_UNSPECIFIED - Not specified. + END_USER_WEB - The end-user web model selector view. + ADMIN - The Cloud Console admin "Feature Control" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -126,11 +131,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -148,8 +164,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -312,7 +328,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -358,6 +374,7 @@

Method Details

"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. }
@@ -392,11 +409,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -414,8 +442,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -578,7 +606,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -624,6 +652,7 @@

Method Details

"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. } @@ -657,11 +686,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -679,8 +719,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -843,7 +883,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -889,6 +929,7 @@

Method Details

"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.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html index 3d1f32446a..821fdc9145 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html @@ -243,7 +243,7 @@

Method Details

"policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, - "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` + "dataSource": "A String", # Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -377,6 +377,14 @@

Method Details

"kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + "metadata": { # User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note). # Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. + "authenticatedAccount": "A String", # Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. + "author": "A String", # Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). + "description": "A String", # Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. + "note": "A String", # Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. + "shortDescription": "A String", # Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). + "title": "A String", # Optional. Display title of the connector. + }, "name": "A String", # Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. @@ -426,6 +434,7 @@

Method Details

], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. + "tag": "A String", # Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. }, @@ -516,7 +525,7 @@

Method Details

"policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, - "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` + "dataSource": "A String", # Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -650,6 +659,14 @@

Method Details

"kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + "metadata": { # User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note). # Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. + "authenticatedAccount": "A String", # Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. + "author": "A String", # Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). + "description": "A String", # Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. + "note": "A String", # Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. + "shortDescription": "A String", # Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). + "title": "A String", # Optional. Display title of the connector. + }, "name": "A String", # Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. @@ -699,6 +716,7 @@

Method Details

], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. + "tag": "A String", # Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. } @@ -793,7 +811,7 @@

Method Details

"policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, - "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` + "dataSource": "A String", # Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -927,6 +945,14 @@

Method Details

"kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + "metadata": { # User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note). # Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. + "authenticatedAccount": "A String", # Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. + "author": "A String", # Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). + "description": "A String", # Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. + "note": "A String", # Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. + "shortDescription": "A String", # Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). + "title": "A String", # Optional. Display title of the connector. + }, "name": "A String", # Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. @@ -976,6 +1002,7 @@

Method Details

], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. + "tag": "A String", # Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. }, @@ -1080,7 +1107,7 @@

Method Details

"policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, - "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` + "dataSource": "A String", # Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -1214,6 +1241,14 @@

Method Details

"kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + "metadata": { # User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note). # Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. + "authenticatedAccount": "A String", # Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. + "author": "A String", # Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). + "description": "A String", # Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. + "note": "A String", # Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. + "shortDescription": "A String", # Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). + "title": "A String", # Optional. Display title of the connector. + }, "name": "A String", # Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. @@ -1263,6 +1298,7 @@

Method Details

], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. + "tag": "A String", # Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. }, @@ -1377,7 +1413,7 @@

Method Details

"policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, - "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` + "dataSource": "A String", # Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -1511,6 +1547,14 @@

Method Details

"kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + "metadata": { # User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note). # Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. + "authenticatedAccount": "A String", # Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. + "author": "A String", # Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). + "description": "A String", # Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. + "note": "A String", # Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. + "shortDescription": "A String", # Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). + "title": "A String", # Optional. Display title of the connector. + }, "name": "A String", # Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. @@ -1560,6 +1604,7 @@

Method Details

], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. + "tag": "A String", # Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. } @@ -1641,7 +1686,7 @@

Method Details

"policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, - "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` + "dataSource": "A String", # Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -1775,6 +1820,14 @@

Method Details

"kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + "metadata": { # User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note). # Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. + "authenticatedAccount": "A String", # Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. + "author": "A String", # Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). + "description": "A String", # Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. + "note": "A String", # Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. + "shortDescription": "A String", # Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). + "title": "A String", # Optional. Display title of the connector. + }, "name": "A String", # Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. @@ -1824,6 +1877,7 @@

Method Details

], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. + "tag": "A String", # Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. } diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html index 09f83f6c49..7c5d75cd3c 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html @@ -120,8 +120,8 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html index 9fba903b20..c92b30167c 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html @@ -542,6 +542,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], } diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index 474f066034..2b4ef2918c 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -163,7 +163,7 @@

Instance Methods

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

Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.

- get(name, x__xgafv=None)

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

Gets a DataStore.

getCompletionConfig(name, x__xgafv=None)

@@ -175,7 +175,7 @@

Instance Methods

getSiteSearchEngine(name, x__xgafv=None)

Gets the SiteSearchEngine.

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

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

Lists all the DataStores associated with the project.

list_next()

@@ -194,7 +194,7 @@

Instance Methods

Updates the CompletionConfigs.

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

-

Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.

+

Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleton resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. The `update_mask` query parameter is not supported; if it is set the request returns an error. To update mutable fields, omit `update_mask` and send the full DocumentProcessingConfig as the request body. The entire resource is overwritten, so include all values you want to retain. For example, to update the layout parser, set DocumentProcessingConfig.default_parsing_config (or DocumentProcessingConfig.parsing_config_overrides) and omit `update_mask`. Some fields, such as DocumentProcessingConfig.chunking_config, are immutable and return an error if changed.

Method Details

addPatientFilter(dataStore, body=None, x__xgafv=None) @@ -424,6 +424,7 @@

Method Details

"A String", ], }, + "iconUri": "A String", # Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively. "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. @@ -598,11 +599,16 @@

Method Details

- get(name, x__xgafv=None) + get(name, view=None, x__xgafv=None)
Gets a DataStore.
 
 Args:
   name: string, Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. (required)
+  view: string, Optional. The view to apply to the returned DataStore. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for a connector-backed data store. Resolving the connector icon requires extra lookups, so request it only when the caller renders the icon.
+    Allowed values
+      DATA_STORE_VIEW_UNSPECIFIED - The default / unset value. The API defaults to DataStoreView.DATA_STORE_VIEW_BASIC.
+      DATA_STORE_VIEW_BASIC - Does not populate DataStore.icon_uri. This is the default view.
+      DATA_STORE_VIEW_FULL - Additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request this view only when the icons are rendered.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -749,6 +755,7 @@ 

Method Details

"A String", ], }, + "iconUri": "A String", # Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively. "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. @@ -828,7 +835,7 @@

Method Details

{ # Config to customize Autocomplete API response for both engines and data stores. Some fields are applicable to only one of them. "enableMode": "A String", # The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored for Engine. - "filterPiiSuggestionsUsingDlp": True or False, # If true, with best effort, try to detect and remove the suggestions containing certain types of PII information. This detection is performated by [DLP](https://cloud.google.com/security/products/dlp) under the hood. + "filterPiiSuggestionsUsingDlp": True or False, # Deprecated: this field has no effect. As of May 2025, PII suggestion filtering using [DLP](https://cloud.google.com/security/products/dlp) is always on for all data stores and can't be configured per data store. "matchingOrder": "A String", # The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of-order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` specified would suggest `red shoes`. Currently supported values: * `out-of-order` * `exact-prefix` Default value: `exact-prefix`. "maxSuggestions": 42, # The maximum number of autocomplete suggestions returned per term. max_suggestions must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 suggestions. "minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. @@ -943,7 +950,7 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists all the DataStores associated with the project.
 
 Args:
@@ -951,6 +958,11 @@ 

Method Details

filter: string, Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` pageSize: integer, Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. pageToken: string, A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + view: string, Optional. The view to apply to the returned DataStores. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request it only when the caller renders the icons. + Allowed values + DATA_STORE_VIEW_UNSPECIFIED - The default / unset value. The API defaults to DataStoreView.DATA_STORE_VIEW_BASIC. + DATA_STORE_VIEW_BASIC - Does not populate DataStore.icon_uri. This is the default view. + DATA_STORE_VIEW_FULL - Additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request this view only when the icons are rendered. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1099,6 +1111,7 @@

Method Details

"A String", ], }, + "iconUri": "A String", # Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively. "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. @@ -1326,6 +1339,7 @@

Method Details

"A String", ], }, + "iconUri": "A String", # Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively. "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. @@ -1535,6 +1549,7 @@

Method Details

"A String", ], }, + "iconUri": "A String", # Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively. "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. @@ -1699,7 +1714,7 @@

Method Details

{ # Config to customize Autocomplete API response for both engines and data stores. Some fields are applicable to only one of them. "enableMode": "A String", # The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored for Engine. - "filterPiiSuggestionsUsingDlp": True or False, # If true, with best effort, try to detect and remove the suggestions containing certain types of PII information. This detection is performated by [DLP](https://cloud.google.com/security/products/dlp) under the hood. + "filterPiiSuggestionsUsingDlp": True or False, # Deprecated: this field has no effect. As of May 2025, PII suggestion filtering using [DLP](https://cloud.google.com/security/products/dlp) is always on for all data stores and can't be configured per data store. "matchingOrder": "A String", # The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of-order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` specified would suggest `red shoes`. Currently supported values: * `out-of-order` * `exact-prefix` Default value: `exact-prefix`. "maxSuggestions": 42, # The maximum number of autocomplete suggestions returned per term. max_suggestions must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 suggestions. "minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. @@ -1721,7 +1736,7 @@

Method Details

{ # Config to customize Autocomplete API response for both engines and data stores. Some fields are applicable to only one of them. "enableMode": "A String", # The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored for Engine. - "filterPiiSuggestionsUsingDlp": True or False, # If true, with best effort, try to detect and remove the suggestions containing certain types of PII information. This detection is performated by [DLP](https://cloud.google.com/security/products/dlp) under the hood. + "filterPiiSuggestionsUsingDlp": True or False, # Deprecated: this field has no effect. As of May 2025, PII suggestion filtering using [DLP](https://cloud.google.com/security/products/dlp) is always on for all data stores and can't be configured per data store. "matchingOrder": "A String", # The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of-order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` specified would suggest `red shoes`. Currently supported values: * `out-of-order` * `exact-prefix` Default value: `exact-prefix`. "maxSuggestions": 42, # The maximum number of autocomplete suggestions returned per term. max_suggestions must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 suggestions. "minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. @@ -1735,7 +1750,7 @@

Method Details

updateDocumentProcessingConfig(name, body=None, updateMask=None, x__xgafv=None) -
Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.
+  
Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleton resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. The `update_mask` query parameter is not supported; if it is set the request returns an error. To update mutable fields, omit `update_mask` and send the full DocumentProcessingConfig as the request body. The entire resource is overwritten, so include all values you want to retain. For example, to update the layout parser, set DocumentProcessingConfig.default_parsing_config (or DocumentProcessingConfig.parsing_config_overrides) and omit `update_mask`. Some fields, such as DocumentProcessingConfig.chunking_config, are immutable and return an error if changed.
 
 Args:
   name: string, The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. (required)
@@ -1810,7 +1825,7 @@ 

Method Details

}, } - updateMask: string, Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. + updateMask: string, Not supported. If `update_mask` is set, the request returns an `UnsupportedFieldError`. To update mutable fields, omit `update_mask`; the full DocumentProcessingConfig in the request body then overwrites the existing resource. See the method description for details. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index dfe171c8f1..2c78425256 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -1776,8 +1776,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2096,8 +2096,8 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2328,6 +2328,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], }, @@ -2458,6 +2464,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], "searchLinkPromotions": [ # Promotions for site search. @@ -2763,8 +2775,8 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2995,6 +3007,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], }, @@ -3125,6 +3143,12 @@

Method Details

"semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. }, + "retrievalSignals": { # Contains a set of signals used by the relevance filter. # Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. + "retrievalSources": [ # Optional. Indicates how the result was retrieved. + "A String", + ], + "semanticRelevanceScore": 3.14, # Optional. Relevance score used by the filter when semantic_relevance_threshold is set. + }, }, ], "searchLinkPromotions": [ # Promotions for site search. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html index d708995b10..3c9f96690a 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html @@ -318,8 +318,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -578,8 +578,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -763,8 +763,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html index 8cc7b6c215..d2ea3cf7b7 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, x__xgafv=None)

+ get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, modelInfoView=None, x__xgafv=None)

Gets a WidgetConfig.

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

@@ -90,7 +90,7 @@

Method Details

- get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, x__xgafv=None) + get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, languageCode=None, modelInfoView=None, x__xgafv=None)
Gets a WidgetConfig.
 
 Args:
@@ -98,6 +98,11 @@ 

Method Details

acceptCache: boolean, Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. getWidgetConfigRequestOption_turnOffCollectionComponents: boolean, Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. languageCode: string, Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English). + modelInfoView: string, Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`). + Allowed values + MODEL_INFO_VIEW_UNSPECIFIED - Not specified. + END_USER_WEB - The end-user web model selector view. + ADMIN - The Cloud Console admin "Feature Control" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -126,11 +131,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -148,8 +164,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -312,7 +328,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -358,6 +374,7 @@

Method Details

"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. }
@@ -392,11 +409,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -414,8 +442,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -578,7 +606,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -624,6 +652,7 @@

Method Details

"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. } @@ -657,11 +686,22 @@

Method Details

"googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, - "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. - { # Read-only collection component that contains data store collections fields that may be used for filtering + "batchAuthStatuses": [ # Output only. The batch authorization statuses for the widget's connectors. + { # Describes the batch authorization status for a batch_authorization_group. + "batchAuthorizationGroup": "A String", # Output only. The batch authorization group the placeholder belongs to. + "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The current authorization state for this connector. + "authState": "A String", # Output only. The authorization state of the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. + "updateTime": "A String", # Output only. The authorization state update timestamp. + }, + "placeholder": "A String", # Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. + }, + ], + "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). + { # Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries. "connectorAuthState": { # Read-only connector in CollectionComponent auth state. # Output only. The auth uri of the connector source. "authState": "A String", # Output only. The authorization state of the data connector. - "authorizationUri": "A String", # Output only. The authorization uri for the data connector. + "authorizationUri": "A String", # Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. "updateTime": "A String", # Output only. The authorization state update timestamp. }, "connectorIconLink": "A String", # Output only. The icon link of the connector source. @@ -679,8 +719,8 @@

Method Details

}, ], "displayName": "A String", # The display name of the collection. - "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. - "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. + "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. + "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. }, ], "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig. @@ -843,7 +883,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -889,6 +929,7 @@

Method Details

"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.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index d320263a7e..6bcdcff658 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -361,8 +361,8 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -703,8 +703,8 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -1021,8 +1021,8 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 4ee9e0f0cc..08e91c8e95 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -1111,7 +1111,7 @@

Method Details

"policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, - "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` + "dataSource": "A String", # Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -1245,6 +1245,14 @@

Method Details

"kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + "metadata": { # User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note). # Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. + "authenticatedAccount": "A String", # Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. + "author": "A String", # Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). + "description": "A String", # Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. + "note": "A String", # Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. + "shortDescription": "A String", # Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). + "title": "A String", # Optional. Display title of the connector. + }, "name": "A String", # Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. @@ -1294,6 +1302,7 @@

Method Details

], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. + "tag": "A String", # Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. }, @@ -1405,7 +1414,7 @@

Method Details

"policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, - "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` + "dataSource": "A String", # Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -1539,6 +1548,14 @@

Method Details

"kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. + "metadata": { # User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note). # Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. + "authenticatedAccount": "A String", # Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. + "author": "A String", # Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). + "description": "A String", # Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. + "note": "A String", # Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. + "shortDescription": "A String", # Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). + "title": "A String", # Optional. Display title of the connector. + }, "name": "A String", # Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. @@ -1588,6 +1605,7 @@

Method Details

], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. + "tag": "A String", # Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. } diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html index db199d2ef1..668abad2f3 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html @@ -141,6 +141,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -196,6 +197,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -257,6 +259,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -323,6 +326,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -396,6 +400,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -451,6 +456,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html index 78e52934a0..f3aeaf2ed3 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html @@ -315,8 +315,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -532,8 +532,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -717,8 +717,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1beta.billingAccounts.billingAccountLicenseConfigs.html b/docs/dyn/discoveryengine_v1beta.billingAccounts.billingAccountLicenseConfigs.html index 5397385e8c..20eba0df09 100644 --- a/docs/dyn/discoveryengine_v1beta.billingAccounts.billingAccountLicenseConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.billingAccounts.billingAccountLicenseConfigs.html @@ -129,6 +129,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -182,6 +183,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html index a3c897035c..b22fb9f9c8 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html @@ -120,8 +120,8 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index 83d6433c23..7d8a12c48e 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -1625,8 +1625,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -1941,8 +1941,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2604,8 +2604,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html index 44653fd62a..145a125dae 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html @@ -285,8 +285,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -512,8 +512,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -664,8 +664,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html index bdcfd3cb07..0174c633f7 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html @@ -123,8 +123,8 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -299,8 +299,8 @@

Method Details

"removeTime": "A String", # Required. Time at which the suggestion was removed. If not set, the current time will be used. "searchHistorySuggestion": "A String", # The search history suggestion to be removed. "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html index 5f84849883..7492c82014 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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "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` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index 5417c63516..16bf906bac 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -1625,8 +1625,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -1941,8 +1941,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2604,8 +2604,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html index baf883aeb2..6d2a328c44 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html @@ -120,8 +120,8 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index 795e6a7c2a..33eeb6f422 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -1625,8 +1625,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -1941,8 +1941,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -2604,8 +2604,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html index d4e671fe88..2776da8b29 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html @@ -285,8 +285,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -512,8 +512,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -664,8 +664,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index 2f278953bf..b778d45a1c 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -357,8 +357,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -695,8 +695,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -1009,8 +1009,8 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html index 9345205235..d1342de634 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html @@ -122,6 +122,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -158,6 +159,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -200,6 +202,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -247,6 +250,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -301,6 +305,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. @@ -337,6 +342,7 @@

Method Details

}, "freeTrial": True or False, # Optional. Whether the license config is for free trial. "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle. + "lastUserUpdateTime": "A String", # Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). "licenseCount": "A String", # Required. Number of licenses purchased. "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html index ca1e5deab2..e42f1f1901 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html @@ -282,8 +282,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -466,8 +466,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. @@ -618,8 +618,8 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. - "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. - "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "preciseLocation": { # Precise location info with multiple representation options. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index b48f9c9c75..4203af213b 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -3795,6 +3795,21 @@ "location": "query", "type": "string" }, +"modelInfoView": { +"description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin \"Feature Management\" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`).", +"enum": [ +"MODEL_INFO_VIEW_UNSPECIFIED", +"END_USER_WEB", +"ADMIN" +], +"enumDescriptions": [ +"Not specified.", +"The end-user web model selector view.", +"The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated." +], +"location": "query", +"type": "string" +}, "name": { "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", "location": "path", @@ -5798,6 +5813,21 @@ "location": "query", "type": "string" }, +"modelInfoView": { +"description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin \"Feature Management\" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`).", +"enum": [ +"MODEL_INFO_VIEW_UNSPECIFIED", +"END_USER_WEB", +"ADMIN" +], +"enumDescriptions": [ +"Not specified.", +"The end-user web model selector view.", +"The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated." +], +"location": "query", +"type": "string" +}, "name": { "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", "location": "path", @@ -8549,6 +8579,21 @@ "location": "query", "type": "string" }, +"modelInfoView": { +"description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin \"Feature Management\" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`).", +"enum": [ +"MODEL_INFO_VIEW_UNSPECIFIED", +"END_USER_WEB", +"ADMIN" +], +"enumDescriptions": [ +"Not specified.", +"The end-user web model selector view.", +"The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated." +], +"location": "query", +"type": "string" +}, "name": { "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", "location": "path", @@ -9667,7 +9712,7 @@ } } }, -"revision": "20260706", +"revision": "20260724", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "A2aV1APIKeySecurityScheme": { @@ -15194,7 +15239,7 @@ "type": "string" }, "dataSource": { -"description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", +"description": "Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).", "type": "string" }, "destinationConfigs": { @@ -15286,6 +15331,10 @@ "readOnly": true, "type": "string" }, +"metadata": { +"$ref": "GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata", +"description": "Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`." +}, "name": { "description": "Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", "type": "string" @@ -15407,6 +15456,10 @@ ], "type": "string" }, +"tag": { +"description": "Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.", +"type": "string" +}, "updateTime": { "description": "Output only. Timestamp the DataConnector was last updated.", "format": "google-datetime", @@ -15421,6 +15474,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata": { +"description": "User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).", +"id": "GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata", +"properties": { +"authenticatedAccount": { +"description": "Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.", +"type": "string" +}, +"author": { +"description": "Optional. The party that authored the connector, e.g. \"Google\" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).", +"type": "string" +}, +"description": { +"description": "Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.", +"type": "string" +}, +"note": { +"description": "Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.", +"type": "string" +}, +"shortDescription": { +"description": "Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).", +"type": "string" +}, +"title": { +"description": "Optional. Display title of the connector.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig": { "description": "Any params and credentials used specifically for EUA connectors.", "id": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig", @@ -16634,7 +16718,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`", "type": "object" }, "industryVertical": { @@ -16976,7 +17060,8 @@ "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -16993,7 +17078,8 @@ "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" }, @@ -17953,6 +18039,11 @@ "readOnly": true, "type": "boolean" }, +"lastUserUpdateTime": { +"description": "Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).", +"format": "google-datetime", +"type": "string" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -18022,7 +18113,8 @@ "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -18039,7 +18131,8 @@ "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" } @@ -18827,7 +18920,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { -"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", +"description": "Response message for CompletionService.PurgeCompletionSuggestions method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", "properties": { "errorSamples": { @@ -21942,11 +22035,11 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1UserInfoPreciseLocation": { -"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.", +"description": "Precise location info with multiple representation options.", "id": "GoogleCloudDiscoveryengineV1UserInfoPreciseLocation", "properties": { "address": { -"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", +"description": "Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", "type": "string" }, "point": { @@ -22067,8 +22160,16 @@ false "description": "Optional. Output only. Describes the assistant settings of the widget.", "readOnly": true }, +"batchAuthStatuses": { +"description": "Output only. The batch authorization statuses for the widget's connectors.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1WidgetConfigBatchAuthStatus" +}, +"readOnly": true, +"type": "array" +}, "collectionComponents": { -"description": "Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.", +"description": "Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior).", "items": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent" }, @@ -22365,8 +22466,30 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1WidgetConfigBatchAuthStatus": { +"description": "Describes the batch authorization status for a batch_authorization_group.", +"id": "GoogleCloudDiscoveryengineV1WidgetConfigBatchAuthStatus", +"properties": { +"batchAuthorizationGroup": { +"description": "Output only. The batch authorization group the placeholder belongs to.", +"readOnly": true, +"type": "string" +}, +"connectorAuthState": { +"$ref": "GoogleCloudDiscoveryengineV1WidgetConfigConnectorAuthState", +"description": "Output only. The current authorization state for this connector.", +"readOnly": true +}, +"placeholder": { +"description": "Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent": { -"description": "Read-only collection component that contains data store collections fields that may be used for filtering", +"description": "Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's \"Connect\" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries.", "id": "GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent", "properties": { "connectorAuthState": { @@ -22400,12 +22523,12 @@ false "type": "string" }, "id": { -"description": "Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.", +"description": "Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id.", "readOnly": true, "type": "string" }, "name": { -"description": "The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field.", +"description": "The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector.", "type": "string" } }, @@ -22425,17 +22548,17 @@ false "NO_AUTH" ], "enumDescriptions": [ -"Default value. This value is unused.", +"Default value. Also returned for synthetic placeholder `CollectionComponent` entries surfaced by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` (SaaS / Business only) \u2014 those entries represent connectors the caller may attach but has not yet attached.", "The user has authorized the data connector.", "The user authorization for the data connector has expired.", "The user can still make search requests but actions need to be enabled.", -"The data connector does not require any authorization." +"The data connector does not require any authorization. Also used for placeholder entries whose underlying connector does not require user OAuth." ], "readOnly": true, "type": "string" }, "authorizationUri": { -"description": "Output only. The authorization uri for the data connector.", +"description": "Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's \"Connect\" click to obtain a freshly-built authorization URL.", "readOnly": true, "type": "string" }, @@ -22758,7 +22881,7 @@ false ], "type": "string" }, -"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`", "readOnly": true, "type": "object" }, @@ -22828,6 +22951,10 @@ false "Display results from extractive answers field." ], "type": "string" +}, +"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" } }, "type": "object" @@ -25793,7 +25920,7 @@ false "description": "Optional. Specifies the data protection policy for the connector." }, "dataSource": { -"description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", +"description": "Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).", "type": "string" }, "destinationConfigs": { @@ -25885,6 +26012,10 @@ false "readOnly": true, "type": "string" }, +"metadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata", +"description": "Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`." +}, "name": { "description": "Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", "type": "string" @@ -26006,6 +26137,10 @@ false ], "type": "string" }, +"tag": { +"description": "Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.", +"type": "string" +}, "updateTime": { "description": "Output only. Timestamp the DataConnector was last updated.", "format": "google-datetime", @@ -26020,6 +26155,37 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata": { +"description": "User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).", +"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata", +"properties": { +"authenticatedAccount": { +"description": "Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.", +"type": "string" +}, +"author": { +"description": "Optional. The party that authored the connector, e.g. \"Google\" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).", +"type": "string" +}, +"description": { +"description": "Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.", +"type": "string" +}, +"note": { +"description": "Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.", +"type": "string" +}, +"shortDescription": { +"description": "Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).", +"type": "string" +}, +"title": { +"description": "Optional. Display title of the connector.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig": { "description": "Any params and credentials used specifically for EUA connectors.", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig", @@ -26280,6 +26446,11 @@ false "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, +"iconUri": { +"description": "Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively.", +"readOnly": true, +"type": "string" +}, "identityMappingStore": { "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", "type": "string" @@ -27110,7 +27281,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`", "type": "object" }, "industryVertical": { @@ -27517,7 +27688,8 @@ false "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -27534,7 +27706,8 @@ false "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" }, @@ -28379,6 +28552,11 @@ false "readOnly": true, "type": "boolean" }, +"lastUserUpdateTime": { +"description": "Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).", +"format": "google-datetime", +"type": "string" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -28448,7 +28626,8 @@ false "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -28465,7 +28644,8 @@ false "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" } @@ -28929,7 +29109,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { -"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", +"description": "Response message for CompletionService.PurgeCompletionSuggestions method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", "properties": { "errorSamples": { @@ -31211,11 +31391,11 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation": { -"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.", +"description": "Precise location info with multiple representation options.", "id": "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation", "properties": { "address": { -"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", +"description": "Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", "type": "string" }, "point": { @@ -32685,7 +32865,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`", "type": "object" }, "industryVertical": { @@ -33027,7 +33207,8 @@ false "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -33044,7 +33225,8 @@ false "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" }, @@ -33601,6 +33783,11 @@ false "readOnly": true, "type": "boolean" }, +"lastUserUpdateTime": { +"description": "Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).", +"format": "google-datetime", +"type": "string" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -33670,7 +33857,8 @@ false "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -33687,7 +33875,8 @@ false "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" } @@ -35605,11 +35794,11 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation": { -"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.", +"description": "Precise location info with multiple representation options.", "id": "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation", "properties": { "address": { -"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", +"description": "Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", "type": "string" }, "point": { diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index a423bc1efb..68b22eee5f 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -1888,6 +1888,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. The view to apply to the returned DataStore. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for a connector-backed data store. Resolving the connector icon requires extra lookups, so request it only when the caller renders the icon.", +"enum": [ +"DATA_STORE_VIEW_UNSPECIFIED", +"DATA_STORE_VIEW_BASIC", +"DATA_STORE_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API defaults to DataStoreView.DATA_STORE_VIEW_BASIC.", +"Does not populate DataStore.icon_uri. This is the default view.", +"Additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request this view only when the icons are rendered." +], +"location": "query", +"type": "string" } }, "path": "v1alpha/{+name}", @@ -2013,6 +2028,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. The view to apply to the returned DataStores. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request it only when the caller renders the icons.", +"enum": [ +"DATA_STORE_VIEW_UNSPECIFIED", +"DATA_STORE_VIEW_BASIC", +"DATA_STORE_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API defaults to DataStoreView.DATA_STORE_VIEW_BASIC.", +"Does not populate DataStore.icon_uri. This is the default view.", +"Additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request this view only when the icons are rendered." +], +"location": "query", +"type": "string" } }, "path": "v1alpha/{+parent}/dataStores", @@ -2188,7 +2218,7 @@ ] }, "updateDocumentProcessingConfig": { -"description": "Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.", +"description": "Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleton resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. The `update_mask` query parameter is not supported; if it is set the request returns an error. To update mutable fields, omit `update_mask` and send the full DocumentProcessingConfig as the request body. The entire resource is overwritten, so include all values you want to retain. For example, to update the layout parser, set DocumentProcessingConfig.default_parsing_config (or DocumentProcessingConfig.parsing_config_overrides) and omit `update_mask`. Some fields, such as DocumentProcessingConfig.chunking_config, are immutable and return an error if changed.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/documentProcessingConfig", "httpMethod": "PATCH", "id": "discoveryengine.projects.locations.collections.dataStores.updateDocumentProcessingConfig", @@ -2204,7 +2234,7 @@ "type": "string" }, "updateMask": { -"description": "Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated.", +"description": "Not supported. If `update_mask` is set, the request returns an `UnsupportedFieldError`. To update mutable fields, omit `update_mask`; the full DocumentProcessingConfig in the request body then overwrites the existing resource. See the method description for details.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -5186,6 +5216,21 @@ "location": "query", "type": "string" }, +"modelInfoView": { +"description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin \"Feature Management\" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`).", +"enum": [ +"MODEL_INFO_VIEW_UNSPECIFIED", +"END_USER_WEB", +"ADMIN" +], +"enumDescriptions": [ +"Not specified.", +"The end-user web model selector view.", +"The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated." +], +"location": "query", +"type": "string" +}, "name": { "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", "location": "path", @@ -7503,7 +7548,7 @@ ] }, "get": { -"description": "Get an existing Experiment.", +"description": "Get an existing AlphaEvolveExperiment.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}", "httpMethod": "GET", "id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.get", @@ -7958,6 +8003,21 @@ "location": "query", "type": "string" }, +"modelInfoView": { +"description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin \"Feature Management\" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`).", +"enum": [ +"MODEL_INFO_VIEW_UNSPECIFIED", +"END_USER_WEB", +"ADMIN" +], +"enumDescriptions": [ +"Not specified.", +"The end-user web model selector view.", +"The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated." +], +"location": "query", +"type": "string" +}, "name": { "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", "location": "path", @@ -8308,6 +8368,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. The view to apply to the returned DataStore. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for a connector-backed data store. Resolving the connector icon requires extra lookups, so request it only when the caller renders the icon.", +"enum": [ +"DATA_STORE_VIEW_UNSPECIFIED", +"DATA_STORE_VIEW_BASIC", +"DATA_STORE_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API defaults to DataStoreView.DATA_STORE_VIEW_BASIC.", +"Does not populate DataStore.icon_uri. This is the default view.", +"Additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request this view only when the icons are rendered." +], +"location": "query", +"type": "string" } }, "path": "v1alpha/{+name}", @@ -8433,6 +8508,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. The view to apply to the returned DataStores. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request it only when the caller renders the icons.", +"enum": [ +"DATA_STORE_VIEW_UNSPECIFIED", +"DATA_STORE_VIEW_BASIC", +"DATA_STORE_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API defaults to DataStoreView.DATA_STORE_VIEW_BASIC.", +"Does not populate DataStore.icon_uri. This is the default view.", +"Additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request this view only when the icons are rendered." +], +"location": "query", +"type": "string" } }, "path": "v1alpha/{+parent}/dataStores", @@ -8578,7 +8668,7 @@ ] }, "updateDocumentProcessingConfig": { -"description": "Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.", +"description": "Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleton resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. The `update_mask` query parameter is not supported; if it is set the request returns an error. To update mutable fields, omit `update_mask` and send the full DocumentProcessingConfig as the request body. The entire resource is overwritten, so include all values you want to retain. For example, to update the layout parser, set DocumentProcessingConfig.default_parsing_config (or DocumentProcessingConfig.parsing_config_overrides) and omit `update_mask`. Some fields, such as DocumentProcessingConfig.chunking_config, are immutable and return an error if changed.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/documentProcessingConfig", "httpMethod": "PATCH", "id": "discoveryengine.projects.locations.dataStores.updateDocumentProcessingConfig", @@ -8594,7 +8684,7 @@ "type": "string" }, "updateMask": { -"description": "Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated.", +"description": "Not supported. If `update_mask` is set, the request returns an `UnsupportedFieldError`. To update mutable fields, omit `update_mask`; the full DocumentProcessingConfig in the request body then overwrites the existing resource. See the method description for details.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -11179,6 +11269,21 @@ "location": "query", "type": "string" }, +"modelInfoView": { +"description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin \"Feature Management\" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`).", +"enum": [ +"MODEL_INFO_VIEW_UNSPECIFIED", +"END_USER_WEB", +"ADMIN" +], +"enumDescriptions": [ +"Not specified.", +"The end-user web model selector view.", +"The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated." +], +"location": "query", +"type": "string" +}, "name": { "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", "location": "path", @@ -13292,7 +13397,7 @@ } } }, -"revision": "20260706", +"revision": "20260724", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -14908,7 +15013,7 @@ "type": "string" }, "dataSource": { -"description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", +"description": "Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).", "type": "string" }, "destinationConfigs": { @@ -15000,6 +15105,10 @@ "readOnly": true, "type": "string" }, +"metadata": { +"$ref": "GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata", +"description": "Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`." +}, "name": { "description": "Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", "type": "string" @@ -15121,6 +15230,10 @@ ], "type": "string" }, +"tag": { +"description": "Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.", +"type": "string" +}, "updateTime": { "description": "Output only. Timestamp the DataConnector was last updated.", "format": "google-datetime", @@ -15135,6 +15248,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata": { +"description": "User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).", +"id": "GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata", +"properties": { +"authenticatedAccount": { +"description": "Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.", +"type": "string" +}, +"author": { +"description": "Optional. The party that authored the connector, e.g. \"Google\" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).", +"type": "string" +}, +"description": { +"description": "Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.", +"type": "string" +}, +"note": { +"description": "Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.", +"type": "string" +}, +"shortDescription": { +"description": "Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).", +"type": "string" +}, +"title": { +"description": "Optional. Display title of the connector.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig": { "description": "Any params and credentials used specifically for EUA connectors.", "id": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig", @@ -16106,7 +16250,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`", "type": "object" }, "industryVertical": { @@ -16448,7 +16592,8 @@ "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -16465,7 +16610,8 @@ "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" }, @@ -16845,6 +16991,11 @@ "readOnly": true, "type": "boolean" }, +"lastUserUpdateTime": { +"description": "Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).", +"format": "google-datetime", +"type": "string" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -16914,7 +17065,8 @@ "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -16931,7 +17083,8 @@ "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" } @@ -17273,7 +17426,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { -"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", +"description": "Response message for CompletionService.PurgeCompletionSuggestions method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", "properties": { "errorSamples": { @@ -18760,6 +18913,11 @@ "readOnly": true, "type": "string" }, +"creationFailureReason": { +"description": "Output only. The reason why the agent creation (provisioning) failed. Only set if the state is CREATION_FAILED.", +"readOnly": true, +"type": "string" +}, "customPlaceholderText": { "description": "Optional. The custom placeholder text that appears in the text box before the user enters any text.", "type": "string" @@ -18828,7 +18986,8 @@ "PRIVATE", "ENABLED", "SUSPENDED", -"CREATING" +"CREATING", +"CREATION_FAILED" ], "enumDescriptions": [ "The state is unspecified.", @@ -18839,7 +18998,8 @@ "Agent is available only to its creator..", "Agent is available for users who have access.", "Agent is temporarily unavailable, though visible to users who have access.", -"Agent is being created." +"Agent is being created.", +"Agent creation (provisioning) failed. Terminal. To retry, the caller must `DeleteAgent` to clear the failed resource and then create again; there is no in-place overwrite of a failed agent. Only set for asynchronously-provisioned agents." ], "readOnly": true, "type": "string" @@ -22089,7 +22249,8 @@ "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -22106,7 +22267,8 @@ "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" } @@ -22921,7 +23083,8 @@ "type": "string" }, "filterPiiSuggestionsUsingDlp": { -"description": "If true, with best effort, try to detect and remove the suggestions containing certain types of PII information. This detection is performated by [DLP](https://cloud.google.com/security/products/dlp) under the hood.", +"deprecated": true, +"description": "Deprecated: this field has no effect. As of May 2025, PII suggestion filtering using [DLP](https://cloud.google.com/security/products/dlp) is always on for all data stores and can't be configured per data store.", "type": "boolean" }, "matchingOrder": { @@ -24078,7 +24241,7 @@ "description": "Optional. Specifies the data protection policy for the connector." }, "dataSource": { -"description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", +"description": "Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).", "type": "string" }, "destinationConfigs": { @@ -24170,6 +24333,10 @@ "readOnly": true, "type": "string" }, +"metadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata", +"description": "Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`." +}, "name": { "description": "Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", "type": "string" @@ -24291,6 +24458,10 @@ ], "type": "string" }, +"tag": { +"description": "Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.", +"type": "string" +}, "updateTime": { "description": "Output only. Timestamp the DataConnector was last updated.", "format": "google-datetime", @@ -24305,6 +24476,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata": { +"description": "User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).", +"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata", +"properties": { +"authenticatedAccount": { +"description": "Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.", +"type": "string" +}, +"author": { +"description": "Optional. The party that authored the connector, e.g. \"Google\" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).", +"type": "string" +}, +"description": { +"description": "Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.", +"type": "string" +}, +"note": { +"description": "Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.", +"type": "string" +}, +"shortDescription": { +"description": "Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).", +"type": "string" +}, +"title": { +"description": "Optional. Display title of the connector.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig": { "description": "Any params and credentials used specifically for EUA connectors.", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig", @@ -24565,6 +24767,11 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, +"iconUri": { +"description": "Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively.", +"readOnly": true, +"type": "string" +}, "identityMappingStore": { "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", "type": "string" @@ -25659,7 +25866,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`", "type": "object" }, "industryVertical": { @@ -26066,7 +26273,8 @@ "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -26083,7 +26291,8 @@ "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" }, @@ -27954,6 +28163,11 @@ "readOnly": true, "type": "boolean" }, +"lastUserUpdateTime": { +"description": "Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).", +"format": "google-datetime", +"type": "string" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -28023,7 +28237,8 @@ "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -28040,7 +28255,8 @@ "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" } @@ -29268,7 +29484,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { -"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", +"description": "Response message for CompletionService.PurgeCompletionSuggestions method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", "properties": { "errorSamples": { @@ -32229,6 +32445,10 @@ false "rankSignals": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRankSignals", "description": "Optional. A set of ranking signals associated with the result." +}, +"retrievalSignals": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRetrievalSignals", +"description": "Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds." } }, "type": "object" @@ -32311,6 +32531,35 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRetrievalSignals": { +"description": "Contains a set of signals used by the relevance filter.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRetrievalSignals", +"properties": { +"retrievalSources": { +"description": "Optional. Indicates how the result was retrieved.", +"items": { +"enum": [ +"RETRIEVAL_SOURCE_UNSPECIFIED", +"KEYWORD_SEARCH", +"SEMANTIC_SEARCH" +], +"enumDescriptions": [ +"Unspecified retrieval source.", +"Indicates the result was retrieved by keyword search.", +"Indicates the result was retrieved by semantic search." +], +"type": "string" +}, +"type": "array" +}, +"semanticRelevanceScore": { +"description": "Optional. Relevance score used by the filter when semantic_relevance_threshold is set.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo": { "description": "Information about the session.", "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo", @@ -33957,11 +34206,11 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation": { -"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.", +"description": "Precise location info with multiple representation options.", "id": "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation", "properties": { "address": { -"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", +"description": "Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", "type": "string" }, "point": { @@ -34141,8 +34390,16 @@ false "description": "Optional. Output only. Describes the assistant settings of the widget.", "readOnly": true }, +"batchAuthStatuses": { +"description": "Output only. The batch authorization statuses for the widget's connectors.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigBatchAuthStatus" +}, +"readOnly": true, +"type": "array" +}, "collectionComponents": { -"description": "Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.", +"description": "Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior).", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent" }, @@ -34439,8 +34696,30 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaWidgetConfigBatchAuthStatus": { +"description": "Describes the batch authorization status for a batch_authorization_group.", +"id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigBatchAuthStatus", +"properties": { +"batchAuthorizationGroup": { +"description": "Output only. The batch authorization group the placeholder belongs to.", +"readOnly": true, +"type": "string" +}, +"connectorAuthState": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigConnectorAuthState", +"description": "Output only. The current authorization state for this connector.", +"readOnly": true +}, +"placeholder": { +"description": "Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent": { -"description": "Read-only collection component that contains data store collections fields that may be used for filtering", +"description": "Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's \"Connect\" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries.", "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent", "properties": { "connectorAuthState": { @@ -34474,12 +34753,12 @@ false "type": "string" }, "id": { -"description": "Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.", +"description": "Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id.", "readOnly": true, "type": "string" }, "name": { -"description": "The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field.", +"description": "The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector.", "type": "string" } }, @@ -34499,17 +34778,17 @@ false "NO_AUTH" ], "enumDescriptions": [ -"Default value. This value is unused.", +"Default value. Also returned for synthetic placeholder `CollectionComponent` entries surfaced by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` (SaaS / Business only) \u2014 those entries represent connectors the caller may attach but has not yet attached.", "The user has authorized the data connector.", "The user authorization for the data connector has expired.", "The user can still make search requests but actions need to be enabled.", -"The data connector does not require any authorization." +"The data connector does not require any authorization. Also used for placeholder entries whose underlying connector does not require user OAuth." ], "readOnly": true, "type": "string" }, "authorizationUri": { -"description": "Output only. The authorization uri for the data connector.", +"description": "Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's \"Connect\" click to obtain a freshly-built authorization URL.", "readOnly": true, "type": "string" }, @@ -34880,7 +35159,7 @@ false ], "type": "string" }, -"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`", "readOnly": true, "type": "object" }, @@ -34954,6 +35233,10 @@ false "searchAddonSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec", "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" } }, "type": "object" @@ -36537,7 +36820,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`", "type": "object" }, "industryVertical": { @@ -36879,7 +37162,8 @@ false "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -36896,7 +37180,8 @@ false "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" }, @@ -37453,6 +37738,11 @@ false "readOnly": true, "type": "boolean" }, +"lastUserUpdateTime": { +"description": "Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).", +"format": "google-datetime", +"type": "string" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -37522,7 +37812,8 @@ false "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -37539,7 +37830,8 @@ false "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" } @@ -39457,11 +39749,11 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation": { -"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.", +"description": "Precise location info with multiple representation options.", "id": "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation", "properties": { "address": { -"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", +"description": "Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", "type": "string" }, "point": { diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 28009ab7e9..2753fc014d 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -9524,7 +9524,7 @@ } } }, -"revision": "20260706", +"revision": "20260724", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -11140,7 +11140,7 @@ "type": "string" }, "dataSource": { -"description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", +"description": "Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).", "type": "string" }, "destinationConfigs": { @@ -11232,6 +11232,10 @@ "readOnly": true, "type": "string" }, +"metadata": { +"$ref": "GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata", +"description": "Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`." +}, "name": { "description": "Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", "type": "string" @@ -11353,6 +11357,10 @@ ], "type": "string" }, +"tag": { +"description": "Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.", +"type": "string" +}, "updateTime": { "description": "Output only. Timestamp the DataConnector was last updated.", "format": "google-datetime", @@ -11367,6 +11375,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata": { +"description": "User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).", +"id": "GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata", +"properties": { +"authenticatedAccount": { +"description": "Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.", +"type": "string" +}, +"author": { +"description": "Optional. The party that authored the connector, e.g. \"Google\" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).", +"type": "string" +}, +"description": { +"description": "Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.", +"type": "string" +}, +"note": { +"description": "Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.", +"type": "string" +}, +"shortDescription": { +"description": "Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).", +"type": "string" +}, +"title": { +"description": "Optional. Display title of the connector.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig": { "description": "Any params and credentials used specifically for EUA connectors.", "id": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig", @@ -12338,7 +12377,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`", "type": "object" }, "industryVertical": { @@ -12680,7 +12719,8 @@ "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -12697,7 +12737,8 @@ "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" }, @@ -13077,6 +13118,11 @@ "readOnly": true, "type": "boolean" }, +"lastUserUpdateTime": { +"description": "Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).", +"format": "google-datetime", +"type": "string" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -13146,7 +13192,8 @@ "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -13163,7 +13210,8 @@ "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" } @@ -13505,7 +13553,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { -"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", +"description": "Response message for CompletionService.PurgeCompletionSuggestions method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", "properties": { "errorSamples": { @@ -17213,7 +17261,7 @@ "description": "Optional. Specifies the data protection policy for the connector." }, "dataSource": { -"description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", +"description": "Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).", "type": "string" }, "destinationConfigs": { @@ -17305,6 +17353,10 @@ "readOnly": true, "type": "string" }, +"metadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata", +"description": "Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`." +}, "name": { "description": "Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", "type": "string" @@ -17426,6 +17478,10 @@ ], "type": "string" }, +"tag": { +"description": "Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.", +"type": "string" +}, "updateTime": { "description": "Output only. Timestamp the DataConnector was last updated.", "format": "google-datetime", @@ -17440,6 +17496,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata": { +"description": "User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).", +"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata", +"properties": { +"authenticatedAccount": { +"description": "Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.", +"type": "string" +}, +"author": { +"description": "Optional. The party that authored the connector, e.g. \"Google\" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).", +"type": "string" +}, +"description": { +"description": "Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.", +"type": "string" +}, +"note": { +"description": "Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.", +"type": "string" +}, +"shortDescription": { +"description": "Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).", +"type": "string" +}, +"title": { +"description": "Optional. Display title of the connector.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig": { "description": "Any params and credentials used specifically for EUA connectors.", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig", @@ -17700,6 +17787,11 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, +"iconUri": { +"description": "Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively.", +"readOnly": true, +"type": "string" +}, "identityMappingStore": { "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", "type": "string" @@ -18530,7 +18622,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`", "type": "object" }, "industryVertical": { @@ -18937,7 +19029,8 @@ "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -18954,7 +19047,8 @@ "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" }, @@ -19799,6 +19893,11 @@ "readOnly": true, "type": "boolean" }, +"lastUserUpdateTime": { +"description": "Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).", +"format": "google-datetime", +"type": "string" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -19868,7 +19967,8 @@ "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -19885,7 +19985,8 @@ "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" } @@ -20349,7 +20450,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { -"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", +"description": "Response message for CompletionService.PurgeCompletionSuggestions method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", "properties": { "errorSamples": { @@ -22631,11 +22732,11 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation": { -"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.", +"description": "Precise location info with multiple representation options.", "id": "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation", "properties": { "address": { -"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", +"description": "Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", "type": "string" }, "point": { @@ -27688,7 +27789,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`", "type": "object" }, "industryVertical": { @@ -28030,7 +28131,8 @@ false "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -28047,7 +28149,8 @@ false "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" }, @@ -29194,6 +29297,11 @@ false "readOnly": true, "type": "boolean" }, +"lastUserUpdateTime": { +"description": "Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).", +"format": "google-datetime", +"type": "string" +}, "licenseCount": { "description": "Required. Number of licenses purchased.", "format": "int64", @@ -29263,7 +29371,8 @@ false "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", -"SUBSCRIPTION_TIER_CONSUMPTION_ONLY" +"SUBSCRIPTION_TIER_CONSUMPTION_ONLY", +"SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", @@ -29280,7 +29389,8 @@ false "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", -"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG)." +"Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", +"Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string" } @@ -33977,11 +34087,11 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation": { -"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.", +"description": "Precise location info with multiple representation options.", "id": "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation", "properties": { "address": { -"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", +"description": "Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", "type": "string" }, "point": { From 75a5a4971a210d9630d5e70d8562c53b2bbe7969 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:04 +0000 Subject: [PATCH 45/84] feat(displayvideo): update the api #### displayvideo:v2 The following keys were added: - schemas.Advertiser.properties.defaultBusinessName.type (Total Keys: 1) - schemas.Advertiser.properties.defaultLogoAssetId (Total Keys: 2) - schemas.Creative.properties.syntheticContentAttestationStatus.type (Total Keys: 1) #### displayvideo:v3 The following keys were added: - schemas.Advertiser.properties.defaultBusinessName.type (Total Keys: 1) - schemas.Advertiser.properties.defaultLogoAssetId (Total Keys: 2) - schemas.Creative.properties.syntheticContentAttestationStatus.type (Total Keys: 1) #### displayvideo:v4 The following keys were deleted: - schemas.PlannableTargeting.properties.network (Total Keys: 2) The following keys were added: - resources.advertisers.resources.adAssets.methods.patch (Total Keys: 21) - schemas.AdAsset.properties.syntheticContentAttestationStatus.type (Total Keys: 1) - schemas.Advertiser.properties.defaultBusinessName.type (Total Keys: 1) - schemas.Advertiser.properties.defaultLogoAssetId (Total Keys: 2) - schemas.Creative.properties.syntheticContentAttestationStatus.type (Total Keys: 1) - schemas.PlannableTargeting.properties.network (Total Keys: 3) - schemas.PlannedProductForecast.properties.onTargetCoviewImpressions (Total Keys: 2) - schemas.PlannedProductForecast.properties.onTargetCoviewReach (Total Keys: 2) - schemas.PlannedProductForecast.properties.totalCoviewImpressions (Total Keys: 2) - schemas.PlannedProductForecast.properties.totalCoviewReach (Total Keys: 2) - schemas.UploadAdAssetRequest.properties.syntheticContentAttestationStatus.type (Total Keys: 1) --- ...displayvideo_v2.advertisers.creatives.html | 6 + docs/dyn/displayvideo_v2.advertisers.html | 12 ++ ...displayvideo_v2.advertisers.lineItems.html | 14 +- ...isplayvideo_v3.advertisers.adGroupAds.html | 96 ++++++------ ...displayvideo_v3.advertisers.creatives.html | 6 + docs/dyn/displayvideo_v3.advertisers.html | 12 ++ ...displayvideo_v3.advertisers.lineItems.html | 28 ++-- .../displayvideo_v4.advertisers.adAssets.html | 53 +++++++ ...isplayvideo_v4.advertisers.adGroupAds.html | 96 ++++++------ ...displayvideo_v4.advertisers.creatives.html | 6 + docs/dyn/displayvideo_v4.advertisers.html | 12 ++ ...displayvideo_v4.advertisers.lineItems.html | 28 ++-- ...layvideo_v4.advertisers.reachForecast.html | 12 +- .../documents/displayvideo.v2.json | 27 +++- .../documents/displayvideo.v3.json | 43 ++++-- .../documents/displayvideo.v4.json | 144 ++++++++++++++++-- 16 files changed, 438 insertions(+), 157 deletions(-) diff --git a/docs/dyn/displayvideo_v2.advertisers.creatives.html b/docs/dyn/displayvideo_v2.advertisers.creatives.html index c670b6196f..398bf92ae9 100644 --- a/docs/dyn/displayvideo_v2.advertisers.creatives.html +++ b/docs/dyn/displayvideo_v2.advertisers.creatives.html @@ -221,6 +221,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -381,6 +382,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -568,6 +570,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -741,6 +744,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -921,6 +925,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -1082,6 +1087,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. diff --git a/docs/dyn/displayvideo_v2.advertisers.html b/docs/dyn/displayvideo_v2.advertisers.html index 8a4a130fd5..7fc29f4fa3 100644 --- a/docs/dyn/displayvideo_v2.advertisers.html +++ b/docs/dyn/displayvideo_v2.advertisers.html @@ -249,6 +249,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -313,6 +315,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -1021,6 +1025,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -1098,6 +1104,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -1509,6 +1517,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -1574,6 +1584,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.html index 67c3c4814c..a38316615c 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.html @@ -859,7 +859,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1130,7 +1130,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1361,7 +1361,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1647,7 +1647,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1891,7 +1891,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2142,7 +2142,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2374,7 +2374,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html index 777833e9f1..c2bb354e27 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html @@ -292,7 +292,7 @@

Method Details

"trackingAdId": "A String", # Required. The DCM tracking ad id. }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -335,7 +335,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -348,7 +348,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -362,7 +362,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logoImages": [ # The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -410,7 +410,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -421,7 +421,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -434,7 +434,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -459,7 +459,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -805,7 +805,7 @@

Method Details

"trackingAdId": "A String", # Required. The DCM tracking ad id. }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -848,7 +848,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -861,7 +861,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -875,7 +875,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logoImages": [ # The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -923,7 +923,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -934,7 +934,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -947,7 +947,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -972,7 +972,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1345,7 +1345,7 @@

Method Details

"trackingAdId": "A String", # Required. The DCM tracking ad id. }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -1388,7 +1388,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1401,7 +1401,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -1415,7 +1415,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logoImages": [ # The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -1463,7 +1463,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -1474,7 +1474,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1487,7 +1487,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1512,7 +1512,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1871,7 +1871,7 @@

Method Details

"trackingAdId": "A String", # Required. The DCM tracking ad id. }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -1914,7 +1914,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1927,7 +1927,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -1941,7 +1941,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logoImages": [ # The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -1989,7 +1989,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2000,7 +2000,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2013,7 +2013,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2038,7 +2038,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2404,7 +2404,7 @@

Method Details

"trackingAdId": "A String", # Required. The DCM tracking ad id. }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -2447,7 +2447,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2460,7 +2460,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2474,7 +2474,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logoImages": [ # The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -2522,7 +2522,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2533,7 +2533,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2546,7 +2546,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2571,7 +2571,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2918,7 +2918,7 @@

Method Details

"trackingAdId": "A String", # Required. The DCM tracking ad id. }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -2961,7 +2961,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2974,7 +2974,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2988,7 +2988,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logoImages": [ # The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -3036,7 +3036,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -3047,7 +3047,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -3060,7 +3060,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -3085,7 +3085,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. diff --git a/docs/dyn/displayvideo_v3.advertisers.creatives.html b/docs/dyn/displayvideo_v3.advertisers.creatives.html index af1e834e4d..b35aae2ea2 100644 --- a/docs/dyn/displayvideo_v3.advertisers.creatives.html +++ b/docs/dyn/displayvideo_v3.advertisers.creatives.html @@ -221,6 +221,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -381,6 +382,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -568,6 +570,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -741,6 +744,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -921,6 +925,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -1082,6 +1087,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. diff --git a/docs/dyn/displayvideo_v3.advertisers.html b/docs/dyn/displayvideo_v3.advertisers.html index 888ea70e77..c4995bbb3e 100644 --- a/docs/dyn/displayvideo_v3.advertisers.html +++ b/docs/dyn/displayvideo_v3.advertisers.html @@ -247,6 +247,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -314,6 +316,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -1111,6 +1115,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -1191,6 +1197,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -1648,6 +1656,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -1716,6 +1726,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.html index 61459cd376..ed312d0f70 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.html @@ -951,7 +951,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1066,7 +1066,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1222,7 +1222,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1337,7 +1337,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1453,7 +1453,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1568,7 +1568,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1739,7 +1739,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1854,7 +1854,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1983,7 +1983,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2098,7 +2098,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2234,7 +2234,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2349,7 +2349,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2466,7 +2466,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2581,7 +2581,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. diff --git a/docs/dyn/displayvideo_v4.advertisers.adAssets.html b/docs/dyn/displayvideo_v4.advertisers.adAssets.html index 8319724af8..35c3fb51de 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adAssets.html +++ b/docs/dyn/displayvideo_v4.advertisers.adAssets.html @@ -92,6 +92,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ patch(advertiserId, adAssetId, body=None, updateMask=None, x__xgafv=None)

+

Updates an ad asset. Returns the updated ad asset if successful. Supports updating assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO` and `AD_ASSET_TYPE_IMAGE`. Only the `synthetic_content_attestation_status` field is mutable.

upload(advertiserId, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`.

@@ -112,6 +115,7 @@

Method Details

"adAssetType": "A String", # Required. The type of the ad asset. "entityStatus": "A String", # Output only. The entity status of the ad asset. "name": "A String", # Identifier. The resource name of the ad asset. + "syntheticContentAttestationStatus": "A String", # Optional. Whether the asset contains synthetic content or was created using AI. "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data. "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL. }, @@ -134,6 +138,7 @@

Method Details

"adAssetType": "A String", # Required. The type of the ad asset. "entityStatus": "A String", # Output only. The entity status of the ad asset. "name": "A String", # Identifier. The resource name of the ad asset. + "syntheticContentAttestationStatus": "A String", # Optional. Whether the asset contains synthetic content or was created using AI. "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data. "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL. }, @@ -162,6 +167,7 @@

Method Details

"adAssetType": "A String", # Required. The type of the ad asset. "entityStatus": "A String", # Output only. The entity status of the ad asset. "name": "A String", # Identifier. The resource name of the ad asset. + "syntheticContentAttestationStatus": "A String", # Optional. Whether the asset contains synthetic content or was created using AI. "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data. "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL. }, @@ -181,6 +187,7 @@

Method Details

"adAssetType": "A String", # Required. The type of the ad asset. "entityStatus": "A String", # Output only. The entity status of the ad asset. "name": "A String", # Identifier. The resource name of the ad asset. + "syntheticContentAttestationStatus": "A String", # Optional. Whether the asset contains synthetic content or was created using AI. "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data. "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL. }, @@ -207,6 +214,7 @@

Method Details

"adAssetType": "A String", # Required. The type of the ad asset. "entityStatus": "A String", # Output only. The entity status of the ad asset. "name": "A String", # Identifier. The resource name of the ad asset. + "syntheticContentAttestationStatus": "A String", # Optional. Whether the asset contains synthetic content or was created using AI. "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data. "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL. }, @@ -238,6 +246,7 @@

Method Details

"adAssetType": "A String", # Required. The type of the ad asset. "entityStatus": "A String", # Output only. The entity status of the ad asset. "name": "A String", # Identifier. The resource name of the ad asset. + "syntheticContentAttestationStatus": "A String", # Optional. Whether the asset contains synthetic content or was created using AI. "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data. "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL. }, @@ -261,6 +270,48 @@

Method Details

+
+ patch(advertiserId, adAssetId, body=None, updateMask=None, x__xgafv=None) +
Updates an ad asset. Returns the updated ad asset if successful. Supports updating assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO` and `AD_ASSET_TYPE_IMAGE`. Only the `synthetic_content_attestation_status` field is mutable.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this ad asset belongs to. (required)
+  adAssetId: string, Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single ad asset.
+  "adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
+  "adAssetType": "A String", # Required. The type of the ad asset.
+  "entityStatus": "A String", # Output only. The entity status of the ad asset.
+  "name": "A String", # Identifier. The resource name of the ad asset.
+  "syntheticContentAttestationStatus": "A String", # Optional. Whether the asset contains synthetic content or was created using AI.
+  "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
+    "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
+  },
+}
+
+  updateMask: string, Required. The list of fields to update. Only AdAsset.synthetic_content_attestation_status is mutable.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single ad asset.
+  "adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
+  "adAssetType": "A String", # Required. The type of the ad asset.
+  "entityStatus": "A String", # Output only. The entity status of the ad asset.
+  "name": "A String", # Identifier. The resource name of the ad asset.
+  "syntheticContentAttestationStatus": "A String", # Optional. Whether the asset contains synthetic content or was created using AI.
+  "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
+    "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
+  },
+}
+
+
upload(advertiserId, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`.
@@ -273,6 +324,7 @@ 

Method Details

{ # A request message for UploadAdAsset. "adAssetType": "A String", # Required. The type of the ad asset. Only `AD_ASSET_TYPE_IMAGE` is supported. "filename": "A String", # Required. The filename of the ad asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes. + "syntheticContentAttestationStatus": "A String", # Optional. Whether the asset contains synthetic content or was created using AI. } media_body: string, The filename of the media request body, or an instance of a MediaUpload object. @@ -291,6 +343,7 @@

Method Details

"adAssetType": "A String", # Required. The type of the ad asset. "entityStatus": "A String", # Output only. The entity status of the ad asset. "name": "A String", # Identifier. The resource name of the ad asset. + "syntheticContentAttestationStatus": "A String", # Optional. Whether the asset contains synthetic content or was created using AI. "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data. "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL. }, diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html index 26da9e185a..0100094db5 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html @@ -292,7 +292,7 @@

Method Details

"trackingAdId": "A String", # Required. The DCM tracking ad id. }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -335,7 +335,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -348,7 +348,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -362,7 +362,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logoImages": [ # The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -410,7 +410,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -421,7 +421,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -434,7 +434,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -459,7 +459,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -805,7 +805,7 @@

Method Details

"trackingAdId": "A String", # Required. The DCM tracking ad id. }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -848,7 +848,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -861,7 +861,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -875,7 +875,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logoImages": [ # The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -923,7 +923,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -934,7 +934,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -947,7 +947,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -972,7 +972,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1345,7 +1345,7 @@

Method Details

"trackingAdId": "A String", # Required. The DCM tracking ad id. }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -1388,7 +1388,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1401,7 +1401,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -1415,7 +1415,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logoImages": [ # The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -1463,7 +1463,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -1474,7 +1474,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1487,7 +1487,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1512,7 +1512,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1871,7 +1871,7 @@

Method Details

"trackingAdId": "A String", # Required. The DCM tracking ad id. }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -1914,7 +1914,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1927,7 +1927,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -1941,7 +1941,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logoImages": [ # The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -1989,7 +1989,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2000,7 +2000,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2013,7 +2013,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2038,7 +2038,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2404,7 +2404,7 @@

Method Details

"trackingAdId": "A String", # Required. The DCM tracking ad id. }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -2447,7 +2447,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2460,7 +2460,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2474,7 +2474,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logoImages": [ # The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -2522,7 +2522,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2533,7 +2533,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2546,7 +2546,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2571,7 +2571,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2918,7 +2918,7 @@

Method Details

"trackingAdId": "A String", # Required. The DCM tracking ad id. }, "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -2961,7 +2961,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2974,7 +2974,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2988,7 +2988,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logoImages": [ # The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -3036,7 +3036,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -3047,7 +3047,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -3060,7 +3060,7 @@

Method Details

"userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). - "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "businessName": "A String", # Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -3085,7 +3085,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. + "logo": { # Meta data of an image asset. # Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. diff --git a/docs/dyn/displayvideo_v4.advertisers.creatives.html b/docs/dyn/displayvideo_v4.advertisers.creatives.html index 1b215919d0..b3bcb399d2 100644 --- a/docs/dyn/displayvideo_v4.advertisers.creatives.html +++ b/docs/dyn/displayvideo_v4.advertisers.creatives.html @@ -215,6 +215,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -369,6 +370,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -550,6 +552,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -717,6 +720,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -891,6 +895,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. @@ -1046,6 +1051,7 @@

Method Details

"seconds": "A String", # Optional. The offset in seconds from the start of the audio or video. }, "skippable": True or False, # Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + "syntheticContentAttestationStatus": "A String", # Optional. Whether the creative contains synthetic content or was created using AI. "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` "thirdPartyUrls": [ # Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` { # Tracking URLs from third parties to track interactions with an audio or a video creative. diff --git a/docs/dyn/displayvideo_v4.advertisers.html b/docs/dyn/displayvideo_v4.advertisers.html index 0d3b676a40..adde03eac5 100644 --- a/docs/dyn/displayvideo_v4.advertisers.html +++ b/docs/dyn/displayvideo_v4.advertisers.html @@ -257,6 +257,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -324,6 +326,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -1121,6 +1125,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -1201,6 +1207,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -1658,6 +1666,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. @@ -1726,6 +1736,8 @@

Method Details

}, }, }, + "defaultBusinessName": "A String", # Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. + "defaultLogoAssetId": "A String", # Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. "displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.html index fa29f83e23..c709db1262 100644 --- a/docs/dyn/displayvideo_v4.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.html @@ -956,7 +956,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1071,7 +1071,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1227,7 +1227,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1342,7 +1342,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1458,7 +1458,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1573,7 +1573,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1744,7 +1744,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1859,7 +1859,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1988,7 +1988,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2103,7 +2103,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2239,7 +2239,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2354,7 +2354,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2471,7 +2471,7 @@

Method Details

"geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2586,7 +2586,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. diff --git a/docs/dyn/displayvideo_v4.advertisers.reachForecast.html b/docs/dyn/displayvideo_v4.advertisers.reachForecast.html index e9c4fbe9fd..f0a831bf7e 100644 --- a/docs/dyn/displayvideo_v4.advertisers.reachForecast.html +++ b/docs/dyn/displayvideo_v4.advertisers.reachForecast.html @@ -217,8 +217,12 @@

Method Details

{ # A single point in the reach curve. "costMicros": "A String", # Total cost for this point in micros. "forecast": { # Performance metrics for a forecast point. # Aggregate forecast for the entire plan. + "onTargetCoviewImpressions": "A String", # Number of on-target impressions including co-viewers. + "onTargetCoviewReach": "A String", # Number of unique people reached that match the on-target definition including co-viewers. "onTargetImpressions": "A String", # Number of on-target impressions. "onTargetReach": "A String", # Number of unique people reached that match the on-target definition. + "totalCoviewImpressions": "A String", # Total number of impressions including co-viewers. + "totalCoviewReach": "A String", # Total number of unique people reached including co-viewers. "totalImpressions": "A String", # Total number of impressions. "totalReach": "A String", # Total number of unique people reached. "trueviewViews": "A String", # Number of TrueView views. @@ -229,8 +233,12 @@

Method Details

"costMicros": "A String", # The cost in micros for this product. "plannableProductCode": "A String", # The code for the product. "plannedProductForecast": { # Performance metrics for a forecast point. # Performance metrics for the product. + "onTargetCoviewImpressions": "A String", # Number of on-target impressions including co-viewers. + "onTargetCoviewReach": "A String", # Number of unique people reached that match the on-target definition including co-viewers. "onTargetImpressions": "A String", # Number of on-target impressions. "onTargetReach": "A String", # Number of unique people reached that match the on-target definition. + "totalCoviewImpressions": "A String", # Total number of impressions including co-viewers. + "totalCoviewReach": "A String", # Total number of unique people reached including co-viewers. "totalImpressions": "A String", # Total number of impressions. "totalReach": "A String", # Total number of unique people reached. "trueviewViews": "A String", # Number of TrueView views. @@ -312,7 +320,9 @@

Method Details

"genders": [ # Output only. Targetable genders for the ad product. "A String", ], - "network": "A String", # Output only. Targetable network for the ad product. + "networks": [ # Output only. Targetable networks for the ad product. + "A String", + ], "surfaceTargetingCombinations": { # Surface targeting rules. # Output only. Targetable surface combinations for the ad product. "availableSurfaceTypes": [ # Output only. The surface types available. "A String", diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index 2df6dbc8fb..e9bf5ecf19 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -7823,7 +7823,7 @@ } } }, -"revision": "20260630", +"revision": "20260720", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -8048,6 +8048,15 @@ "$ref": "AdvertiserDataAccessConfig", "description": "Settings that control how advertiser data may be accessed." }, +"defaultBusinessName": { +"description": "Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided.", +"type": "string" +}, +"defaultLogoAssetId": { +"description": "Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API.", +"format": "int64", +"type": "string" +}, "displayName": { "description": "Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.", "type": "string" @@ -11177,6 +11186,20 @@ false "description": "Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`", "type": "boolean" }, +"syntheticContentAttestationStatus": { +"description": "Optional. Whether the creative contains synthetic content or was created using AI.", +"enum": [ +"SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED", +"NOT_SYNTHETIC", +"IS_SYNTHETIC" +], +"enumDescriptions": [ +"Attestation status is unspecified.", +"Not synthetic content.", +"Is synthetic content." +], +"type": "string" +}, "thirdPartyTag": { "description": "Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`", "type": "string" @@ -18290,7 +18313,7 @@ true "id": "ThirdPartyMeasurementConfigs", "properties": { "brandLiftVendorConfigs": { -"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`.", +"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL`", "items": { "$ref": "ThirdPartyVendorConfig" }, diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index 236a6f1440..4bc9fa02b7 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -8360,7 +8360,7 @@ } } }, -"revision": "20260630", +"revision": "20260720", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9677,6 +9677,15 @@ "$ref": "AdvertiserDataAccessConfig", "description": "Settings that control how advertiser data may be accessed." }, +"defaultBusinessName": { +"description": "Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided.", +"type": "string" +}, +"defaultLogoAssetId": { +"description": "Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API.", +"format": "int64", +"type": "string" +}, "displayName": { "description": "Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.", "type": "string" @@ -13673,6 +13682,20 @@ false "description": "Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`", "type": "boolean" }, +"syntheticContentAttestationStatus": { +"description": "Optional. Whether the creative contains synthetic content or was created using AI.", +"enum": [ +"SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED", +"NOT_SYNTHETIC", +"IS_SYNTHETIC" +], +"enumDescriptions": [ +"Attestation status is unspecified.", +"Not synthetic content.", +"Is synthetic content." +], +"type": "string" +}, "thirdPartyTag": { "description": "Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`", "type": "string" @@ -14466,7 +14489,7 @@ false "id": "DemandGenCarouselAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", +"description": "Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "cards": { @@ -14501,7 +14524,7 @@ false }, "logo": { "$ref": "ImageAsset", -"description": "Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied." +"description": "Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied." }, "trackingUrl": { "description": "Output only. The URL address loaded in the background for tracking purposes.", @@ -14520,7 +14543,7 @@ false "id": "DemandGenImageAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", +"description": "Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "callToAction": { @@ -14561,7 +14584,7 @@ false "type": "array" }, "logoImages": { -"description": "The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", +"description": "The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied.", "items": { "$ref": "ImageAsset" }, @@ -14605,7 +14628,7 @@ false "id": "DemandGenProductAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", +"description": "Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "callToAction": { @@ -14687,7 +14710,7 @@ false }, "logo": { "$ref": "ImageAsset", -"description": "Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied." +"description": "Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied." }, "trackingUrl": { "description": "Output only. The URL address loaded in the background for tracking purposes.", @@ -14726,7 +14749,7 @@ false "id": "DemandGenVideoAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", +"description": "Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "callToAction": { @@ -14822,7 +14845,7 @@ false }, "logo": { "$ref": "ImageAsset", -"description": "Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied." +"description": "Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied." }, "longHeadlines": { "description": "Required. The list of long headlines shown on the ad.", @@ -21552,7 +21575,7 @@ false "id": "ThirdPartyMeasurementConfigs", "properties": { "brandLiftVendorConfigs": { -"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`.", +"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL`", "items": { "$ref": "ThirdPartyVendorConfig" }, diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v4.json b/googleapiclient/discovery_cache/documents/displayvideo.v4.json index 7bad212e65..36cf055b3c 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v4.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v4.json @@ -516,6 +516,50 @@ "https://www.googleapis.com/auth/display-video" ] }, +"patch": { +"description": "Updates an ad asset. Returns the updated ad asset if successful. Supports updating assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO` and `AD_ASSET_TYPE_IMAGE`. Only the `synthetic_content_attestation_status` field is mutable.", +"flatPath": "v4/advertisers/{advertisersId}/adAssets/{adAssetsId}", +"httpMethod": "PATCH", +"id": "displayvideo.advertisers.adAssets.patch", +"parameterOrder": [ +"advertiserId", +"adAssetId" +], +"parameters": { +"adAssetId": { +"description": "Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Required. The ID of the advertiser this ad asset belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The list of fields to update. Only AdAsset.synthetic_content_attestation_status is mutable.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adAssets/{+adAssetId}", +"request": { +"$ref": "AdAsset" +}, +"response": { +"$ref": "AdAsset" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, "upload": { "description": "Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`.", "flatPath": "v4/advertisers/{advertisersId}/adAssets:uploadAdAsset", @@ -9574,7 +9618,7 @@ } } }, -"revision": "20260708", +"revision": "20260720", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9741,6 +9785,20 @@ "description": "Identifier. The resource name of the ad asset.", "type": "string" }, +"syntheticContentAttestationStatus": { +"description": "Optional. Whether the asset contains synthetic content or was created using AI.", +"enum": [ +"SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED", +"NOT_SYNTHETIC", +"IS_SYNTHETIC" +], +"enumDescriptions": [ +"Attestation status is unspecified.", +"Not synthetic content.", +"Is synthetic content." +], +"type": "string" +}, "youtubeVideoAsset": { "$ref": "YoutubeVideoAsset", "description": "Youtube video asset data." @@ -11126,6 +11184,15 @@ "$ref": "AdvertiserDataAccessConfig", "description": "Settings that control how advertiser data may be accessed." }, +"defaultBusinessName": { +"description": "Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided.", +"type": "string" +}, +"defaultLogoAssetId": { +"description": "Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API.", +"format": "int64", +"type": "string" +}, "displayName": { "description": "Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.", "type": "string" @@ -15270,6 +15337,20 @@ false "description": "Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`", "type": "boolean" }, +"syntheticContentAttestationStatus": { +"description": "Optional. Whether the creative contains synthetic content or was created using AI.", +"enum": [ +"SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED", +"NOT_SYNTHETIC", +"IS_SYNTHETIC" +], +"enumDescriptions": [ +"Attestation status is unspecified.", +"Not synthetic content.", +"Is synthetic content." +], +"type": "string" +}, "thirdPartyTag": { "description": "Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`", "type": "string" @@ -16121,7 +16202,7 @@ false "id": "DemandGenCarouselAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", +"description": "Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "cards": { @@ -16156,7 +16237,7 @@ false }, "logo": { "$ref": "ImageAsset", -"description": "Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied." +"description": "Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied." }, "trackingUrl": { "description": "Output only. The URL address loaded in the background for tracking purposes.", @@ -16175,7 +16256,7 @@ false "id": "DemandGenImageAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", +"description": "Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "callToAction": { @@ -16216,7 +16297,7 @@ false "type": "array" }, "logoImages": { -"description": "The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", +"description": "The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied.", "items": { "$ref": "ImageAsset" }, @@ -16260,7 +16341,7 @@ false "id": "DemandGenProductAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", +"description": "Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "callToAction": { @@ -16342,7 +16423,7 @@ false }, "logo": { "$ref": "ImageAsset", -"description": "Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied." +"description": "Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied." }, "trackingUrl": { "description": "Output only. The URL address loaded in the background for tracking purposes.", @@ -16381,7 +16462,7 @@ false "id": "DemandGenVideoAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", +"description": "Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "callToAction": { @@ -16477,7 +16558,7 @@ false }, "logo": { "$ref": "ImageAsset", -"description": "Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied." +"description": "Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied." }, "longHeadlines": { "description": "Required. The list of long headlines shown on the ad.", @@ -23117,8 +23198,9 @@ false "readOnly": true, "type": "array" }, -"network": { -"description": "Output only. Targetable network for the ad product.", +"networks": { +"description": "Output only. Targetable networks for the ad product.", +"items": { "enum": [ "PLANNABLE_NETWORK_UNSPECIFIED", "PLANNABLE_NETWORK_YOUTUBE", @@ -23131,9 +23213,11 @@ false "Google Video Partners.", "YouTube and Google Video Partners." ], -"readOnly": true, "type": "string" }, +"readOnly": true, +"type": "array" +}, "surfaceTargetingCombinations": { "$ref": "SurfaceTargetingCombinations", "description": "Output only. Targetable surface combinations for the ad product.", @@ -23248,6 +23332,16 @@ false "description": "Performance metrics for a forecast point.", "id": "PlannedProductForecast", "properties": { +"onTargetCoviewImpressions": { +"description": "Number of on-target impressions including co-viewers.", +"format": "int64", +"type": "string" +}, +"onTargetCoviewReach": { +"description": "Number of unique people reached that match the on-target definition including co-viewers.", +"format": "int64", +"type": "string" +}, "onTargetImpressions": { "description": "Number of on-target impressions.", "format": "int64", @@ -23258,6 +23352,16 @@ false "format": "int64", "type": "string" }, +"totalCoviewImpressions": { +"description": "Total number of impressions including co-viewers.", +"format": "int64", +"type": "string" +}, +"totalCoviewReach": { +"description": "Total number of unique people reached including co-viewers.", +"format": "int64", +"type": "string" +}, "totalImpressions": { "description": "Total number of impressions.", "format": "int64", @@ -24992,7 +25096,7 @@ false "id": "ThirdPartyMeasurementConfigs", "properties": { "brandLiftVendorConfigs": { -"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`.", +"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL`", "items": { "$ref": "ThirdPartyVendorConfig" }, @@ -25318,6 +25422,20 @@ false "filename": { "description": "Required. The filename of the ad asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes.", "type": "string" +}, +"syntheticContentAttestationStatus": { +"description": "Optional. Whether the asset contains synthetic content or was created using AI.", +"enum": [ +"SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED", +"NOT_SYNTHETIC", +"IS_SYNTHETIC" +], +"enumDescriptions": [ +"Attestation status is unspecified.", +"Not synthetic content.", +"Is synthetic content." +], +"type": "string" } }, "type": "object" From 588aee3ec03e2c908673c2653e89d47496d9e9d8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:04 +0000 Subject: [PATCH 46/84] feat(dlp): update the api #### dlp:v2 The following keys were added: - schemas.GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails.properties.categoricalStatsResult.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails.properties.deltaPresenceEstimationResult.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails.properties.kAnonymityResult.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails.properties.kMapEstimationResult.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails.properties.lDiversityResult.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails.properties.numericalStatsResult.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2DiscoveryConfig.properties.name.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2DlpJob.properties.actionDetails.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2InfoTypeCondition.properties.minCount (Total Keys: 2) - schemas.GooglePrivacyDlpV2InspectDataSourceDetails.properties.result.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2JobTrigger.properties.name.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2RequestedOptions.properties.snapshotInspectTemplate.readOnly (Total Keys: 1) --- docs/dyn/dlp_v2.infoTypes.html | 4 +- docs/dyn/dlp_v2.locations.infoTypes.html | 4 +- ..._v2.organizations.deidentifyTemplates.html | 540 +++---- ...dlp_v2.organizations.inspectTemplates.html | 300 ++-- ...izations.locations.columnDataProfiles.html | 12 +- ...2.organizations.locations.connections.html | 14 +- ...zations.locations.deidentifyTemplates.html | 540 +++---- ...anizations.locations.discoveryConfigs.html | 132 +- ...lp_v2.organizations.locations.dlpJobs.html | 408 ++--- ...tions.locations.fileStoreDataProfiles.html | 172 +-- ..._v2.organizations.locations.infoTypes.html | 4 +- ...anizations.locations.inspectTemplates.html | 300 ++-- ...2.organizations.locations.jobTriggers.html | 420 +++--- ...ganizations.locations.storedInfoTypes.html | 84 +- ...nizations.locations.tableDataProfiles.html | 172 +-- .../dlp_v2.organizations.storedInfoTypes.html | 84 +- docs/dyn/dlp_v2.projects.content.html | 494 +++---- .../dlp_v2.projects.deidentifyTemplates.html | 540 +++---- docs/dyn/dlp_v2.projects.dlpJobs.html | 1306 ++++++++-------- docs/dyn/dlp_v2.projects.image.html | 54 +- .../dyn/dlp_v2.projects.inspectTemplates.html | 300 ++-- docs/dyn/dlp_v2.projects.jobTriggers.html | 822 +++++------ ...projects.locations.columnDataProfiles.html | 12 +- ...dlp_v2.projects.locations.connections.html | 14 +- .../dlp_v2.projects.locations.content.html | 494 +++---- ...v2.projects.locations.contentPolicies.html | 546 +++---- ...rojects.locations.deidentifyTemplates.html | 540 +++---- ...2.projects.locations.discoveryConfigs.html | 132 +- .../dlp_v2.projects.locations.dlpJobs.html | 1308 ++++++++--------- ...jects.locations.fileStoreDataProfiles.html | 172 +-- docs/dyn/dlp_v2.projects.locations.image.html | 54 +- .../dlp_v2.projects.locations.infoTypes.html | 4 +- ...2.projects.locations.inspectTemplates.html | 300 ++-- ...dlp_v2.projects.locations.jobTriggers.html | 824 +++++------ ...v2.projects.locations.storedInfoTypes.html | 84 +- ....projects.locations.tableDataProfiles.html | 172 +-- docs/dyn/dlp_v2.projects.storedInfoTypes.html | 84 +- .../discovery_cache/documents/dlp.v2.json | 436 +++--- 38 files changed, 5952 insertions(+), 5930 deletions(-) diff --git a/docs/dyn/dlp_v2.infoTypes.html b/docs/dyn/dlp_v2.infoTypes.html index 74666879c8..4fbefd513a 100644 --- a/docs/dyn/dlp_v2.infoTypes.html +++ b/docs/dyn/dlp_v2.infoTypes.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

list(filter=None, languageCode=None, locationId=None, parent=None, x__xgafv=None)

-

Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.

+

Returns a list of the sensitive information types that the DLP API supports. See https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.

Method Details

close() @@ -88,7 +88,7 @@

Method Details

list(filter=None, languageCode=None, locationId=None, parent=None, x__xgafv=None) -
Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.
+  
Returns a list of the sensitive information types that the DLP API supports. See https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.
 
 Args:
   filter: string, filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.
diff --git a/docs/dyn/dlp_v2.locations.infoTypes.html b/docs/dyn/dlp_v2.locations.infoTypes.html
index 97002c893c..68b208adf0 100644
--- a/docs/dyn/dlp_v2.locations.infoTypes.html
+++ b/docs/dyn/dlp_v2.locations.infoTypes.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

list(parent, filter=None, languageCode=None, locationId=None, x__xgafv=None)

-

Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.

+

Returns a list of the sensitive information types that the DLP API supports. See https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.

Method Details

close() @@ -88,7 +88,7 @@

Method Details

list(parent, filter=None, languageCode=None, locationId=None, x__xgafv=None) -
Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.
+  
Returns a list of the sensitive information types that the DLP API supports. See https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.
 
 Args:
   parent: string, The parent resource name. The format of this value is as follows: `locations/{location_id}` (required)
diff --git a/docs/dyn/dlp_v2.organizations.deidentifyTemplates.html b/docs/dyn/dlp_v2.organizations.deidentifyTemplates.html
index e235c3ee89..567c4ad4e0 100644
--- a/docs/dyn/dlp_v2.organizations.deidentifyTemplates.html
+++ b/docs/dyn/dlp_v2.organizations.deidentifyTemplates.html
@@ -79,22 +79,22 @@ 

Instance Methods

Close httplib2 connections.

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

-

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

delete(name, x__xgafv=None)

-

Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Deletes a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

get(name, x__xgafv=None)

-

Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Gets a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Lists DeidentifyTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Updates the DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

Method Details

close() @@ -103,15 +103,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateDeidentifyTemplate.
-  "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The DeidentifyTemplate to create.
+  "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The DeidentifyTemplate to create.
     "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
     "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template.
       "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact.
@@ -129,7 +129,7 @@ 

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -145,7 +145,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -153,7 +153,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -232,7 +232,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -244,16 +244,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -265,13 +265,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -284,20 +284,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -311,7 +311,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -376,7 +376,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -438,7 +438,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -446,7 +446,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -525,7 +525,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -537,16 +537,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -558,13 +558,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -577,20 +577,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -604,7 +604,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -669,7 +669,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -685,7 +685,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -764,7 +764,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -776,16 +776,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -797,13 +797,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -816,20 +816,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -843,7 +843,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -908,7 +908,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -985,7 +985,7 @@

Method Details

Returns: An object of the form: - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1003,7 +1003,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1019,7 +1019,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1027,7 +1027,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1106,7 +1106,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1118,16 +1118,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1139,13 +1139,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1158,20 +1158,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1185,7 +1185,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1250,7 +1250,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1312,7 +1312,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1320,7 +1320,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1399,7 +1399,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1411,16 +1411,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1432,13 +1432,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1451,20 +1451,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1478,7 +1478,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1543,7 +1543,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1559,7 +1559,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1638,7 +1638,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1650,16 +1650,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1671,13 +1671,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1690,20 +1690,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1717,7 +1717,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1782,7 +1782,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1851,7 +1851,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Deletes a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. (required)
@@ -1869,7 +1869,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Gets a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. (required)
@@ -1881,7 +1881,7 @@ 

Method Details

Returns: An object of the form: - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1899,7 +1899,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1915,7 +1915,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1923,7 +1923,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2002,7 +2002,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2014,16 +2014,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2035,13 +2035,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2054,20 +2054,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2081,7 +2081,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2146,7 +2146,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2208,7 +2208,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2216,7 +2216,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2295,7 +2295,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2307,16 +2307,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2328,13 +2328,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2347,20 +2347,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2374,7 +2374,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2439,7 +2439,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2455,7 +2455,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2534,7 +2534,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2546,16 +2546,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2567,13 +2567,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2586,20 +2586,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2613,7 +2613,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2678,7 +2678,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2747,10 +2747,10 @@

Method Details

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Lists DeidentifyTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -2765,7 +2765,7 @@ 

Method Details

{ # Response message for ListDeidentifyTemplates. "deidentifyTemplates": [ # List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest. - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -2783,7 +2783,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -2799,7 +2799,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2807,7 +2807,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2886,7 +2886,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2898,16 +2898,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2919,13 +2919,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2938,20 +2938,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2965,7 +2965,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3030,7 +3030,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3092,7 +3092,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3100,7 +3100,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3179,7 +3179,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3191,16 +3191,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3212,13 +3212,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3231,20 +3231,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3258,7 +3258,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3323,7 +3323,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3339,7 +3339,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3418,7 +3418,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3430,16 +3430,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3451,13 +3451,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3470,20 +3470,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3497,7 +3497,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3562,7 +3562,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3648,7 +3648,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Updates the DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
   name: string, Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. (required)
@@ -3656,7 +3656,7 @@ 

Method Details

The object takes the form of: { # Request message for UpdateDeidentifyTemplate. - "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New DeidentifyTemplate value. + "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New DeidentifyTemplate value. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -3674,7 +3674,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -3690,7 +3690,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3698,7 +3698,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3777,7 +3777,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3789,16 +3789,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3810,13 +3810,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3829,20 +3829,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3856,7 +3856,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3921,7 +3921,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3983,7 +3983,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3991,7 +3991,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4070,7 +4070,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4082,16 +4082,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4103,13 +4103,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4122,20 +4122,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4149,7 +4149,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4214,7 +4214,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4230,7 +4230,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4309,7 +4309,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4321,16 +4321,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4342,13 +4342,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4361,20 +4361,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4388,7 +4388,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4453,7 +4453,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4529,7 +4529,7 @@

Method Details

Returns: An object of the form: - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -4547,7 +4547,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -4563,7 +4563,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4571,7 +4571,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4650,7 +4650,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4662,16 +4662,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4683,13 +4683,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4702,20 +4702,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4729,7 +4729,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4794,7 +4794,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4856,7 +4856,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4864,7 +4864,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4943,7 +4943,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4955,16 +4955,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4976,13 +4976,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4995,20 +4995,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5022,7 +5022,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5087,7 +5087,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -5103,7 +5103,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -5182,7 +5182,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5194,16 +5194,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5215,13 +5215,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5234,20 +5234,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5261,7 +5261,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5326,7 +5326,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], diff --git a/docs/dyn/dlp_v2.organizations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.inspectTemplates.html index 0fc80ca003..420fa61357 100644 --- a/docs/dyn/dlp_v2.organizations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.organizations.inspectTemplates.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

delete(name, x__xgafv=None)

-

Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Deletes an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

get(name, x__xgafv=None)

-

Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Updates the InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

Method Details

close() @@ -103,15 +103,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateInspectTemplate.
-  "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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The InspectTemplate to create.
+  "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. # Required. The InspectTemplate to create.
     "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).
@@ -120,7 +120,7 @@ 

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -135,14 +135,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -168,7 +168,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -192,15 +192,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -211,7 +211,7 @@

Method Details

"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://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}`. + "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. }, @@ -223,11 +223,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -240,7 +240,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -259,9 +259,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -273,7 +273,7 @@

Method Details

"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://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}`. + "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. }, @@ -289,7 +289,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -308,7 +308,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -320,9 +320,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -333,7 +333,7 @@

Method Details

"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://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}`. + "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. }, @@ -360,9 +360,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -385,7 +385,7 @@

Method Details

Returns: An object of the form: - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -394,7 +394,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -409,14 +409,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -442,7 +442,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -466,15 +466,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -485,7 +485,7 @@

Method Details

"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://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}`. + "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. }, @@ -497,11 +497,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -514,7 +514,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -533,9 +533,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -547,7 +547,7 @@

Method Details

"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://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}`. + "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. }, @@ -563,7 +563,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -582,7 +582,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -594,9 +594,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -607,7 +607,7 @@

Method Details

"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://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}`. + "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. }, @@ -634,9 +634,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -651,7 +651,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Deletes an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. (required)
@@ -669,7 +669,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. (required)
@@ -681,7 +681,7 @@ 

Method Details

Returns: An object of the form: - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -690,7 +690,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -705,14 +705,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -738,7 +738,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -762,15 +762,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -781,7 +781,7 @@

Method Details

"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://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}`. + "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. }, @@ -793,11 +793,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -810,7 +810,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -829,9 +829,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -843,7 +843,7 @@

Method Details

"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://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}`. + "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. }, @@ -859,7 +859,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -878,7 +878,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -890,9 +890,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -903,7 +903,7 @@

Method Details

"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://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}`. + "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. }, @@ -930,9 +930,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -947,10 +947,10 @@

Method Details

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -965,7 +965,7 @@ 

Method Details

{ # Response message for ListInspectTemplates. "inspectTemplates": [ # List of inspectTemplates, up to page_size in ListInspectTemplatesRequest. - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -974,7 +974,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -989,14 +989,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1022,7 +1022,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1046,15 +1046,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1065,7 +1065,7 @@

Method Details

"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://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}`. + "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. }, @@ -1077,11 +1077,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1094,7 +1094,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1113,9 +1113,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1127,7 +1127,7 @@

Method Details

"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://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}`. + "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. }, @@ -1143,7 +1143,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1162,7 +1162,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1174,9 +1174,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1187,7 +1187,7 @@

Method Details

"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://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}`. + "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. }, @@ -1214,9 +1214,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1248,7 +1248,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Updates the InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
   name: string, Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. (required)
@@ -1256,7 +1256,7 @@ 

Method Details

The object takes the form of: { # Request message for UpdateInspectTemplate. - "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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New InspectTemplate value. + "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. # New InspectTemplate value. "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). @@ -1265,7 +1265,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1280,14 +1280,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1313,7 +1313,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1337,15 +1337,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1356,7 +1356,7 @@

Method Details

"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://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}`. + "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. }, @@ -1368,11 +1368,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1385,7 +1385,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1404,9 +1404,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1418,7 +1418,7 @@

Method Details

"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://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}`. + "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. }, @@ -1434,7 +1434,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1453,7 +1453,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1465,9 +1465,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1478,7 +1478,7 @@

Method Details

"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://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}`. + "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. }, @@ -1505,9 +1505,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1529,7 +1529,7 @@

Method Details

Returns: An object of the form: - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -1538,7 +1538,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1553,14 +1553,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1586,7 +1586,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1610,15 +1610,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1629,7 +1629,7 @@

Method Details

"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://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}`. + "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. }, @@ -1641,11 +1641,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1658,7 +1658,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1677,9 +1677,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1691,7 +1691,7 @@

Method Details

"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://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}`. + "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. }, @@ -1707,7 +1707,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1726,7 +1726,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1738,9 +1738,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1751,7 +1751,7 @@

Method Details

"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://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}`. + "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. }, @@ -1778,9 +1778,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, diff --git a/docs/dyn/dlp_v2.organizations.locations.columnDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.columnDataProfiles.html index 65d3065179..0a8418a6d8 100644 --- a/docs/dyn/dlp_v2.organizations.locations.columnDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.columnDataProfiles.html @@ -111,7 +111,7 @@

Method Details

"columnInfoType": { # The infoType details for this column. # If it's been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types. "estimatedPrevalence": 42, # Not populated for predicted infotypes. "infoType": { # Type of information detected by the API. # The infoType. - "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://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}`. + "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. }, @@ -123,7 +123,7 @@

Method Details

"score": "A String", # The score applied to the resource. }, "datasetId": "A String", # The BigQuery dataset ID, if the resource profiled is a BigQuery table. - "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations. + "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://docs.cloud.google.com/bigquery/docs/locations for supported BigQuery locations. "datasetProjectId": "A String", # The Google Cloud project ID that owns the profiled resource. "estimatedNullPercentage": "A String", # Approximate percentage of entries being null in the column. "estimatedUniquenessScore": "A String", # Approximate uniqueness of the column. @@ -134,7 +134,7 @@

Method Details

"estimatedPrevalence": 42, # Approximate percentage of non-null rows that contained data detected by this infotype. "excludedFromAnalysis": True or False, # Whether this infoType was excluded from sensitivity and risk analysis due to factors such as low prevalence (subject to change). "infoType": { # Type of information detected by the API. # The other infoType. - "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://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}`. + "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. }, @@ -191,7 +191,7 @@

Method Details

"columnInfoType": { # The infoType details for this column. # If it's been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types. "estimatedPrevalence": 42, # Not populated for predicted infotypes. "infoType": { # Type of information detected by the API. # The infoType. - "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://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}`. + "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. }, @@ -203,7 +203,7 @@

Method Details

"score": "A String", # The score applied to the resource. }, "datasetId": "A String", # The BigQuery dataset ID, if the resource profiled is a BigQuery table. - "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations. + "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://docs.cloud.google.com/bigquery/docs/locations for supported BigQuery locations. "datasetProjectId": "A String", # The Google Cloud project ID that owns the profiled resource. "estimatedNullPercentage": "A String", # Approximate percentage of entries being null in the column. "estimatedUniquenessScore": "A String", # Approximate uniqueness of the column. @@ -214,7 +214,7 @@

Method Details

"estimatedPrevalence": 42, # Approximate percentage of non-null rows that contained data detected by this infotype. "excludedFromAnalysis": True or False, # Whether this infoType was excluded from sensitivity and risk analysis due to factors such as low prevalence (subject to change). "infoType": { # Type of information detected by the API. # The other infoType. - "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://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}`. + "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. }, diff --git a/docs/dyn/dlp_v2.organizations.locations.connections.html b/docs/dyn/dlp_v2.organizations.locations.connections.html index d99de8a1cf..ae91052999 100644 --- a/docs/dyn/dlp_v2.organizations.locations.connections.html +++ b/docs/dyn/dlp_v2.organizations.locations.connections.html @@ -119,7 +119,7 @@

Method Details

{ # Request message for CreateConnection. "connection": { # A data connection to allow the DLP API to profile data in locations that require additional configuration. # Required. The connection resource. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. @@ -161,7 +161,7 @@

Method Details

{ # A data connection to allow the DLP API to profile data in locations that require additional configuration. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. @@ -227,7 +227,7 @@

Method Details

{ # A data connection to allow the DLP API to profile data in locations that require additional configuration. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. @@ -280,7 +280,7 @@

Method Details

"connections": [ # List of connections. { # A data connection to allow the DLP API to profile data in locations that require additional configuration. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. @@ -341,7 +341,7 @@

Method Details

{ # Request message for UpdateConnection. "connection": { # A data connection to allow the DLP API to profile data in locations that require additional configuration. # Required. The connection with new values for the relevant fields. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. @@ -384,7 +384,7 @@

Method Details

{ # A data connection to allow the DLP API to profile data in locations that require additional configuration. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. @@ -437,7 +437,7 @@

Method Details

"connections": [ # List of connections that match the search query. Note that only a subset of the fields will be populated, and only "name" is guaranteed to be set. For full details of a Connection, call GetConnection with the name. { # A data connection to allow the DLP API to profile data in locations that require additional configuration. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. diff --git a/docs/dyn/dlp_v2.organizations.locations.deidentifyTemplates.html b/docs/dyn/dlp_v2.organizations.locations.deidentifyTemplates.html index 904a2f611f..e218fbe92c 100644 --- a/docs/dyn/dlp_v2.organizations.locations.deidentifyTemplates.html +++ b/docs/dyn/dlp_v2.organizations.locations.deidentifyTemplates.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

delete(name, x__xgafv=None)

-

Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Deletes a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

get(name, x__xgafv=None)

-

Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Gets a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Lists DeidentifyTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Updates the DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

Method Details

close() @@ -103,15 +103,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateDeidentifyTemplate.
-  "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The DeidentifyTemplate to create.
+  "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The DeidentifyTemplate to create.
     "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
     "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template.
       "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact.
@@ -129,7 +129,7 @@ 

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -145,7 +145,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -153,7 +153,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -232,7 +232,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -244,16 +244,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -265,13 +265,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -284,20 +284,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -311,7 +311,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -376,7 +376,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -438,7 +438,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -446,7 +446,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -525,7 +525,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -537,16 +537,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -558,13 +558,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -577,20 +577,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -604,7 +604,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -669,7 +669,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -685,7 +685,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -764,7 +764,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -776,16 +776,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -797,13 +797,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -816,20 +816,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -843,7 +843,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -908,7 +908,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -985,7 +985,7 @@

Method Details

Returns: An object of the form: - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1003,7 +1003,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1019,7 +1019,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1027,7 +1027,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1106,7 +1106,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1118,16 +1118,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1139,13 +1139,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1158,20 +1158,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1185,7 +1185,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1250,7 +1250,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1312,7 +1312,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1320,7 +1320,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1399,7 +1399,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1411,16 +1411,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1432,13 +1432,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1451,20 +1451,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1478,7 +1478,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1543,7 +1543,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1559,7 +1559,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1638,7 +1638,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1650,16 +1650,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1671,13 +1671,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1690,20 +1690,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1717,7 +1717,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1782,7 +1782,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1851,7 +1851,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Deletes a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. (required)
@@ -1869,7 +1869,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Gets a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. (required)
@@ -1881,7 +1881,7 @@ 

Method Details

Returns: An object of the form: - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1899,7 +1899,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1915,7 +1915,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1923,7 +1923,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2002,7 +2002,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2014,16 +2014,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2035,13 +2035,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2054,20 +2054,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2081,7 +2081,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2146,7 +2146,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2208,7 +2208,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2216,7 +2216,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2295,7 +2295,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2307,16 +2307,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2328,13 +2328,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2347,20 +2347,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2374,7 +2374,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2439,7 +2439,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2455,7 +2455,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2534,7 +2534,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2546,16 +2546,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2567,13 +2567,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2586,20 +2586,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2613,7 +2613,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2678,7 +2678,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2747,10 +2747,10 @@

Method Details

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Lists DeidentifyTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -2765,7 +2765,7 @@ 

Method Details

{ # Response message for ListDeidentifyTemplates. "deidentifyTemplates": [ # List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest. - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -2783,7 +2783,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -2799,7 +2799,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2807,7 +2807,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2886,7 +2886,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2898,16 +2898,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2919,13 +2919,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2938,20 +2938,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2965,7 +2965,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3030,7 +3030,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3092,7 +3092,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3100,7 +3100,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3179,7 +3179,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3191,16 +3191,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3212,13 +3212,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3231,20 +3231,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3258,7 +3258,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3323,7 +3323,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3339,7 +3339,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3418,7 +3418,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3430,16 +3430,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3451,13 +3451,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3470,20 +3470,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3497,7 +3497,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3562,7 +3562,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3648,7 +3648,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Updates the DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
   name: string, Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. (required)
@@ -3656,7 +3656,7 @@ 

Method Details

The object takes the form of: { # Request message for UpdateDeidentifyTemplate. - "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New DeidentifyTemplate value. + "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New DeidentifyTemplate value. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -3674,7 +3674,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -3690,7 +3690,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3698,7 +3698,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3777,7 +3777,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3789,16 +3789,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3810,13 +3810,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3829,20 +3829,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3856,7 +3856,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3921,7 +3921,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3983,7 +3983,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3991,7 +3991,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4070,7 +4070,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4082,16 +4082,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4103,13 +4103,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4122,20 +4122,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4149,7 +4149,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4214,7 +4214,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4230,7 +4230,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4309,7 +4309,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4321,16 +4321,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4342,13 +4342,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4361,20 +4361,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4388,7 +4388,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4453,7 +4453,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4529,7 +4529,7 @@

Method Details

Returns: An object of the form: - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -4547,7 +4547,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -4563,7 +4563,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4571,7 +4571,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4650,7 +4650,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4662,16 +4662,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4683,13 +4683,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4702,20 +4702,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4729,7 +4729,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4794,7 +4794,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4856,7 +4856,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4864,7 +4864,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4943,7 +4943,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4955,16 +4955,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4976,13 +4976,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4995,20 +4995,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5022,7 +5022,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5087,7 +5087,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -5103,7 +5103,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -5182,7 +5182,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5194,16 +5194,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5215,13 +5215,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5234,20 +5234,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5261,7 +5261,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5326,7 +5326,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html index 5b780c2d93..394d6dc2a9 100644 --- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html @@ -112,11 +112,11 @@

Method Details

{ # Request message for CreateDiscoveryConfig. "configId": "A String", # The config ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. - "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # Required. The DiscoveryConfig to create. + "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # Required. The DiscoveryConfig to create. "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -143,15 +143,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -187,11 +187,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -354,7 +354,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -373,7 +373,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -423,7 +423,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -469,11 +469,11 @@

Method Details

Returns: An object of the form: - { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -500,15 +500,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -544,11 +544,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -711,7 +711,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -730,7 +730,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -780,7 +780,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -850,11 +850,11 @@

Method Details

Returns: An object of the form: - { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -881,15 +881,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -925,11 +925,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -1092,7 +1092,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -1111,7 +1111,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -1161,7 +1161,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -1218,11 +1218,11 @@

Method Details

{ # Response message for ListDiscoveryConfigs. "discoveryConfigs": [ # List of configs, up to page_size in ListDiscoveryConfigsRequest. - { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -1249,15 +1249,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -1293,11 +1293,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -1460,7 +1460,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -1479,7 +1479,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -1529,7 +1529,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -1594,11 +1594,11 @@

Method Details

The object takes the form of: { # Request message for UpdateDiscoveryConfig. - "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # Required. New DiscoveryConfig value. + "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # Required. New DiscoveryConfig value. "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -1625,15 +1625,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -1669,11 +1669,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -1836,7 +1836,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -1855,7 +1855,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -1905,7 +1905,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -1952,11 +1952,11 @@

Method Details

Returns: An object of the form: - { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -1983,15 +1983,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -2027,11 +2027,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -2194,7 +2194,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -2213,7 +2213,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -2263,7 +2263,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html index f86e329828..91d03f3d99 100644 --- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

+

Lists DlpJobs that match the specified filter in the request. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

list_next()

Retrieves the next page of results.

@@ -91,10 +91,10 @@

Method Details

list(parent, filter=None, locationId=None, orderBy=None, pageSize=None, pageToken=None, type=None, x__xgafv=None) -
Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
+  
Lists DlpJobs that match the specified filter in the request. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`
@@ -116,7 +116,7 @@ 

Method Details

{ # The response message for listing DLP jobs. "jobs": [ # A list of DlpJobs that matches the specified filter in the request. { # Combines all of the information about a DLP job. - "actionDetails": [ # Events that should occur after the job has completed. + "actionDetails": [ # Output only. Events that should occur after the job has completed. { # The results of an Action. "deidentifyDetails": { # The results of a Deidentify action from an inspect job. # Outcome of a de-identification action. "deidentifyStats": { # Summary of what was modified during a transformation. # Stats about the de-identification operation. @@ -125,7 +125,7 @@

Method Details

"transformedBytes": "A String", # Total size in bytes that were transformed in some way. }, "requestedOptions": { # De-identification options. # De-identification config used for the request. - "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. + "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -143,7 +143,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -159,7 +159,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -167,7 +167,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -246,7 +246,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -258,16 +258,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -279,13 +279,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -298,20 +298,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -325,7 +325,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -390,7 +390,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -452,7 +452,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -460,7 +460,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -539,7 +539,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -551,16 +551,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -572,13 +572,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -591,20 +591,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -618,7 +618,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -683,7 +683,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -699,7 +699,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -778,7 +778,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -790,16 +790,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -811,13 +811,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -830,20 +830,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -857,7 +857,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -922,7 +922,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -987,7 +987,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1005,7 +1005,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1021,7 +1021,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1029,7 +1029,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1108,7 +1108,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1120,16 +1120,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1141,13 +1141,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1160,20 +1160,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1187,7 +1187,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1252,7 +1252,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1314,7 +1314,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1322,7 +1322,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1401,7 +1401,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1413,16 +1413,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1434,13 +1434,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1453,20 +1453,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1480,7 +1480,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1545,7 +1545,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1561,7 +1561,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1640,7 +1640,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1652,16 +1652,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1673,13 +1673,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1692,20 +1692,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1719,7 +1719,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1784,7 +1784,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1849,7 +1849,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1867,7 +1867,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1883,7 +1883,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1891,7 +1891,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1970,7 +1970,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1982,16 +1982,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2003,13 +2003,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2022,20 +2022,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2049,7 +2049,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2114,7 +2114,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2176,7 +2176,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2184,7 +2184,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2263,7 +2263,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2275,16 +2275,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2296,13 +2296,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2315,20 +2315,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2342,7 +2342,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2407,7 +2407,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2423,7 +2423,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2502,7 +2502,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2514,16 +2514,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2535,13 +2535,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2554,20 +2554,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2581,7 +2581,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2646,7 +2646,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2738,7 +2738,7 @@

Method Details

"requestedOptions": { # Snapshot of the inspection configuration. # The configuration used for this job. "jobConfig": { # Controls what and how to inspect for findings. # Inspect config. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -2757,14 +2757,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -2789,7 +2789,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -2804,14 +2804,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -2837,7 +2837,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -2861,15 +2861,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -2880,7 +2880,7 @@

Method Details

"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://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}`. + "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. }, @@ -2892,11 +2892,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -2909,7 +2909,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -2928,9 +2928,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2942,7 +2942,7 @@

Method Details

"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://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}`. + "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. }, @@ -2958,7 +2958,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -2977,7 +2977,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -2989,9 +2989,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3002,7 +3002,7 @@

Method Details

"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://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}`. + "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. }, @@ -3029,9 +3029,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3058,7 +3058,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -3067,8 +3067,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -3113,16 +3113,16 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, - "snapshotInspectTemplate": { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. + "snapshotInspectTemplate": { # 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. # Output only. If run with an InspectTemplate, a snapshot of its state at the time of this run. "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). @@ -3131,7 +3131,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -3146,14 +3146,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -3179,7 +3179,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -3203,15 +3203,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -3222,7 +3222,7 @@

Method Details

"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://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}`. + "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. }, @@ -3234,11 +3234,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -3251,7 +3251,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -3270,9 +3270,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3284,7 +3284,7 @@

Method Details

"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://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}`. + "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. }, @@ -3300,7 +3300,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -3319,7 +3319,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -3331,9 +3331,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3344,7 +3344,7 @@

Method Details

"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://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}`. + "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. }, @@ -3371,9 +3371,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3385,7 +3385,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, }, - "result": { # All Result fields are updated while the job is processing. # A summary of the outcome of this inspection job. + "result": { # All Result fields are updated while the job is processing. # Output only. A summary of the outcome of this inspection job. "hybridStats": { # Statistics related to processing hybrid inspect requests. # Statistics related to the processing of hybrid inspect. "abortedCount": "A String", # The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed. "pendingCount": "A String", # The number of hybrid requests currently being processed. Only populated when called via method `getDlpJob`. A burst of traffic may cause hybrid inspect requests to be enqueued. Processing will take place as quickly as possible, but resource limitations may impact how long a request is enqueued for. @@ -3395,7 +3395,7 @@

Method Details

{ # Statistics regarding a specific InfoType. "count": "A String", # Number of findings for this infoType. "infoType": { # Type of information detected by the API. # The type of finding this stat is for. - "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://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}`. + "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. }, @@ -3412,7 +3412,7 @@

Method Details

"lastModified": "A String", # Output only. Time when the job was last modified by the system. "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. - "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result + "categoricalStatsResult": { # Result of the categorical stats computation. # Output only. Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. { # Histogram of value frequencies in the column. "bucketSize": "A String", # Total number of values in this bucket. @@ -3446,7 +3446,7 @@

Method Details

}, ], }, - "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Delta-presence result + "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Output only. Delta-presence result "deltaPresenceEstimationHistogram": [ # The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. { # A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset. "bucketSize": "A String", # Number of records within these probability bounds. @@ -3482,7 +3482,7 @@

Method Details

}, ], }, - "kAnonymityResult": { # Result of the k-anonymity computation. # K-anonymity result + "kAnonymityResult": { # Result of the k-anonymity computation. # Output only. K-anonymity result "equivalenceClassHistogramBuckets": [ # Histogram of k-anonymity equivalence classes. { # Histogram of k-anonymity equivalence classes. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -3518,7 +3518,7 @@

Method Details

}, ], }, - "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # K-map result + "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # Output only. K-map result "kMapEstimationHistogram": [ # The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10. { # A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records. "bucketSize": "A String", # Number of records within these anonymity bounds. @@ -3554,7 +3554,7 @@

Method Details

}, ], }, - "lDiversityResult": { # Result of the l-diversity computation. # L-divesity result + "lDiversityResult": { # Result of the l-diversity computation. # Output only. L-divesity result "sensitiveValueFrequencyHistogramBuckets": [ # Histogram of l-diversity equivalence class sensitive value frequencies. { # Histogram of l-diversity equivalence class sensitive value frequencies. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -3615,7 +3615,7 @@

Method Details

}, ], }, - "numericalStatsResult": { # Result of the numerical stats computation. # Numerical stats result + "numericalStatsResult": { # Result of the numerical stats computation. # Output only. Numerical stats result "maxValue": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Maximum value appearing in the column. "booleanValue": True or False, # boolean "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # date @@ -3677,9 +3677,9 @@

Method Details

], }, "requestedOptions": { # Risk analysis options. # The configuration used for this job. - "jobConfig": { # Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. + "jobConfig": { # Configuration for a risk analysis job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. "actions": [ # Actions to execute at the completion of the job. Are executed in the order provided. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -3698,14 +3698,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -3762,7 +3762,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -3814,7 +3814,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -3883,7 +3883,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -3935,7 +3935,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index 7d7f061491..a22be6c0fc 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -129,11 +129,11 @@

Method Details

{ # The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. * Amazon S3: maps 1:1 with a bucket. "configSnapshot": { # Snapshot of the configurations used to generate the profile. # The snapshot of the configurations used to generate the profile. - "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. + "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. "dataProfileActions": [ # Actions to execute at the completion of the job. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -160,15 +160,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -185,7 +185,7 @@

Method Details

}, }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "location": { # The data that will be profiled. # The data to scan. @@ -200,11 +200,11 @@

Method Details

}, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the DLP API must be enabled. }, - "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. + "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -231,15 +231,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -275,11 +275,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -442,7 +442,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -461,7 +461,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -511,7 +511,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -551,7 +551,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -566,14 +566,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -599,7 +599,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -623,15 +623,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -642,7 +642,7 @@

Method Details

"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://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}`. + "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. }, @@ -654,11 +654,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -671,7 +671,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -690,9 +690,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -704,7 +704,7 @@

Method Details

"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://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}`. + "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. }, @@ -720,7 +720,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -739,7 +739,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -751,9 +751,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -764,7 +764,7 @@

Method Details

"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://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}`. + "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. }, @@ -791,9 +791,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -860,7 +860,7 @@

Method Details

"fileStoreInfoTypeSummaries": [ # InfoTypes detected in this cluster. { # Information regarding the discovered InfoType. "infoType": { # Type of information detected by the API. # The InfoType seen. - "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://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}`. + "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. }, @@ -877,7 +877,7 @@

Method Details

"fileStoreInfoTypeSummaries": [ # InfoTypes detected in this file store. { # Information regarding the discovered InfoType. "infoType": { # Type of information detected by the API. # The InfoType seen. - "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://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}`. + "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. }, @@ -886,7 +886,7 @@

Method Details

}, ], "fileStoreIsEmpty": True or False, # The file store does not have any files. If the profiling operation failed, this is false. - "fileStoreLocation": "A String", # The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints + "fileStoreLocation": "A String", # The location of the file store. * Cloud Storage: https://docs.cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints "fileStorePath": "A String", # The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` * Vertex AI dataset: `projects/{project_number}/locations/{location}/datasets/{dataset_id}` "fullResource": "A String", # The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: `//cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}` "lastModifiedTime": "A String", # The time the file store was last modified. @@ -978,11 +978,11 @@

Method Details

"fileStoreDataProfiles": [ # List of data profiles. { # The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. * Amazon S3: maps 1:1 with a bucket. "configSnapshot": { # Snapshot of the configurations used to generate the profile. # The snapshot of the configurations used to generate the profile. - "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. + "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. "dataProfileActions": [ # Actions to execute at the completion of the job. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -1009,15 +1009,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -1034,7 +1034,7 @@

Method Details

}, }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "location": { # The data that will be profiled. # The data to scan. @@ -1049,11 +1049,11 @@

Method Details

}, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the DLP API must be enabled. }, - "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. + "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -1080,15 +1080,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -1124,11 +1124,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -1291,7 +1291,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -1310,7 +1310,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -1360,7 +1360,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -1400,7 +1400,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1415,14 +1415,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1448,7 +1448,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1472,15 +1472,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1491,7 +1491,7 @@

Method Details

"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://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}`. + "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. }, @@ -1503,11 +1503,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1520,7 +1520,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1539,9 +1539,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1553,7 +1553,7 @@

Method Details

"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://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}`. + "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. }, @@ -1569,7 +1569,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1588,7 +1588,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1600,9 +1600,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1613,7 +1613,7 @@

Method Details

"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://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}`. + "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. }, @@ -1640,9 +1640,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1709,7 +1709,7 @@

Method Details

"fileStoreInfoTypeSummaries": [ # InfoTypes detected in this cluster. { # Information regarding the discovered InfoType. "infoType": { # Type of information detected by the API. # The InfoType seen. - "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://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}`. + "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. }, @@ -1726,7 +1726,7 @@

Method Details

"fileStoreInfoTypeSummaries": [ # InfoTypes detected in this file store. { # Information regarding the discovered InfoType. "infoType": { # Type of information detected by the API. # The InfoType seen. - "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://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}`. + "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. }, @@ -1735,7 +1735,7 @@

Method Details

}, ], "fileStoreIsEmpty": True or False, # The file store does not have any files. If the profiling operation failed, this is false. - "fileStoreLocation": "A String", # The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints + "fileStoreLocation": "A String", # The location of the file store. * Cloud Storage: https://docs.cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints "fileStorePath": "A String", # The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` * Vertex AI dataset: `projects/{project_number}/locations/{location}/datasets/{dataset_id}` "fullResource": "A String", # The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: `//cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}` "lastModifiedTime": "A String", # The time the file store was last modified. diff --git a/docs/dyn/dlp_v2.organizations.locations.infoTypes.html b/docs/dyn/dlp_v2.organizations.locations.infoTypes.html index eb59842444..036086cff7 100644 --- a/docs/dyn/dlp_v2.organizations.locations.infoTypes.html +++ b/docs/dyn/dlp_v2.organizations.locations.infoTypes.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

list(parent, filter=None, languageCode=None, locationId=None, x__xgafv=None)

-

Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.

+

Returns a list of the sensitive information types that the DLP API supports. See https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.

Method Details

close() @@ -88,7 +88,7 @@

Method Details

list(parent, filter=None, languageCode=None, locationId=None, x__xgafv=None) -
Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.
+  
Returns a list of the sensitive information types that the DLP API supports. See https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.
 
 Args:
   parent: string, The parent resource name. The format of this value is as follows: `locations/{location_id}` (required)
diff --git a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html
index f19b5dd643..73f7d012f8 100644
--- a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html
+++ b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html
@@ -79,22 +79,22 @@ 

Instance Methods

Close httplib2 connections.

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

-

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

delete(name, x__xgafv=None)

-

Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Deletes an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

get(name, x__xgafv=None)

-

Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Updates the InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

Method Details

close() @@ -103,15 +103,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateInspectTemplate.
-  "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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The InspectTemplate to create.
+  "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. # Required. The InspectTemplate to create.
     "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).
@@ -120,7 +120,7 @@ 

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -135,14 +135,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -168,7 +168,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -192,15 +192,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -211,7 +211,7 @@

Method Details

"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://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}`. + "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. }, @@ -223,11 +223,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -240,7 +240,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -259,9 +259,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -273,7 +273,7 @@

Method Details

"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://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}`. + "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. }, @@ -289,7 +289,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -308,7 +308,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -320,9 +320,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -333,7 +333,7 @@

Method Details

"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://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}`. + "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. }, @@ -360,9 +360,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -385,7 +385,7 @@

Method Details

Returns: An object of the form: - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -394,7 +394,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -409,14 +409,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -442,7 +442,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -466,15 +466,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -485,7 +485,7 @@

Method Details

"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://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}`. + "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. }, @@ -497,11 +497,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -514,7 +514,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -533,9 +533,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -547,7 +547,7 @@

Method Details

"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://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}`. + "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. }, @@ -563,7 +563,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -582,7 +582,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -594,9 +594,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -607,7 +607,7 @@

Method Details

"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://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}`. + "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. }, @@ -634,9 +634,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -651,7 +651,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Deletes an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. (required)
@@ -669,7 +669,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. (required)
@@ -681,7 +681,7 @@ 

Method Details

Returns: An object of the form: - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -690,7 +690,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -705,14 +705,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -738,7 +738,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -762,15 +762,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -781,7 +781,7 @@

Method Details

"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://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}`. + "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. }, @@ -793,11 +793,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -810,7 +810,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -829,9 +829,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -843,7 +843,7 @@

Method Details

"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://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}`. + "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. }, @@ -859,7 +859,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -878,7 +878,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -890,9 +890,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -903,7 +903,7 @@

Method Details

"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://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}`. + "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. }, @@ -930,9 +930,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -947,10 +947,10 @@

Method Details

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -965,7 +965,7 @@ 

Method Details

{ # Response message for ListInspectTemplates. "inspectTemplates": [ # List of inspectTemplates, up to page_size in ListInspectTemplatesRequest. - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -974,7 +974,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -989,14 +989,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1022,7 +1022,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1046,15 +1046,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1065,7 +1065,7 @@

Method Details

"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://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}`. + "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. }, @@ -1077,11 +1077,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1094,7 +1094,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1113,9 +1113,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1127,7 +1127,7 @@

Method Details

"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://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}`. + "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. }, @@ -1143,7 +1143,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1162,7 +1162,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1174,9 +1174,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1187,7 +1187,7 @@

Method Details

"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://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}`. + "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. }, @@ -1214,9 +1214,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1248,7 +1248,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Updates the InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
   name: string, Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. (required)
@@ -1256,7 +1256,7 @@ 

Method Details

The object takes the form of: { # Request message for UpdateInspectTemplate. - "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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New InspectTemplate value. + "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. # New InspectTemplate value. "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). @@ -1265,7 +1265,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1280,14 +1280,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1313,7 +1313,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1337,15 +1337,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1356,7 +1356,7 @@

Method Details

"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://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}`. + "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. }, @@ -1368,11 +1368,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1385,7 +1385,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1404,9 +1404,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1418,7 +1418,7 @@

Method Details

"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://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}`. + "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. }, @@ -1434,7 +1434,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1453,7 +1453,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1465,9 +1465,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1478,7 +1478,7 @@

Method Details

"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://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}`. + "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. }, @@ -1505,9 +1505,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1529,7 +1529,7 @@

Method Details

Returns: An object of the form: - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -1538,7 +1538,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1553,14 +1553,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1586,7 +1586,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1610,15 +1610,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1629,7 +1629,7 @@

Method Details

"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://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}`. + "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. }, @@ -1641,11 +1641,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1658,7 +1658,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1677,9 +1677,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1691,7 +1691,7 @@

Method Details

"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://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}`. + "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. }, @@ -1707,7 +1707,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1726,7 +1726,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1738,9 +1738,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1751,7 +1751,7 @@

Method Details

"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://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}`. + "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. }, @@ -1778,9 +1778,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, diff --git a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html index 0f28f70041..059571e7bd 100644 --- a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

delete(name, x__xgafv=None)

-

Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Deletes a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

get(name, x__xgafv=None)

-

Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Gets a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

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

-

Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Lists job triggers. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Updates a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

Method Details

close() @@ -103,15 +103,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateJobTrigger.
-  "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create.
+  "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create.
     "createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
     "description": "A String", # User provided description (max 256 chars)
     "displayName": "A String", # Display name (max 100 chars)
@@ -134,7 +134,7 @@ 

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -153,14 +153,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -185,7 +185,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -200,14 +200,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -233,7 +233,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -257,15 +257,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -276,7 +276,7 @@

Method Details

"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://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}`. + "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. }, @@ -288,11 +288,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -305,7 +305,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -324,9 +324,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -338,7 +338,7 @@

Method Details

"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://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}`. + "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. }, @@ -354,7 +354,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -373,7 +373,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -385,9 +385,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -398,7 +398,7 @@

Method Details

"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://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}`. + "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. }, @@ -425,9 +425,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -454,7 +454,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -463,8 +463,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -509,17 +509,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -544,7 +544,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -567,7 +567,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -586,14 +586,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -618,7 +618,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -633,14 +633,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -666,7 +666,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -690,15 +690,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -709,7 +709,7 @@

Method Details

"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://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}`. + "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. }, @@ -721,11 +721,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -738,7 +738,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -757,9 +757,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -771,7 +771,7 @@

Method Details

"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://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}`. + "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. }, @@ -787,7 +787,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -806,7 +806,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -818,9 +818,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -831,7 +831,7 @@

Method Details

"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://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}`. + "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. }, @@ -858,9 +858,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -887,7 +887,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -896,8 +896,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -942,17 +942,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -969,7 +969,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Deletes a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
   name: string, Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)
@@ -987,7 +987,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Gets a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
   name: string, Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)
@@ -999,7 +999,7 @@ 

Method Details

Returns: An object of the form: - { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -1022,7 +1022,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -1041,14 +1041,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -1073,7 +1073,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1088,14 +1088,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1121,7 +1121,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1145,15 +1145,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1164,7 +1164,7 @@

Method Details

"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://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}`. + "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. }, @@ -1176,11 +1176,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1193,7 +1193,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1212,9 +1212,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1226,7 +1226,7 @@

Method Details

"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://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}`. + "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. }, @@ -1242,7 +1242,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1261,7 +1261,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1273,9 +1273,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1286,7 +1286,7 @@

Method Details

"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://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}`. + "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. }, @@ -1313,9 +1313,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1342,7 +1342,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -1351,8 +1351,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -1397,17 +1397,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -1424,10 +1424,10 @@

Method Details

list(parent, filter=None, locationId=None, orderBy=None, pageSize=None, pageToken=None, type=None, x__xgafv=None) -
Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Lists job triggers. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.
@@ -1448,7 +1448,7 @@ 

Method Details

{ # Response message for ListJobTriggers. "jobTriggers": [ # List of triggeredJobs, up to page_size in ListJobTriggersRequest. - { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -1471,7 +1471,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -1490,14 +1490,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -1522,7 +1522,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1537,14 +1537,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1570,7 +1570,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1594,15 +1594,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1613,7 +1613,7 @@

Method Details

"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://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}`. + "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. }, @@ -1625,11 +1625,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1642,7 +1642,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1661,9 +1661,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1675,7 +1675,7 @@

Method Details

"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://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}`. + "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. }, @@ -1691,7 +1691,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1710,7 +1710,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1722,9 +1722,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1735,7 +1735,7 @@

Method Details

"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://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}`. + "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. }, @@ -1762,9 +1762,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1791,7 +1791,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -1800,8 +1800,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -1846,17 +1846,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -1890,7 +1890,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Updates a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
   name: string, Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)
@@ -1898,7 +1898,7 @@ 

Method Details

The object takes the form of: { # Request message for UpdateJobTrigger. - "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value. + "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -1921,7 +1921,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -1940,14 +1940,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -1972,7 +1972,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1987,14 +1987,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -2020,7 +2020,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -2044,15 +2044,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -2063,7 +2063,7 @@

Method Details

"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://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}`. + "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. }, @@ -2075,11 +2075,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -2092,7 +2092,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -2111,9 +2111,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2125,7 +2125,7 @@

Method Details

"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://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}`. + "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. }, @@ -2141,7 +2141,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -2160,7 +2160,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -2172,9 +2172,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2185,7 +2185,7 @@

Method Details

"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://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}`. + "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. }, @@ -2212,9 +2212,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -2241,7 +2241,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -2250,8 +2250,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -2296,17 +2296,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -2330,7 +2330,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -2353,7 +2353,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -2372,14 +2372,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -2404,7 +2404,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -2419,14 +2419,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -2452,7 +2452,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -2476,15 +2476,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -2495,7 +2495,7 @@

Method Details

"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://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}`. + "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. }, @@ -2507,11 +2507,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -2524,7 +2524,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -2543,9 +2543,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2557,7 +2557,7 @@

Method Details

"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://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}`. + "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. }, @@ -2573,7 +2573,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -2592,7 +2592,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -2604,9 +2604,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2617,7 +2617,7 @@

Method Details

"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://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}`. + "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. }, @@ -2644,9 +2644,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -2673,7 +2673,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -2682,8 +2682,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -2728,17 +2728,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. diff --git a/docs/dyn/dlp_v2.organizations.locations.storedInfoTypes.html b/docs/dyn/dlp_v2.organizations.locations.storedInfoTypes.html index 4d159faf8b..2d9f23cf4b 100644 --- a/docs/dyn/dlp_v2.organizations.locations.storedInfoTypes.html +++ b/docs/dyn/dlp_v2.organizations.locations.storedInfoTypes.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

delete(name, x__xgafv=None)

-

Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

get(name, x__xgafv=None)

-

Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Method Details

close() @@ -103,17 +103,17 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateStoredInfoType.
-  "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Required. Configuration of the storedInfoType to create.
+  "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Required. Configuration of the storedInfoType to create.
     "description": "A String", # Description of the StoredInfoType (max 256 characters).
-    "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://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. # Store dictionary-based CustomInfoType.
+    "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. # Store dictionary-based 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`
       },
@@ -124,7 +124,7 @@ 

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -163,9 +163,9 @@

Method Details

{ # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -176,7 +176,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -229,9 +229,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -242,7 +242,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -298,7 +298,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required)
@@ -316,7 +316,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required)
@@ -330,9 +330,9 @@ 

Method Details

{ # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -343,7 +343,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -396,9 +396,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -409,7 +409,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -465,10 +465,10 @@

Method Details

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -486,9 +486,9 @@ 

Method Details

"storedInfoTypes": [ # List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest. { # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -499,7 +499,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -552,9 +552,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -565,7 +565,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -637,7 +637,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
   name: string, Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required)
@@ -645,9 +645,9 @@ 

Method Details

The object takes the form of: { # Request message for UpdateStoredInfoType. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -658,7 +658,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -696,9 +696,9 @@

Method Details

{ # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -709,7 +709,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -762,9 +762,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -775,7 +775,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index daa2893aae..feefc3d093 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -129,11 +129,11 @@

Method Details

{ # The profile for a scanned table. "configSnapshot": { # Snapshot of the configurations used to generate the profile. # The snapshot of the configurations used to generate the profile. - "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. + "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. "dataProfileActions": [ # Actions to execute at the completion of the job. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -160,15 +160,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -185,7 +185,7 @@

Method Details

}, }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "location": { # The data that will be profiled. # The data to scan. @@ -200,11 +200,11 @@

Method Details

}, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the DLP API must be enabled. }, - "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. + "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -231,15 +231,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -275,11 +275,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -442,7 +442,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -461,7 +461,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -511,7 +511,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -551,7 +551,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -566,14 +566,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -599,7 +599,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -623,15 +623,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -642,7 +642,7 @@

Method Details

"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://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}`. + "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. }, @@ -654,11 +654,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -671,7 +671,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -690,9 +690,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -704,7 +704,7 @@

Method Details

"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://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}`. + "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. }, @@ -720,7 +720,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -739,7 +739,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -751,9 +751,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -764,7 +764,7 @@

Method Details

"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://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}`. + "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. }, @@ -791,9 +791,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -812,7 +812,7 @@

Method Details

"dataSource": "A String", # A string that identifies the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "datasetId": "A String", # If the resource is BigQuery, the dataset ID. - "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations. + "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://docs.cloud.google.com/bigquery/docs/locations for supported locations. "datasetProjectId": "A String", # The Google Cloud project ID that owns the resource. "domains": [ # Domains associated with the profile. { # A domain represents a thematic category that a data profile can fall under. @@ -833,7 +833,7 @@

Method Details

"estimatedPrevalence": 42, # Approximate percentage of non-null rows that contained data detected by this infotype. "excludedFromAnalysis": True or False, # Whether this infoType was excluded from sensitivity and risk analysis due to factors such as low prevalence (subject to change). "infoType": { # Type of information detected by the API. # The other infoType. - "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://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}`. + "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. }, @@ -845,7 +845,7 @@

Method Details

{ # The infoType details for this column. "estimatedPrevalence": 42, # Not populated for predicted infotypes. "infoType": { # Type of information detected by the API. # The infoType. - "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://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}`. + "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. }, @@ -922,11 +922,11 @@

Method Details

"tableDataProfiles": [ # List of data profiles. { # The profile for a scanned table. "configSnapshot": { # Snapshot of the configurations used to generate the profile. # The snapshot of the configurations used to generate the profile. - "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. + "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. "dataProfileActions": [ # Actions to execute at the completion of the job. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -953,15 +953,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -978,7 +978,7 @@

Method Details

}, }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "location": { # The data that will be profiled. # The data to scan. @@ -993,11 +993,11 @@

Method Details

}, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the DLP API must be enabled. }, - "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. + "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -1024,15 +1024,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -1068,11 +1068,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -1235,7 +1235,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -1254,7 +1254,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -1304,7 +1304,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -1344,7 +1344,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1359,14 +1359,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1392,7 +1392,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1416,15 +1416,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1435,7 +1435,7 @@

Method Details

"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://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}`. + "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. }, @@ -1447,11 +1447,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1464,7 +1464,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1483,9 +1483,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1497,7 +1497,7 @@

Method Details

"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://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}`. + "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. }, @@ -1513,7 +1513,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1532,7 +1532,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1544,9 +1544,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1557,7 +1557,7 @@

Method Details

"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://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}`. + "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. }, @@ -1584,9 +1584,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1605,7 +1605,7 @@

Method Details

"dataSource": "A String", # A string that identifies the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "datasetId": "A String", # If the resource is BigQuery, the dataset ID. - "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations. + "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://docs.cloud.google.com/bigquery/docs/locations for supported locations. "datasetProjectId": "A String", # The Google Cloud project ID that owns the resource. "domains": [ # Domains associated with the profile. { # A domain represents a thematic category that a data profile can fall under. @@ -1626,7 +1626,7 @@

Method Details

"estimatedPrevalence": 42, # Approximate percentage of non-null rows that contained data detected by this infotype. "excludedFromAnalysis": True or False, # Whether this infoType was excluded from sensitivity and risk analysis due to factors such as low prevalence (subject to change). "infoType": { # Type of information detected by the API. # The other infoType. - "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://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}`. + "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. }, @@ -1638,7 +1638,7 @@

Method Details

{ # The infoType details for this column. "estimatedPrevalence": 42, # Not populated for predicted infotypes. "infoType": { # Type of information detected by the API. # The infoType. - "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://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}`. + "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. }, diff --git a/docs/dyn/dlp_v2.organizations.storedInfoTypes.html b/docs/dyn/dlp_v2.organizations.storedInfoTypes.html index 4406c50a24..1f62bc47d9 100644 --- a/docs/dyn/dlp_v2.organizations.storedInfoTypes.html +++ b/docs/dyn/dlp_v2.organizations.storedInfoTypes.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

delete(name, x__xgafv=None)

-

Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

get(name, x__xgafv=None)

-

Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Method Details

close() @@ -103,17 +103,17 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateStoredInfoType.
-  "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Required. Configuration of the storedInfoType to create.
+  "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Required. Configuration of the storedInfoType to create.
     "description": "A String", # Description of the StoredInfoType (max 256 characters).
-    "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://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. # Store dictionary-based CustomInfoType.
+    "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. # Store dictionary-based 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`
       },
@@ -124,7 +124,7 @@ 

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -163,9 +163,9 @@

Method Details

{ # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -176,7 +176,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -229,9 +229,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -242,7 +242,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -298,7 +298,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required)
@@ -316,7 +316,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required)
@@ -330,9 +330,9 @@ 

Method Details

{ # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -343,7 +343,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -396,9 +396,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -409,7 +409,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -465,10 +465,10 @@

Method Details

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -486,9 +486,9 @@ 

Method Details

"storedInfoTypes": [ # List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest. { # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -499,7 +499,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -552,9 +552,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -565,7 +565,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -637,7 +637,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
   name: string, Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required)
@@ -645,9 +645,9 @@ 

Method Details

The object takes the form of: { # Request message for UpdateStoredInfoType. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -658,7 +658,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -696,9 +696,9 @@

Method Details

{ # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -709,7 +709,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -762,9 +762,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -775,7 +775,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. diff --git a/docs/dyn/dlp_v2.projects.content.html b/docs/dyn/dlp_v2.projects.content.html index 5846a73c76..8eb68a4e0b 100644 --- a/docs/dyn/dlp_v2.projects.content.html +++ b/docs/dyn/dlp_v2.projects.content.html @@ -79,13 +79,13 @@

Instance Methods

Close httplib2 connections.

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

-

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

+

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://docs.cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

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

-

Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,

+

Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text,

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

-

Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.

+

Re-identifies content that has been de-identified. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.

Method Details

close() @@ -94,10 +94,10 @@

Method Details

deidentify(parent, body=None, x__xgafv=None) -
De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
+  
De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://docs.cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
 
 Args:
-  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -118,7 +118,7 @@ 

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -134,7 +134,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -142,7 +142,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -221,7 +221,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -233,16 +233,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -254,13 +254,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -273,20 +273,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -300,7 +300,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -365,7 +365,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -427,7 +427,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -435,7 +435,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -514,7 +514,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -526,16 +526,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -547,13 +547,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -566,20 +566,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -593,7 +593,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -658,7 +658,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -674,7 +674,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -753,7 +753,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -765,16 +765,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -786,13 +786,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -805,20 +805,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -832,7 +832,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -897,7 +897,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -962,7 +962,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -977,14 +977,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1010,7 +1010,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1034,15 +1034,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1053,7 +1053,7 @@

Method Details

"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://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}`. + "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. }, @@ -1065,11 +1065,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1082,7 +1082,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1101,9 +1101,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1115,7 +1115,7 @@

Method Details

"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://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}`. + "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. }, @@ -1131,7 +1131,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1150,7 +1150,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1162,9 +1162,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1175,7 +1175,7 @@

Method Details

"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://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}`. + "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. }, @@ -1202,9 +1202,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1276,7 +1276,7 @@

Method Details

}, ], }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -1385,7 +1385,7 @@

Method Details

}, ], }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -1471,7 +1471,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1479,7 +1479,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1558,7 +1558,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1570,16 +1570,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1591,13 +1591,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1610,20 +1610,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1637,7 +1637,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1702,7 +1702,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1718,7 +1718,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1797,7 +1797,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1809,16 +1809,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1830,13 +1830,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1849,20 +1849,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1876,7 +1876,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1941,7 +1941,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1956,7 +1956,7 @@

Method Details

}, ], "infoType": { # Type of information detected by the API. # Set if the transformation was limited to a specific InfoType. - "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://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}`. + "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. }, @@ -2006,7 +2006,7 @@

Method Details

}, ], "transformation": { # A rule for transforming a value. # The specific transformation these stats apply to. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2085,7 +2085,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2097,16 +2097,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2118,13 +2118,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2137,20 +2137,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2164,7 +2164,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2229,7 +2229,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2251,10 +2251,10 @@

Method Details

inspect(parent, body=None, x__xgafv=None) -
Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,
+  
Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text,
 
 Args:
-  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -2263,7 +2263,7 @@ 

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -2278,14 +2278,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -2311,7 +2311,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -2335,15 +2335,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -2354,7 +2354,7 @@

Method Details

"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://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}`. + "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. }, @@ -2366,11 +2366,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -2383,7 +2383,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -2402,9 +2402,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2416,7 +2416,7 @@

Method Details

"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://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}`. + "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. }, @@ -2432,7 +2432,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -2451,7 +2451,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -2463,9 +2463,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2476,7 +2476,7 @@

Method Details

"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://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}`. + "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. }, @@ -2503,9 +2503,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -2577,7 +2577,7 @@

Method Details

}, ], }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -2629,7 +2629,7 @@

Method Details

"createTime": "A String", # Timestamp when finding was detected. "findingId": "A String", # The unique finding id. "infoType": { # Type of information detected by the API. # The type of content that might have been found. Provided if `excluded_types` is false. - "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://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}`. + "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. }, @@ -2765,10 +2765,10 @@

Method Details

reidentify(parent, body=None, x__xgafv=None) -
Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.
+  
Re-identifies content that has been de-identified. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -2777,7 +2777,7 @@ 

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -2792,14 +2792,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -2825,7 +2825,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -2849,15 +2849,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -2868,7 +2868,7 @@

Method Details

"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://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}`. + "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. }, @@ -2880,11 +2880,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -2897,7 +2897,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -2916,9 +2916,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2930,7 +2930,7 @@

Method Details

"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://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}`. + "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. }, @@ -2946,7 +2946,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -2965,7 +2965,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -2977,9 +2977,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2990,7 +2990,7 @@

Method Details

"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://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}`. + "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. }, @@ -3017,9 +3017,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3091,7 +3091,7 @@

Method Details

}, ], }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -3142,7 +3142,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -3158,7 +3158,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3166,7 +3166,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3245,7 +3245,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3257,16 +3257,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3278,13 +3278,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3297,20 +3297,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3324,7 +3324,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3389,7 +3389,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3451,7 +3451,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3459,7 +3459,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3538,7 +3538,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3550,16 +3550,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3571,13 +3571,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3590,20 +3590,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3617,7 +3617,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3682,7 +3682,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3698,7 +3698,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3777,7 +3777,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3789,16 +3789,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3810,13 +3810,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3829,20 +3829,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3856,7 +3856,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3921,7 +3921,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4056,7 +4056,7 @@

Method Details

}, ], }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -4142,7 +4142,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4150,7 +4150,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4229,7 +4229,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4241,16 +4241,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4262,13 +4262,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4281,20 +4281,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4308,7 +4308,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4373,7 +4373,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4389,7 +4389,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4468,7 +4468,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4480,16 +4480,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4501,13 +4501,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4520,20 +4520,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4547,7 +4547,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4612,7 +4612,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4627,7 +4627,7 @@

Method Details

}, ], "infoType": { # Type of information detected by the API. # Set if the transformation was limited to a specific InfoType. - "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://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}`. + "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. }, @@ -4677,7 +4677,7 @@

Method Details

}, ], "transformation": { # A rule for transforming a value. # The specific transformation these stats apply to. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4756,7 +4756,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4768,16 +4768,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4789,13 +4789,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4808,20 +4808,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4835,7 +4835,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4900,7 +4900,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], diff --git a/docs/dyn/dlp_v2.projects.deidentifyTemplates.html b/docs/dyn/dlp_v2.projects.deidentifyTemplates.html index 25e3557b3f..110b2bc92f 100644 --- a/docs/dyn/dlp_v2.projects.deidentifyTemplates.html +++ b/docs/dyn/dlp_v2.projects.deidentifyTemplates.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

delete(name, x__xgafv=None)

-

Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Deletes a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

get(name, x__xgafv=None)

-

Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Gets a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Lists DeidentifyTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Updates the DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

Method Details

close() @@ -103,15 +103,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateDeidentifyTemplate.
-  "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The DeidentifyTemplate to create.
+  "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The DeidentifyTemplate to create.
     "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
     "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template.
       "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact.
@@ -129,7 +129,7 @@ 

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -145,7 +145,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -153,7 +153,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -232,7 +232,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -244,16 +244,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -265,13 +265,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -284,20 +284,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -311,7 +311,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -376,7 +376,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -438,7 +438,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -446,7 +446,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -525,7 +525,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -537,16 +537,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -558,13 +558,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -577,20 +577,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -604,7 +604,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -669,7 +669,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -685,7 +685,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -764,7 +764,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -776,16 +776,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -797,13 +797,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -816,20 +816,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -843,7 +843,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -908,7 +908,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -985,7 +985,7 @@

Method Details

Returns: An object of the form: - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1003,7 +1003,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1019,7 +1019,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1027,7 +1027,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1106,7 +1106,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1118,16 +1118,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1139,13 +1139,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1158,20 +1158,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1185,7 +1185,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1250,7 +1250,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1312,7 +1312,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1320,7 +1320,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1399,7 +1399,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1411,16 +1411,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1432,13 +1432,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1451,20 +1451,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1478,7 +1478,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1543,7 +1543,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1559,7 +1559,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1638,7 +1638,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1650,16 +1650,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1671,13 +1671,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1690,20 +1690,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1717,7 +1717,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1782,7 +1782,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1851,7 +1851,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Deletes a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. (required)
@@ -1869,7 +1869,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Gets a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. (required)
@@ -1881,7 +1881,7 @@ 

Method Details

Returns: An object of the form: - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1899,7 +1899,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1915,7 +1915,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1923,7 +1923,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2002,7 +2002,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2014,16 +2014,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2035,13 +2035,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2054,20 +2054,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2081,7 +2081,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2146,7 +2146,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2208,7 +2208,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2216,7 +2216,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2295,7 +2295,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2307,16 +2307,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2328,13 +2328,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2347,20 +2347,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2374,7 +2374,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2439,7 +2439,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2455,7 +2455,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2534,7 +2534,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2546,16 +2546,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2567,13 +2567,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2586,20 +2586,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2613,7 +2613,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2678,7 +2678,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2747,10 +2747,10 @@

Method Details

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Lists DeidentifyTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -2765,7 +2765,7 @@ 

Method Details

{ # Response message for ListDeidentifyTemplates. "deidentifyTemplates": [ # List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest. - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -2783,7 +2783,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -2799,7 +2799,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2807,7 +2807,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2886,7 +2886,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2898,16 +2898,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2919,13 +2919,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2938,20 +2938,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2965,7 +2965,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3030,7 +3030,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3092,7 +3092,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3100,7 +3100,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3179,7 +3179,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3191,16 +3191,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3212,13 +3212,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3231,20 +3231,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3258,7 +3258,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3323,7 +3323,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3339,7 +3339,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3418,7 +3418,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3430,16 +3430,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3451,13 +3451,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3470,20 +3470,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3497,7 +3497,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3562,7 +3562,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3648,7 +3648,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Updates the DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
   name: string, Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. (required)
@@ -3656,7 +3656,7 @@ 

Method Details

The object takes the form of: { # Request message for UpdateDeidentifyTemplate. - "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New DeidentifyTemplate value. + "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New DeidentifyTemplate value. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -3674,7 +3674,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -3690,7 +3690,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3698,7 +3698,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3777,7 +3777,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3789,16 +3789,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3810,13 +3810,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3829,20 +3829,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3856,7 +3856,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3921,7 +3921,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3983,7 +3983,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3991,7 +3991,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4070,7 +4070,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4082,16 +4082,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4103,13 +4103,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4122,20 +4122,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4149,7 +4149,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4214,7 +4214,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4230,7 +4230,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4309,7 +4309,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4321,16 +4321,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4342,13 +4342,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4361,20 +4361,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4388,7 +4388,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4453,7 +4453,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4529,7 +4529,7 @@

Method Details

Returns: An object of the form: - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -4547,7 +4547,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -4563,7 +4563,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4571,7 +4571,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4650,7 +4650,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4662,16 +4662,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4683,13 +4683,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4702,20 +4702,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4729,7 +4729,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4794,7 +4794,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4856,7 +4856,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4864,7 +4864,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4943,7 +4943,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4955,16 +4955,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4976,13 +4976,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4995,20 +4995,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5022,7 +5022,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5087,7 +5087,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -5103,7 +5103,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -5182,7 +5182,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5194,16 +5194,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5215,13 +5215,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5234,20 +5234,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5261,7 +5261,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5326,7 +5326,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html index 073a823215..5cfdb79f30 100644 --- a/docs/dyn/dlp_v2.projects.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.dlpJobs.html @@ -76,29 +76,29 @@

Sensitive Data Protection (DLP) . cancel(name, body=None, x__xgafv=None)

-

Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

+

Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

close()

Close httplib2 connections.

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

-

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

+

Creates a new job to inspect storage or calculate risk metrics. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

delete(name, x__xgafv=None)

-

Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

+

Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

get(name, x__xgafv=None)

-

Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

+

Gets the latest state of a long-running DlpJob. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

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

-

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

+

Lists DlpJobs that match the specified filter in the request. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

list_next()

Retrieves the next page of results.

Method Details

cancel(name, body=None, x__xgafv=None) -
Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
+  
Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
 
 Args:
   name: string, Required. The name of the DlpJob resource to be cancelled. (required)
@@ -127,17 +127,17 @@ 

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
+  
Creates a new job to inspect storage or calculate risk metrics. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.
   "inspectJob": { # Controls what and how to inspect for findings. # An inspection job scans a storage repository for InfoTypes.
     "actions": [ # Actions to execute at the completion of the job.
-      { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more.
+      { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more.
         "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data.
           "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket
           "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV.
@@ -156,14 +156,14 @@ 

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -188,7 +188,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -203,14 +203,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -236,7 +236,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -260,15 +260,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -279,7 +279,7 @@

Method Details

"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://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}`. + "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. }, @@ -291,11 +291,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -308,7 +308,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -327,9 +327,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -341,7 +341,7 @@

Method Details

"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://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}`. + "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. }, @@ -357,7 +357,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -376,7 +376,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -388,9 +388,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -401,7 +401,7 @@

Method Details

"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://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}`. + "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. }, @@ -428,9 +428,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -457,7 +457,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -466,8 +466,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -512,10 +512,10 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -523,9 +523,9 @@

Method Details

}, "jobId": "A String", # The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. "locationId": "A String", # Deprecated. This field has no effect. - "riskJob": { # Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # A risk analysis job calculates re-identification risk metrics for a BigQuery table. + "riskJob": { # Configuration for a risk analysis job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # A risk analysis job calculates re-identification risk metrics for a BigQuery table. "actions": [ # Actions to execute at the completion of the job. Are executed in the order provided. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -544,14 +544,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -608,7 +608,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -660,7 +660,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -703,7 +703,7 @@

Method Details

An object of the form: { # Combines all of the information about a DLP job. - "actionDetails": [ # Events that should occur after the job has completed. + "actionDetails": [ # Output only. Events that should occur after the job has completed. { # The results of an Action. "deidentifyDetails": { # The results of a Deidentify action from an inspect job. # Outcome of a de-identification action. "deidentifyStats": { # Summary of what was modified during a transformation. # Stats about the de-identification operation. @@ -712,7 +712,7 @@

Method Details

"transformedBytes": "A String", # Total size in bytes that were transformed in some way. }, "requestedOptions": { # De-identification options. # De-identification config used for the request. - "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. + "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -730,7 +730,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -746,7 +746,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -754,7 +754,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -833,7 +833,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -845,16 +845,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -866,13 +866,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -885,20 +885,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -912,7 +912,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -977,7 +977,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1039,7 +1039,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1047,7 +1047,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1126,7 +1126,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1138,16 +1138,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1159,13 +1159,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1178,20 +1178,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1205,7 +1205,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1270,7 +1270,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1286,7 +1286,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1365,7 +1365,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1377,16 +1377,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1398,13 +1398,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1417,20 +1417,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1444,7 +1444,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1509,7 +1509,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1574,7 +1574,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1592,7 +1592,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1608,7 +1608,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1616,7 +1616,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1695,7 +1695,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1707,16 +1707,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1728,13 +1728,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1747,20 +1747,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1774,7 +1774,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1839,7 +1839,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1901,7 +1901,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1909,7 +1909,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1988,7 +1988,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2000,16 +2000,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2021,13 +2021,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2040,20 +2040,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2067,7 +2067,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2132,7 +2132,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2148,7 +2148,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2227,7 +2227,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2239,16 +2239,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2260,13 +2260,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2279,20 +2279,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2306,7 +2306,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2371,7 +2371,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2436,7 +2436,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -2454,7 +2454,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -2470,7 +2470,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2478,7 +2478,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2557,7 +2557,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2569,16 +2569,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2590,13 +2590,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2609,20 +2609,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2636,7 +2636,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2701,7 +2701,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2763,7 +2763,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2771,7 +2771,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2850,7 +2850,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2862,16 +2862,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2883,13 +2883,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2902,20 +2902,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2929,7 +2929,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2994,7 +2994,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3010,7 +3010,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3089,7 +3089,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3101,16 +3101,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3122,13 +3122,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3141,20 +3141,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3168,7 +3168,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3233,7 +3233,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3325,7 +3325,7 @@

Method Details

"requestedOptions": { # Snapshot of the inspection configuration. # The configuration used for this job. "jobConfig": { # Controls what and how to inspect for findings. # Inspect config. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -3344,14 +3344,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -3376,7 +3376,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -3391,14 +3391,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -3424,7 +3424,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -3448,15 +3448,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -3467,7 +3467,7 @@

Method Details

"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://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}`. + "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. }, @@ -3479,11 +3479,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -3496,7 +3496,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -3515,9 +3515,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3529,7 +3529,7 @@

Method Details

"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://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}`. + "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. }, @@ -3545,7 +3545,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -3564,7 +3564,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -3576,9 +3576,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3589,7 +3589,7 @@

Method Details

"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://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}`. + "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. }, @@ -3616,9 +3616,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3645,7 +3645,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -3654,8 +3654,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -3700,16 +3700,16 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, - "snapshotInspectTemplate": { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. + "snapshotInspectTemplate": { # 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. # Output only. If run with an InspectTemplate, a snapshot of its state at the time of this run. "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). @@ -3718,7 +3718,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -3733,14 +3733,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -3766,7 +3766,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -3790,15 +3790,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -3809,7 +3809,7 @@

Method Details

"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://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}`. + "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. }, @@ -3821,11 +3821,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -3838,7 +3838,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -3857,9 +3857,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3871,7 +3871,7 @@

Method Details

"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://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}`. + "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. }, @@ -3887,7 +3887,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -3906,7 +3906,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -3918,9 +3918,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3931,7 +3931,7 @@

Method Details

"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://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}`. + "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. }, @@ -3958,9 +3958,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3972,7 +3972,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, }, - "result": { # All Result fields are updated while the job is processing. # A summary of the outcome of this inspection job. + "result": { # All Result fields are updated while the job is processing. # Output only. A summary of the outcome of this inspection job. "hybridStats": { # Statistics related to processing hybrid inspect requests. # Statistics related to the processing of hybrid inspect. "abortedCount": "A String", # The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed. "pendingCount": "A String", # The number of hybrid requests currently being processed. Only populated when called via method `getDlpJob`. A burst of traffic may cause hybrid inspect requests to be enqueued. Processing will take place as quickly as possible, but resource limitations may impact how long a request is enqueued for. @@ -3982,7 +3982,7 @@

Method Details

{ # Statistics regarding a specific InfoType. "count": "A String", # Number of findings for this infoType. "infoType": { # Type of information detected by the API. # The type of finding this stat is for. - "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://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}`. + "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. }, @@ -3999,7 +3999,7 @@

Method Details

"lastModified": "A String", # Output only. Time when the job was last modified by the system. "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. - "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result + "categoricalStatsResult": { # Result of the categorical stats computation. # Output only. Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. { # Histogram of value frequencies in the column. "bucketSize": "A String", # Total number of values in this bucket. @@ -4033,7 +4033,7 @@

Method Details

}, ], }, - "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Delta-presence result + "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Output only. Delta-presence result "deltaPresenceEstimationHistogram": [ # The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. { # A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset. "bucketSize": "A String", # Number of records within these probability bounds. @@ -4069,7 +4069,7 @@

Method Details

}, ], }, - "kAnonymityResult": { # Result of the k-anonymity computation. # K-anonymity result + "kAnonymityResult": { # Result of the k-anonymity computation. # Output only. K-anonymity result "equivalenceClassHistogramBuckets": [ # Histogram of k-anonymity equivalence classes. { # Histogram of k-anonymity equivalence classes. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -4105,7 +4105,7 @@

Method Details

}, ], }, - "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # K-map result + "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # Output only. K-map result "kMapEstimationHistogram": [ # The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10. { # A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records. "bucketSize": "A String", # Number of records within these anonymity bounds. @@ -4141,7 +4141,7 @@

Method Details

}, ], }, - "lDiversityResult": { # Result of the l-diversity computation. # L-divesity result + "lDiversityResult": { # Result of the l-diversity computation. # Output only. L-divesity result "sensitiveValueFrequencyHistogramBuckets": [ # Histogram of l-diversity equivalence class sensitive value frequencies. { # Histogram of l-diversity equivalence class sensitive value frequencies. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -4202,7 +4202,7 @@

Method Details

}, ], }, - "numericalStatsResult": { # Result of the numerical stats computation. # Numerical stats result + "numericalStatsResult": { # Result of the numerical stats computation. # Output only. Numerical stats result "maxValue": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Maximum value appearing in the column. "booleanValue": True or False, # boolean "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # date @@ -4264,9 +4264,9 @@

Method Details

], }, "requestedOptions": { # Risk analysis options. # The configuration used for this job. - "jobConfig": { # Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. + "jobConfig": { # Configuration for a risk analysis job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. "actions": [ # Actions to execute at the completion of the job. Are executed in the order provided. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -4285,14 +4285,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -4349,7 +4349,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -4401,7 +4401,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -4470,7 +4470,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -4522,7 +4522,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -4562,7 +4562,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
+  
Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
 
 Args:
   name: string, Required. The name of the DlpJob resource to be deleted. (required)
@@ -4580,7 +4580,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
+  
Gets the latest state of a long-running DlpJob. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
 
 Args:
   name: string, Required. The name of the DlpJob resource. (required)
@@ -4593,7 +4593,7 @@ 

Method Details

An object of the form: { # Combines all of the information about a DLP job. - "actionDetails": [ # Events that should occur after the job has completed. + "actionDetails": [ # Output only. Events that should occur after the job has completed. { # The results of an Action. "deidentifyDetails": { # The results of a Deidentify action from an inspect job. # Outcome of a de-identification action. "deidentifyStats": { # Summary of what was modified during a transformation. # Stats about the de-identification operation. @@ -4602,7 +4602,7 @@

Method Details

"transformedBytes": "A String", # Total size in bytes that were transformed in some way. }, "requestedOptions": { # De-identification options. # De-identification config used for the request. - "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. + "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -4620,7 +4620,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -4636,7 +4636,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4644,7 +4644,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4723,7 +4723,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4735,16 +4735,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4756,13 +4756,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4775,20 +4775,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4802,7 +4802,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4867,7 +4867,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4929,7 +4929,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4937,7 +4937,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -5016,7 +5016,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5028,16 +5028,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5049,13 +5049,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5068,20 +5068,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5095,7 +5095,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5160,7 +5160,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -5176,7 +5176,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -5255,7 +5255,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5267,16 +5267,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5288,13 +5288,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5307,20 +5307,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5334,7 +5334,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5399,7 +5399,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -5464,7 +5464,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -5482,7 +5482,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -5498,7 +5498,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -5506,7 +5506,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -5585,7 +5585,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5597,16 +5597,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5618,13 +5618,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5637,20 +5637,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5664,7 +5664,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5729,7 +5729,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -5791,7 +5791,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -5799,7 +5799,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -5878,7 +5878,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5890,16 +5890,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5911,13 +5911,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5930,20 +5930,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5957,7 +5957,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -6022,7 +6022,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -6038,7 +6038,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -6117,7 +6117,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6129,16 +6129,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6150,13 +6150,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6169,20 +6169,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6196,7 +6196,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -6261,7 +6261,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -6326,7 +6326,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -6344,7 +6344,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -6360,7 +6360,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -6368,7 +6368,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -6447,7 +6447,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6459,16 +6459,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6480,13 +6480,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6499,20 +6499,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6526,7 +6526,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -6591,7 +6591,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -6653,7 +6653,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -6661,7 +6661,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -6740,7 +6740,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6752,16 +6752,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6773,13 +6773,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6792,20 +6792,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6819,7 +6819,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -6884,7 +6884,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -6900,7 +6900,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -6979,7 +6979,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6991,16 +6991,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -7012,13 +7012,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -7031,20 +7031,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -7058,7 +7058,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -7123,7 +7123,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -7215,7 +7215,7 @@

Method Details

"requestedOptions": { # Snapshot of the inspection configuration. # The configuration used for this job. "jobConfig": { # Controls what and how to inspect for findings. # Inspect config. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -7234,14 +7234,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -7266,7 +7266,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -7281,14 +7281,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -7314,7 +7314,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -7338,15 +7338,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -7357,7 +7357,7 @@

Method Details

"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://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}`. + "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. }, @@ -7369,11 +7369,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -7386,7 +7386,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -7405,9 +7405,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -7419,7 +7419,7 @@

Method Details

"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://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}`. + "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. }, @@ -7435,7 +7435,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -7454,7 +7454,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -7466,9 +7466,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -7479,7 +7479,7 @@

Method Details

"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://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}`. + "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. }, @@ -7506,9 +7506,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -7535,7 +7535,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -7544,8 +7544,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -7590,16 +7590,16 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, - "snapshotInspectTemplate": { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. + "snapshotInspectTemplate": { # 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. # Output only. If run with an InspectTemplate, a snapshot of its state at the time of this run. "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). @@ -7608,7 +7608,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -7623,14 +7623,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -7656,7 +7656,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -7680,15 +7680,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -7699,7 +7699,7 @@

Method Details

"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://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}`. + "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. }, @@ -7711,11 +7711,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -7728,7 +7728,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -7747,9 +7747,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -7761,7 +7761,7 @@

Method Details

"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://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}`. + "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. }, @@ -7777,7 +7777,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -7796,7 +7796,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -7808,9 +7808,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -7821,7 +7821,7 @@

Method Details

"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://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}`. + "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. }, @@ -7848,9 +7848,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -7862,7 +7862,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, }, - "result": { # All Result fields are updated while the job is processing. # A summary of the outcome of this inspection job. + "result": { # All Result fields are updated while the job is processing. # Output only. A summary of the outcome of this inspection job. "hybridStats": { # Statistics related to processing hybrid inspect requests. # Statistics related to the processing of hybrid inspect. "abortedCount": "A String", # The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed. "pendingCount": "A String", # The number of hybrid requests currently being processed. Only populated when called via method `getDlpJob`. A burst of traffic may cause hybrid inspect requests to be enqueued. Processing will take place as quickly as possible, but resource limitations may impact how long a request is enqueued for. @@ -7872,7 +7872,7 @@

Method Details

{ # Statistics regarding a specific InfoType. "count": "A String", # Number of findings for this infoType. "infoType": { # Type of information detected by the API. # The type of finding this stat is for. - "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://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}`. + "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. }, @@ -7889,7 +7889,7 @@

Method Details

"lastModified": "A String", # Output only. Time when the job was last modified by the system. "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. - "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result + "categoricalStatsResult": { # Result of the categorical stats computation. # Output only. Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. { # Histogram of value frequencies in the column. "bucketSize": "A String", # Total number of values in this bucket. @@ -7923,7 +7923,7 @@

Method Details

}, ], }, - "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Delta-presence result + "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Output only. Delta-presence result "deltaPresenceEstimationHistogram": [ # The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. { # A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset. "bucketSize": "A String", # Number of records within these probability bounds. @@ -7959,7 +7959,7 @@

Method Details

}, ], }, - "kAnonymityResult": { # Result of the k-anonymity computation. # K-anonymity result + "kAnonymityResult": { # Result of the k-anonymity computation. # Output only. K-anonymity result "equivalenceClassHistogramBuckets": [ # Histogram of k-anonymity equivalence classes. { # Histogram of k-anonymity equivalence classes. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -7995,7 +7995,7 @@

Method Details

}, ], }, - "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # K-map result + "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # Output only. K-map result "kMapEstimationHistogram": [ # The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10. { # A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records. "bucketSize": "A String", # Number of records within these anonymity bounds. @@ -8031,7 +8031,7 @@

Method Details

}, ], }, - "lDiversityResult": { # Result of the l-diversity computation. # L-divesity result + "lDiversityResult": { # Result of the l-diversity computation. # Output only. L-divesity result "sensitiveValueFrequencyHistogramBuckets": [ # Histogram of l-diversity equivalence class sensitive value frequencies. { # Histogram of l-diversity equivalence class sensitive value frequencies. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -8092,7 +8092,7 @@

Method Details

}, ], }, - "numericalStatsResult": { # Result of the numerical stats computation. # Numerical stats result + "numericalStatsResult": { # Result of the numerical stats computation. # Output only. Numerical stats result "maxValue": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Maximum value appearing in the column. "booleanValue": True or False, # boolean "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # date @@ -8154,9 +8154,9 @@

Method Details

], }, "requestedOptions": { # Risk analysis options. # The configuration used for this job. - "jobConfig": { # Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. + "jobConfig": { # Configuration for a risk analysis job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. "actions": [ # Actions to execute at the completion of the job. Are executed in the order provided. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -8175,14 +8175,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -8239,7 +8239,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -8291,7 +8291,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -8360,7 +8360,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -8412,7 +8412,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -8452,10 +8452,10 @@

Method Details

list(parent, filter=None, locationId=None, orderBy=None, pageSize=None, pageToken=None, type=None, x__xgafv=None) -
Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
+  
Lists DlpJobs that match the specified filter in the request. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`
@@ -8477,7 +8477,7 @@ 

Method Details

{ # The response message for listing DLP jobs. "jobs": [ # A list of DlpJobs that matches the specified filter in the request. { # Combines all of the information about a DLP job. - "actionDetails": [ # Events that should occur after the job has completed. + "actionDetails": [ # Output only. Events that should occur after the job has completed. { # The results of an Action. "deidentifyDetails": { # The results of a Deidentify action from an inspect job. # Outcome of a de-identification action. "deidentifyStats": { # Summary of what was modified during a transformation. # Stats about the de-identification operation. @@ -8486,7 +8486,7 @@

Method Details

"transformedBytes": "A String", # Total size in bytes that were transformed in some way. }, "requestedOptions": { # De-identification options. # De-identification config used for the request. - "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. + "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -8504,7 +8504,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -8520,7 +8520,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -8528,7 +8528,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -8607,7 +8607,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -8619,16 +8619,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -8640,13 +8640,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -8659,20 +8659,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -8686,7 +8686,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -8751,7 +8751,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -8813,7 +8813,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -8821,7 +8821,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -8900,7 +8900,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -8912,16 +8912,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -8933,13 +8933,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -8952,20 +8952,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -8979,7 +8979,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -9044,7 +9044,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -9060,7 +9060,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -9139,7 +9139,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9151,16 +9151,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9172,13 +9172,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9191,20 +9191,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9218,7 +9218,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -9283,7 +9283,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -9348,7 +9348,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -9366,7 +9366,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -9382,7 +9382,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -9390,7 +9390,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -9469,7 +9469,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9481,16 +9481,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9502,13 +9502,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9521,20 +9521,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9548,7 +9548,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -9613,7 +9613,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -9675,7 +9675,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -9683,7 +9683,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -9762,7 +9762,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9774,16 +9774,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9795,13 +9795,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9814,20 +9814,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9841,7 +9841,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -9906,7 +9906,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -9922,7 +9922,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -10001,7 +10001,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10013,16 +10013,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10034,13 +10034,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10053,20 +10053,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10080,7 +10080,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -10145,7 +10145,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -10210,7 +10210,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -10228,7 +10228,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -10244,7 +10244,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -10252,7 +10252,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -10331,7 +10331,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10343,16 +10343,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10364,13 +10364,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10383,20 +10383,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10410,7 +10410,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -10475,7 +10475,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -10537,7 +10537,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -10545,7 +10545,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -10624,7 +10624,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10636,16 +10636,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10657,13 +10657,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10676,20 +10676,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10703,7 +10703,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -10768,7 +10768,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -10784,7 +10784,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -10863,7 +10863,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10875,16 +10875,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10896,13 +10896,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10915,20 +10915,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10942,7 +10942,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -11007,7 +11007,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -11099,7 +11099,7 @@

Method Details

"requestedOptions": { # Snapshot of the inspection configuration. # The configuration used for this job. "jobConfig": { # Controls what and how to inspect for findings. # Inspect config. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -11118,14 +11118,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -11150,7 +11150,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -11165,14 +11165,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -11198,7 +11198,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -11222,15 +11222,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -11241,7 +11241,7 @@

Method Details

"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://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}`. + "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. }, @@ -11253,11 +11253,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -11270,7 +11270,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -11289,9 +11289,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -11303,7 +11303,7 @@

Method Details

"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://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}`. + "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. }, @@ -11319,7 +11319,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -11338,7 +11338,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -11350,9 +11350,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -11363,7 +11363,7 @@

Method Details

"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://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}`. + "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. }, @@ -11390,9 +11390,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -11419,7 +11419,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -11428,8 +11428,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -11474,16 +11474,16 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, - "snapshotInspectTemplate": { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. + "snapshotInspectTemplate": { # 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. # Output only. If run with an InspectTemplate, a snapshot of its state at the time of this run. "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). @@ -11492,7 +11492,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -11507,14 +11507,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -11540,7 +11540,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -11564,15 +11564,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -11583,7 +11583,7 @@

Method Details

"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://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}`. + "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. }, @@ -11595,11 +11595,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -11612,7 +11612,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -11631,9 +11631,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -11645,7 +11645,7 @@

Method Details

"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://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}`. + "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. }, @@ -11661,7 +11661,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -11680,7 +11680,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -11692,9 +11692,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -11705,7 +11705,7 @@

Method Details

"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://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}`. + "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. }, @@ -11732,9 +11732,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -11746,7 +11746,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, }, - "result": { # All Result fields are updated while the job is processing. # A summary of the outcome of this inspection job. + "result": { # All Result fields are updated while the job is processing. # Output only. A summary of the outcome of this inspection job. "hybridStats": { # Statistics related to processing hybrid inspect requests. # Statistics related to the processing of hybrid inspect. "abortedCount": "A String", # The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed. "pendingCount": "A String", # The number of hybrid requests currently being processed. Only populated when called via method `getDlpJob`. A burst of traffic may cause hybrid inspect requests to be enqueued. Processing will take place as quickly as possible, but resource limitations may impact how long a request is enqueued for. @@ -11756,7 +11756,7 @@

Method Details

{ # Statistics regarding a specific InfoType. "count": "A String", # Number of findings for this infoType. "infoType": { # Type of information detected by the API. # The type of finding this stat is for. - "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://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}`. + "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. }, @@ -11773,7 +11773,7 @@

Method Details

"lastModified": "A String", # Output only. Time when the job was last modified by the system. "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. - "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result + "categoricalStatsResult": { # Result of the categorical stats computation. # Output only. Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. { # Histogram of value frequencies in the column. "bucketSize": "A String", # Total number of values in this bucket. @@ -11807,7 +11807,7 @@

Method Details

}, ], }, - "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Delta-presence result + "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Output only. Delta-presence result "deltaPresenceEstimationHistogram": [ # The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. { # A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset. "bucketSize": "A String", # Number of records within these probability bounds. @@ -11843,7 +11843,7 @@

Method Details

}, ], }, - "kAnonymityResult": { # Result of the k-anonymity computation. # K-anonymity result + "kAnonymityResult": { # Result of the k-anonymity computation. # Output only. K-anonymity result "equivalenceClassHistogramBuckets": [ # Histogram of k-anonymity equivalence classes. { # Histogram of k-anonymity equivalence classes. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -11879,7 +11879,7 @@

Method Details

}, ], }, - "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # K-map result + "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # Output only. K-map result "kMapEstimationHistogram": [ # The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10. { # A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records. "bucketSize": "A String", # Number of records within these anonymity bounds. @@ -11915,7 +11915,7 @@

Method Details

}, ], }, - "lDiversityResult": { # Result of the l-diversity computation. # L-divesity result + "lDiversityResult": { # Result of the l-diversity computation. # Output only. L-divesity result "sensitiveValueFrequencyHistogramBuckets": [ # Histogram of l-diversity equivalence class sensitive value frequencies. { # Histogram of l-diversity equivalence class sensitive value frequencies. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -11976,7 +11976,7 @@

Method Details

}, ], }, - "numericalStatsResult": { # Result of the numerical stats computation. # Numerical stats result + "numericalStatsResult": { # Result of the numerical stats computation. # Output only. Numerical stats result "maxValue": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Maximum value appearing in the column. "booleanValue": True or False, # boolean "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # date @@ -12038,9 +12038,9 @@

Method Details

], }, "requestedOptions": { # Risk analysis options. # The configuration used for this job. - "jobConfig": { # Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. + "jobConfig": { # Configuration for a risk analysis job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. "actions": [ # Actions to execute at the completion of the job. Are executed in the order provided. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -12059,14 +12059,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -12123,7 +12123,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -12175,7 +12175,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -12244,7 +12244,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -12296,7 +12296,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, diff --git a/docs/dyn/dlp_v2.projects.image.html b/docs/dyn/dlp_v2.projects.image.html index 5c1c9f507e..fdb44eb045 100644 --- a/docs/dyn/dlp_v2.projects.image.html +++ b/docs/dyn/dlp_v2.projects.image.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.

+

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://docs.cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.

Method Details

close() @@ -88,10 +88,10 @@

Method Details

redact(parent, body=None, x__xgafv=None) -
Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.
+  
Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://docs.cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.
 
 Args:
-  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -104,7 +104,7 @@ 

Method Details

"imageRedactionConfigs": [ # The configuration for specifying what content to redact from images. { # Configuration for determining how redaction of images should occur. "infoType": { # Type of information detected by the API. # Only one per info_type should be provided per request. If not specified, and redact_all_text is false, the DLP API will redact all text that it matches against all info_types that are found, but not specified in another ImageRedactionConfig. - "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://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}`. + "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. }, @@ -123,7 +123,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -138,14 +138,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -171,7 +171,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -195,15 +195,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -214,7 +214,7 @@

Method Details

"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://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}`. + "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. }, @@ -226,11 +226,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -243,7 +243,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -262,9 +262,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -276,7 +276,7 @@

Method Details

"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://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}`. + "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. }, @@ -292,7 +292,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -311,7 +311,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -323,9 +323,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -336,7 +336,7 @@

Method Details

"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://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}`. + "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. }, @@ -363,9 +363,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -393,7 +393,7 @@

Method Details

"createTime": "A String", # Timestamp when finding was detected. "findingId": "A String", # The unique finding id. "infoType": { # Type of information detected by the API. # The type of content that might have been found. Provided if `excluded_types` is false. - "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://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}`. + "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. }, diff --git a/docs/dyn/dlp_v2.projects.inspectTemplates.html b/docs/dyn/dlp_v2.projects.inspectTemplates.html index b0bcfbb106..b1ff7e766c 100644 --- a/docs/dyn/dlp_v2.projects.inspectTemplates.html +++ b/docs/dyn/dlp_v2.projects.inspectTemplates.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

delete(name, x__xgafv=None)

-

Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Deletes an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

get(name, x__xgafv=None)

-

Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Updates the InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

Method Details

close() @@ -103,15 +103,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateInspectTemplate.
-  "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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The InspectTemplate to create.
+  "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. # Required. The InspectTemplate to create.
     "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).
@@ -120,7 +120,7 @@ 

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -135,14 +135,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -168,7 +168,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -192,15 +192,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -211,7 +211,7 @@

Method Details

"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://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}`. + "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. }, @@ -223,11 +223,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -240,7 +240,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -259,9 +259,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -273,7 +273,7 @@

Method Details

"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://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}`. + "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. }, @@ -289,7 +289,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -308,7 +308,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -320,9 +320,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -333,7 +333,7 @@

Method Details

"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://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}`. + "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. }, @@ -360,9 +360,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -385,7 +385,7 @@

Method Details

Returns: An object of the form: - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -394,7 +394,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -409,14 +409,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -442,7 +442,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -466,15 +466,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -485,7 +485,7 @@

Method Details

"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://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}`. + "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. }, @@ -497,11 +497,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -514,7 +514,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -533,9 +533,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -547,7 +547,7 @@

Method Details

"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://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}`. + "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. }, @@ -563,7 +563,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -582,7 +582,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -594,9 +594,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -607,7 +607,7 @@

Method Details

"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://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}`. + "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. }, @@ -634,9 +634,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -651,7 +651,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Deletes an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. (required)
@@ -669,7 +669,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. (required)
@@ -681,7 +681,7 @@ 

Method Details

Returns: An object of the form: - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -690,7 +690,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -705,14 +705,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -738,7 +738,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -762,15 +762,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -781,7 +781,7 @@

Method Details

"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://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}`. + "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. }, @@ -793,11 +793,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -810,7 +810,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -829,9 +829,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -843,7 +843,7 @@

Method Details

"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://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}`. + "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. }, @@ -859,7 +859,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -878,7 +878,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -890,9 +890,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -903,7 +903,7 @@

Method Details

"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://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}`. + "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. }, @@ -930,9 +930,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -947,10 +947,10 @@

Method Details

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -965,7 +965,7 @@ 

Method Details

{ # Response message for ListInspectTemplates. "inspectTemplates": [ # List of inspectTemplates, up to page_size in ListInspectTemplatesRequest. - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -974,7 +974,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -989,14 +989,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1022,7 +1022,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1046,15 +1046,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1065,7 +1065,7 @@

Method Details

"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://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}`. + "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. }, @@ -1077,11 +1077,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1094,7 +1094,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1113,9 +1113,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1127,7 +1127,7 @@

Method Details

"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://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}`. + "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. }, @@ -1143,7 +1143,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1162,7 +1162,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1174,9 +1174,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1187,7 +1187,7 @@

Method Details

"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://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}`. + "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. }, @@ -1214,9 +1214,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1248,7 +1248,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Updates the InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
   name: string, Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. (required)
@@ -1256,7 +1256,7 @@ 

Method Details

The object takes the form of: { # Request message for UpdateInspectTemplate. - "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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New InspectTemplate value. + "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. # New InspectTemplate value. "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). @@ -1265,7 +1265,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1280,14 +1280,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1313,7 +1313,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1337,15 +1337,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1356,7 +1356,7 @@

Method Details

"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://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}`. + "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. }, @@ -1368,11 +1368,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1385,7 +1385,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1404,9 +1404,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1418,7 +1418,7 @@

Method Details

"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://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}`. + "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. }, @@ -1434,7 +1434,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1453,7 +1453,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1465,9 +1465,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1478,7 +1478,7 @@

Method Details

"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://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}`. + "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. }, @@ -1505,9 +1505,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1529,7 +1529,7 @@

Method Details

Returns: An object of the form: - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -1538,7 +1538,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1553,14 +1553,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1586,7 +1586,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1610,15 +1610,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1629,7 +1629,7 @@

Method Details

"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://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}`. + "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. }, @@ -1641,11 +1641,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1658,7 +1658,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1677,9 +1677,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1691,7 +1691,7 @@

Method Details

"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://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}`. + "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. }, @@ -1707,7 +1707,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1726,7 +1726,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1738,9 +1738,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1751,7 +1751,7 @@

Method Details

"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://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}`. + "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. }, @@ -1778,9 +1778,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html index 1c0f042034..a036fe616d 100644 --- a/docs/dyn/dlp_v2.projects.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.jobTriggers.html @@ -82,22 +82,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

delete(name, x__xgafv=None)

-

Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Deletes a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

get(name, x__xgafv=None)

-

Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Gets a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

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

-

Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Lists job triggers. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Updates a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

Method Details

activate(name, body=None, x__xgafv=None) @@ -120,7 +120,7 @@

Method Details

An object of the form: { # Combines all of the information about a DLP job. - "actionDetails": [ # Events that should occur after the job has completed. + "actionDetails": [ # Output only. Events that should occur after the job has completed. { # The results of an Action. "deidentifyDetails": { # The results of a Deidentify action from an inspect job. # Outcome of a de-identification action. "deidentifyStats": { # Summary of what was modified during a transformation. # Stats about the de-identification operation. @@ -129,7 +129,7 @@

Method Details

"transformedBytes": "A String", # Total size in bytes that were transformed in some way. }, "requestedOptions": { # De-identification options. # De-identification config used for the request. - "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. + "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -147,7 +147,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -163,7 +163,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -171,7 +171,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -250,7 +250,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -262,16 +262,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -283,13 +283,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -302,20 +302,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -329,7 +329,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -394,7 +394,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -456,7 +456,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -464,7 +464,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -543,7 +543,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -555,16 +555,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -576,13 +576,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -595,20 +595,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -622,7 +622,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -687,7 +687,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -703,7 +703,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -782,7 +782,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -794,16 +794,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -815,13 +815,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -834,20 +834,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -861,7 +861,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -926,7 +926,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -991,7 +991,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1009,7 +1009,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1025,7 +1025,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1033,7 +1033,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1112,7 +1112,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1124,16 +1124,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1145,13 +1145,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1164,20 +1164,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1191,7 +1191,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1256,7 +1256,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1318,7 +1318,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1326,7 +1326,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1405,7 +1405,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1417,16 +1417,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1438,13 +1438,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1457,20 +1457,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1484,7 +1484,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1549,7 +1549,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1565,7 +1565,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1644,7 +1644,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1656,16 +1656,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1677,13 +1677,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1696,20 +1696,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1723,7 +1723,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1788,7 +1788,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1853,7 +1853,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1871,7 +1871,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1887,7 +1887,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1895,7 +1895,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1974,7 +1974,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1986,16 +1986,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2007,13 +2007,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2026,20 +2026,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2053,7 +2053,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2118,7 +2118,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2180,7 +2180,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2188,7 +2188,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2267,7 +2267,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2279,16 +2279,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2300,13 +2300,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2319,20 +2319,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2346,7 +2346,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2411,7 +2411,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2427,7 +2427,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2506,7 +2506,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2518,16 +2518,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2539,13 +2539,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2558,20 +2558,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2585,7 +2585,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2650,7 +2650,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2742,7 +2742,7 @@

Method Details

"requestedOptions": { # Snapshot of the inspection configuration. # The configuration used for this job. "jobConfig": { # Controls what and how to inspect for findings. # Inspect config. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -2761,14 +2761,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -2793,7 +2793,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -2808,14 +2808,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -2841,7 +2841,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -2865,15 +2865,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -2884,7 +2884,7 @@

Method Details

"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://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}`. + "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. }, @@ -2896,11 +2896,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -2913,7 +2913,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -2932,9 +2932,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2946,7 +2946,7 @@

Method Details

"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://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}`. + "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. }, @@ -2962,7 +2962,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -2981,7 +2981,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -2993,9 +2993,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3006,7 +3006,7 @@

Method Details

"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://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}`. + "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. }, @@ -3033,9 +3033,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3062,7 +3062,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -3071,8 +3071,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -3117,16 +3117,16 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, - "snapshotInspectTemplate": { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. + "snapshotInspectTemplate": { # 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. # Output only. If run with an InspectTemplate, a snapshot of its state at the time of this run. "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). @@ -3135,7 +3135,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -3150,14 +3150,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -3183,7 +3183,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -3207,15 +3207,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -3226,7 +3226,7 @@

Method Details

"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://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}`. + "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. }, @@ -3238,11 +3238,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -3255,7 +3255,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -3274,9 +3274,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3288,7 +3288,7 @@

Method Details

"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://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}`. + "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. }, @@ -3304,7 +3304,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -3323,7 +3323,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -3335,9 +3335,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3348,7 +3348,7 @@

Method Details

"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://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}`. + "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. }, @@ -3375,9 +3375,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3389,7 +3389,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, }, - "result": { # All Result fields are updated while the job is processing. # A summary of the outcome of this inspection job. + "result": { # All Result fields are updated while the job is processing. # Output only. A summary of the outcome of this inspection job. "hybridStats": { # Statistics related to processing hybrid inspect requests. # Statistics related to the processing of hybrid inspect. "abortedCount": "A String", # The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed. "pendingCount": "A String", # The number of hybrid requests currently being processed. Only populated when called via method `getDlpJob`. A burst of traffic may cause hybrid inspect requests to be enqueued. Processing will take place as quickly as possible, but resource limitations may impact how long a request is enqueued for. @@ -3399,7 +3399,7 @@

Method Details

{ # Statistics regarding a specific InfoType. "count": "A String", # Number of findings for this infoType. "infoType": { # Type of information detected by the API. # The type of finding this stat is for. - "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://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}`. + "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. }, @@ -3416,7 +3416,7 @@

Method Details

"lastModified": "A String", # Output only. Time when the job was last modified by the system. "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. - "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result + "categoricalStatsResult": { # Result of the categorical stats computation. # Output only. Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. { # Histogram of value frequencies in the column. "bucketSize": "A String", # Total number of values in this bucket. @@ -3450,7 +3450,7 @@

Method Details

}, ], }, - "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Delta-presence result + "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Output only. Delta-presence result "deltaPresenceEstimationHistogram": [ # The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. { # A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset. "bucketSize": "A String", # Number of records within these probability bounds. @@ -3486,7 +3486,7 @@

Method Details

}, ], }, - "kAnonymityResult": { # Result of the k-anonymity computation. # K-anonymity result + "kAnonymityResult": { # Result of the k-anonymity computation. # Output only. K-anonymity result "equivalenceClassHistogramBuckets": [ # Histogram of k-anonymity equivalence classes. { # Histogram of k-anonymity equivalence classes. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -3522,7 +3522,7 @@

Method Details

}, ], }, - "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # K-map result + "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # Output only. K-map result "kMapEstimationHistogram": [ # The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10. { # A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records. "bucketSize": "A String", # Number of records within these anonymity bounds. @@ -3558,7 +3558,7 @@

Method Details

}, ], }, - "lDiversityResult": { # Result of the l-diversity computation. # L-divesity result + "lDiversityResult": { # Result of the l-diversity computation. # Output only. L-divesity result "sensitiveValueFrequencyHistogramBuckets": [ # Histogram of l-diversity equivalence class sensitive value frequencies. { # Histogram of l-diversity equivalence class sensitive value frequencies. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -3619,7 +3619,7 @@

Method Details

}, ], }, - "numericalStatsResult": { # Result of the numerical stats computation. # Numerical stats result + "numericalStatsResult": { # Result of the numerical stats computation. # Output only. Numerical stats result "maxValue": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Maximum value appearing in the column. "booleanValue": True or False, # boolean "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # date @@ -3681,9 +3681,9 @@

Method Details

], }, "requestedOptions": { # Risk analysis options. # The configuration used for this job. - "jobConfig": { # Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. + "jobConfig": { # Configuration for a risk analysis job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. "actions": [ # Actions to execute at the completion of the job. Are executed in the order provided. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -3702,14 +3702,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -3766,7 +3766,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -3818,7 +3818,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -3887,7 +3887,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -3939,7 +3939,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -3984,15 +3984,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateJobTrigger.
-  "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create.
+  "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create.
     "createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
     "description": "A String", # User provided description (max 256 chars)
     "displayName": "A String", # Display name (max 100 chars)
@@ -4015,7 +4015,7 @@ 

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -4034,14 +4034,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -4066,7 +4066,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -4081,14 +4081,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -4114,7 +4114,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -4138,15 +4138,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -4157,7 +4157,7 @@

Method Details

"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://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}`. + "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. }, @@ -4169,11 +4169,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -4186,7 +4186,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -4205,9 +4205,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -4219,7 +4219,7 @@

Method Details

"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://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}`. + "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. }, @@ -4235,7 +4235,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -4254,7 +4254,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -4266,9 +4266,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -4279,7 +4279,7 @@

Method Details

"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://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}`. + "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. }, @@ -4306,9 +4306,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -4335,7 +4335,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -4344,8 +4344,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -4390,17 +4390,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -4425,7 +4425,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -4448,7 +4448,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -4467,14 +4467,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -4499,7 +4499,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -4514,14 +4514,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -4547,7 +4547,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -4571,15 +4571,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -4590,7 +4590,7 @@

Method Details

"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://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}`. + "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. }, @@ -4602,11 +4602,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -4619,7 +4619,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -4638,9 +4638,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -4652,7 +4652,7 @@

Method Details

"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://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}`. + "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. }, @@ -4668,7 +4668,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -4687,7 +4687,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -4699,9 +4699,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -4712,7 +4712,7 @@

Method Details

"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://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}`. + "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. }, @@ -4739,9 +4739,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -4768,7 +4768,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -4777,8 +4777,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -4823,17 +4823,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -4850,7 +4850,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Deletes a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
   name: string, Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)
@@ -4868,7 +4868,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Gets a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
   name: string, Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)
@@ -4880,7 +4880,7 @@ 

Method Details

Returns: An object of the form: - { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -4903,7 +4903,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -4922,14 +4922,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -4954,7 +4954,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -4969,14 +4969,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -5002,7 +5002,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -5026,15 +5026,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -5045,7 +5045,7 @@

Method Details

"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://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}`. + "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. }, @@ -5057,11 +5057,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -5074,7 +5074,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -5093,9 +5093,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -5107,7 +5107,7 @@

Method Details

"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://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}`. + "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. }, @@ -5123,7 +5123,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -5142,7 +5142,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -5154,9 +5154,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -5167,7 +5167,7 @@

Method Details

"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://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}`. + "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. }, @@ -5194,9 +5194,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -5223,7 +5223,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -5232,8 +5232,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -5278,17 +5278,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -5305,10 +5305,10 @@

Method Details

list(parent, filter=None, locationId=None, orderBy=None, pageSize=None, pageToken=None, type=None, x__xgafv=None) -
Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Lists job triggers. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.
@@ -5329,7 +5329,7 @@ 

Method Details

{ # Response message for ListJobTriggers. "jobTriggers": [ # List of triggeredJobs, up to page_size in ListJobTriggersRequest. - { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -5352,7 +5352,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -5371,14 +5371,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -5403,7 +5403,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -5418,14 +5418,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -5451,7 +5451,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -5475,15 +5475,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -5494,7 +5494,7 @@

Method Details

"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://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}`. + "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. }, @@ -5506,11 +5506,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -5523,7 +5523,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -5542,9 +5542,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -5556,7 +5556,7 @@

Method Details

"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://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}`. + "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. }, @@ -5572,7 +5572,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -5591,7 +5591,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -5603,9 +5603,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -5616,7 +5616,7 @@

Method Details

"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://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}`. + "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. }, @@ -5643,9 +5643,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -5672,7 +5672,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -5681,8 +5681,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -5727,17 +5727,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -5771,7 +5771,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Updates a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
   name: string, Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)
@@ -5779,7 +5779,7 @@ 

Method Details

The object takes the form of: { # Request message for UpdateJobTrigger. - "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value. + "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -5802,7 +5802,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -5821,14 +5821,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -5853,7 +5853,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -5868,14 +5868,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -5901,7 +5901,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -5925,15 +5925,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -5944,7 +5944,7 @@

Method Details

"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://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}`. + "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. }, @@ -5956,11 +5956,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -5973,7 +5973,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -5992,9 +5992,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -6006,7 +6006,7 @@

Method Details

"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://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}`. + "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. }, @@ -6022,7 +6022,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -6041,7 +6041,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -6053,9 +6053,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -6066,7 +6066,7 @@

Method Details

"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://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}`. + "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. }, @@ -6093,9 +6093,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -6122,7 +6122,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -6131,8 +6131,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -6177,17 +6177,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -6211,7 +6211,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -6234,7 +6234,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -6253,14 +6253,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -6285,7 +6285,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -6300,14 +6300,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -6333,7 +6333,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -6357,15 +6357,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -6376,7 +6376,7 @@

Method Details

"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://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}`. + "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. }, @@ -6388,11 +6388,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -6405,7 +6405,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -6424,9 +6424,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -6438,7 +6438,7 @@

Method Details

"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://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}`. + "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. }, @@ -6454,7 +6454,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -6473,7 +6473,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -6485,9 +6485,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -6498,7 +6498,7 @@

Method Details

"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://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}`. + "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. }, @@ -6525,9 +6525,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -6554,7 +6554,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -6563,8 +6563,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -6609,17 +6609,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. diff --git a/docs/dyn/dlp_v2.projects.locations.columnDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.columnDataProfiles.html index 521850701b..081d0e9556 100644 --- a/docs/dyn/dlp_v2.projects.locations.columnDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.columnDataProfiles.html @@ -111,7 +111,7 @@

Method Details

"columnInfoType": { # The infoType details for this column. # If it's been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types. "estimatedPrevalence": 42, # Not populated for predicted infotypes. "infoType": { # Type of information detected by the API. # The infoType. - "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://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}`. + "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. }, @@ -123,7 +123,7 @@

Method Details

"score": "A String", # The score applied to the resource. }, "datasetId": "A String", # The BigQuery dataset ID, if the resource profiled is a BigQuery table. - "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations. + "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://docs.cloud.google.com/bigquery/docs/locations for supported BigQuery locations. "datasetProjectId": "A String", # The Google Cloud project ID that owns the profiled resource. "estimatedNullPercentage": "A String", # Approximate percentage of entries being null in the column. "estimatedUniquenessScore": "A String", # Approximate uniqueness of the column. @@ -134,7 +134,7 @@

Method Details

"estimatedPrevalence": 42, # Approximate percentage of non-null rows that contained data detected by this infotype. "excludedFromAnalysis": True or False, # Whether this infoType was excluded from sensitivity and risk analysis due to factors such as low prevalence (subject to change). "infoType": { # Type of information detected by the API. # The other infoType. - "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://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}`. + "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. }, @@ -191,7 +191,7 @@

Method Details

"columnInfoType": { # The infoType details for this column. # If it's been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types. "estimatedPrevalence": 42, # Not populated for predicted infotypes. "infoType": { # Type of information detected by the API. # The infoType. - "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://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}`. + "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. }, @@ -203,7 +203,7 @@

Method Details

"score": "A String", # The score applied to the resource. }, "datasetId": "A String", # The BigQuery dataset ID, if the resource profiled is a BigQuery table. - "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations. + "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://docs.cloud.google.com/bigquery/docs/locations for supported BigQuery locations. "datasetProjectId": "A String", # The Google Cloud project ID that owns the profiled resource. "estimatedNullPercentage": "A String", # Approximate percentage of entries being null in the column. "estimatedUniquenessScore": "A String", # Approximate uniqueness of the column. @@ -214,7 +214,7 @@

Method Details

"estimatedPrevalence": 42, # Approximate percentage of non-null rows that contained data detected by this infotype. "excludedFromAnalysis": True or False, # Whether this infoType was excluded from sensitivity and risk analysis due to factors such as low prevalence (subject to change). "infoType": { # Type of information detected by the API. # The other infoType. - "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://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}`. + "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. }, diff --git a/docs/dyn/dlp_v2.projects.locations.connections.html b/docs/dyn/dlp_v2.projects.locations.connections.html index bdf9ceeb19..6d4cccc8e7 100644 --- a/docs/dyn/dlp_v2.projects.locations.connections.html +++ b/docs/dyn/dlp_v2.projects.locations.connections.html @@ -119,7 +119,7 @@

Method Details

{ # Request message for CreateConnection. "connection": { # A data connection to allow the DLP API to profile data in locations that require additional configuration. # Required. The connection resource. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. @@ -161,7 +161,7 @@

Method Details

{ # A data connection to allow the DLP API to profile data in locations that require additional configuration. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. @@ -227,7 +227,7 @@

Method Details

{ # A data connection to allow the DLP API to profile data in locations that require additional configuration. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. @@ -280,7 +280,7 @@

Method Details

"connections": [ # List of connections. { # A data connection to allow the DLP API to profile data in locations that require additional configuration. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. @@ -341,7 +341,7 @@

Method Details

{ # Request message for UpdateConnection. "connection": { # A data connection to allow the DLP API to profile data in locations that require additional configuration. # Required. The connection with new values for the relevant fields. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. @@ -384,7 +384,7 @@

Method Details

{ # A data connection to allow the DLP API to profile data in locations that require additional configuration. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. @@ -437,7 +437,7 @@

Method Details

"connections": [ # List of connections that match the search query. Note that only a subset of the fields will be populated, and only "name" is guaranteed to be set. For full details of a Connection, call GetConnection with the name. { # A data connection to allow the DLP API to profile data in locations that require additional configuration. "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance. - "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). + "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL). }, "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures. diff --git a/docs/dyn/dlp_v2.projects.locations.content.html b/docs/dyn/dlp_v2.projects.locations.content.html index ef9751b682..0ec1c249c1 100644 --- a/docs/dyn/dlp_v2.projects.locations.content.html +++ b/docs/dyn/dlp_v2.projects.locations.content.html @@ -79,13 +79,13 @@

Instance Methods

Close httplib2 connections.

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

-

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

+

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://docs.cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

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

-

Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,

+

Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text,

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

-

Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.

+

Re-identifies content that has been de-identified. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.

Method Details

close() @@ -94,10 +94,10 @@

Method Details

deidentify(parent, body=None, x__xgafv=None) -
De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
+  
De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://docs.cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
 
 Args:
-  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -118,7 +118,7 @@ 

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -134,7 +134,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -142,7 +142,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -221,7 +221,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -233,16 +233,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -254,13 +254,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -273,20 +273,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -300,7 +300,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -365,7 +365,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -427,7 +427,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -435,7 +435,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -514,7 +514,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -526,16 +526,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -547,13 +547,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -566,20 +566,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -593,7 +593,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -658,7 +658,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -674,7 +674,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -753,7 +753,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -765,16 +765,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -786,13 +786,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -805,20 +805,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -832,7 +832,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -897,7 +897,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -962,7 +962,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -977,14 +977,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1010,7 +1010,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1034,15 +1034,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1053,7 +1053,7 @@

Method Details

"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://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}`. + "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. }, @@ -1065,11 +1065,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1082,7 +1082,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1101,9 +1101,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1115,7 +1115,7 @@

Method Details

"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://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}`. + "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. }, @@ -1131,7 +1131,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1150,7 +1150,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1162,9 +1162,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1175,7 +1175,7 @@

Method Details

"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://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}`. + "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. }, @@ -1202,9 +1202,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1276,7 +1276,7 @@

Method Details

}, ], }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -1385,7 +1385,7 @@

Method Details

}, ], }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -1471,7 +1471,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1479,7 +1479,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1558,7 +1558,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1570,16 +1570,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1591,13 +1591,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1610,20 +1610,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1637,7 +1637,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1702,7 +1702,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1718,7 +1718,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1797,7 +1797,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1809,16 +1809,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1830,13 +1830,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1849,20 +1849,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1876,7 +1876,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1941,7 +1941,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1956,7 +1956,7 @@

Method Details

}, ], "infoType": { # Type of information detected by the API. # Set if the transformation was limited to a specific InfoType. - "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://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}`. + "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. }, @@ -2006,7 +2006,7 @@

Method Details

}, ], "transformation": { # A rule for transforming a value. # The specific transformation these stats apply to. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2085,7 +2085,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2097,16 +2097,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2118,13 +2118,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2137,20 +2137,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2164,7 +2164,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2229,7 +2229,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2251,10 +2251,10 @@

Method Details

inspect(parent, body=None, x__xgafv=None) -
Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,
+  
Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text,
 
 Args:
-  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -2263,7 +2263,7 @@ 

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -2278,14 +2278,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -2311,7 +2311,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -2335,15 +2335,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -2354,7 +2354,7 @@

Method Details

"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://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}`. + "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. }, @@ -2366,11 +2366,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -2383,7 +2383,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -2402,9 +2402,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2416,7 +2416,7 @@

Method Details

"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://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}`. + "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. }, @@ -2432,7 +2432,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -2451,7 +2451,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -2463,9 +2463,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2476,7 +2476,7 @@

Method Details

"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://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}`. + "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. }, @@ -2503,9 +2503,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -2577,7 +2577,7 @@

Method Details

}, ], }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -2629,7 +2629,7 @@

Method Details

"createTime": "A String", # Timestamp when finding was detected. "findingId": "A String", # The unique finding id. "infoType": { # Type of information detected by the API. # The type of content that might have been found. Provided if `excluded_types` is false. - "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://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}`. + "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. }, @@ -2765,10 +2765,10 @@

Method Details

reidentify(parent, body=None, x__xgafv=None) -
Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.
+  
Re-identifies content that has been de-identified. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -2777,7 +2777,7 @@ 

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -2792,14 +2792,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -2825,7 +2825,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -2849,15 +2849,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -2868,7 +2868,7 @@

Method Details

"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://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}`. + "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. }, @@ -2880,11 +2880,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -2897,7 +2897,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -2916,9 +2916,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2930,7 +2930,7 @@

Method Details

"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://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}`. + "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. }, @@ -2946,7 +2946,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -2965,7 +2965,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -2977,9 +2977,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2990,7 +2990,7 @@

Method Details

"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://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}`. + "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. }, @@ -3017,9 +3017,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3091,7 +3091,7 @@

Method Details

}, ], }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -3142,7 +3142,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -3158,7 +3158,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3166,7 +3166,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3245,7 +3245,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3257,16 +3257,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3278,13 +3278,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3297,20 +3297,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3324,7 +3324,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3389,7 +3389,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3451,7 +3451,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3459,7 +3459,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3538,7 +3538,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3550,16 +3550,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3571,13 +3571,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3590,20 +3590,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3617,7 +3617,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3682,7 +3682,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3698,7 +3698,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3777,7 +3777,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3789,16 +3789,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3810,13 +3810,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3829,20 +3829,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3856,7 +3856,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3921,7 +3921,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4056,7 +4056,7 @@

Method Details

}, ], }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -4142,7 +4142,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4150,7 +4150,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4229,7 +4229,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4241,16 +4241,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4262,13 +4262,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4281,20 +4281,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4308,7 +4308,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4373,7 +4373,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4389,7 +4389,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4468,7 +4468,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4480,16 +4480,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4501,13 +4501,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4520,20 +4520,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4547,7 +4547,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4612,7 +4612,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4627,7 +4627,7 @@

Method Details

}, ], "infoType": { # Type of information detected by the API. # Set if the transformation was limited to a specific InfoType. - "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://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}`. + "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. }, @@ -4677,7 +4677,7 @@

Method Details

}, ], "transformation": { # A rule for transforming a value. # The specific transformation these stats apply to. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4756,7 +4756,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4768,16 +4768,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4789,13 +4789,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4808,20 +4808,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4835,7 +4835,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4900,7 +4900,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], diff --git a/docs/dyn/dlp_v2.projects.locations.contentPolicies.html b/docs/dyn/dlp_v2.projects.locations.contentPolicies.html index 66f51f6717..4847b685c0 100644 --- a/docs/dyn/dlp_v2.projects.locations.contentPolicies.html +++ b/docs/dyn/dlp_v2.projects.locations.contentPolicies.html @@ -144,7 +144,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -159,14 +159,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -192,7 +192,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -216,15 +216,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -235,7 +235,7 @@

Method Details

"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://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}`. + "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. }, @@ -247,11 +247,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -264,7 +264,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -283,9 +283,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -297,7 +297,7 @@

Method Details

"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://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}`. + "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. }, @@ -313,7 +313,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -332,7 +332,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -344,9 +344,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -357,7 +357,7 @@

Method Details

"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://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}`. + "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. }, @@ -384,9 +384,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -394,7 +394,7 @@

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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Optional. InspectTemplate to use to produce findings. Deprecated: use inspect_config instead. + "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). @@ -403,7 +403,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -418,14 +418,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -451,7 +451,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -475,15 +475,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -494,7 +494,7 @@

Method Details

"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://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}`. + "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. }, @@ -506,11 +506,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -523,7 +523,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -542,9 +542,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -556,7 +556,7 @@

Method Details

"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://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}`. + "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. }, @@ -572,7 +572,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -591,7 +591,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -603,9 +603,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -616,7 +616,7 @@

Method Details

"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://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}`. + "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. }, @@ -643,9 +643,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -681,6 +681,7 @@

Method Details

"A String", ], }, + "minCount": "A String", # Optional. The minimum total number of findings of all matching info types required for this condition to evaluate to true. Defaults to 1 if unset. }, }, ], @@ -736,7 +737,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -751,14 +752,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -784,7 +785,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -808,15 +809,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -827,7 +828,7 @@

Method Details

"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://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}`. + "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. }, @@ -839,11 +840,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -856,7 +857,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -875,9 +876,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -889,7 +890,7 @@

Method Details

"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://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}`. + "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. }, @@ -905,7 +906,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -924,7 +925,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -936,9 +937,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -949,7 +950,7 @@

Method Details

"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://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}`. + "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. }, @@ -976,9 +977,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -986,7 +987,7 @@

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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Optional. InspectTemplate to use to produce findings. Deprecated: use inspect_config instead. + "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). @@ -995,7 +996,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1010,14 +1011,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1043,7 +1044,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1067,15 +1068,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1086,7 +1087,7 @@

Method Details

"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://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}`. + "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. }, @@ -1098,11 +1099,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1115,7 +1116,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1134,9 +1135,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1148,7 +1149,7 @@

Method Details

"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://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}`. + "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. }, @@ -1164,7 +1165,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1183,7 +1184,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1195,9 +1196,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1208,7 +1209,7 @@

Method Details

"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://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}`. + "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. }, @@ -1235,9 +1236,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1273,6 +1274,7 @@

Method Details

"A String", ], }, + "minCount": "A String", # Optional. The minimum total number of findings of all matching info types required for this condition to evaluate to true. Defaults to 1 if unset. }, }, ], @@ -1351,7 +1353,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1366,14 +1368,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1399,7 +1401,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1423,15 +1425,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1442,7 +1444,7 @@

Method Details

"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://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}`. + "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. }, @@ -1454,11 +1456,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1471,7 +1473,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1490,9 +1492,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1504,7 +1506,7 @@

Method Details

"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://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}`. + "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. }, @@ -1520,7 +1522,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1539,7 +1541,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1551,9 +1553,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1564,7 +1566,7 @@

Method Details

"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://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}`. + "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. }, @@ -1591,9 +1593,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1601,7 +1603,7 @@

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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Optional. InspectTemplate to use to produce findings. Deprecated: use inspect_config instead. + "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). @@ -1610,7 +1612,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1625,14 +1627,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1658,7 +1660,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1682,15 +1684,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1701,7 +1703,7 @@

Method Details

"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://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}`. + "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. }, @@ -1713,11 +1715,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1730,7 +1732,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1749,9 +1751,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1763,7 +1765,7 @@

Method Details

"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://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}`. + "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. }, @@ -1779,7 +1781,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1798,7 +1800,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1810,9 +1812,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1823,7 +1825,7 @@

Method Details

"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://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}`. + "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. }, @@ -1850,9 +1852,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1888,6 +1890,7 @@

Method Details

"A String", ], }, + "minCount": "A String", # Optional. The minimum total number of findings of all matching info types required for this condition to evaluate to true. Defaults to 1 if unset. }, }, ], @@ -1952,7 +1955,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1967,14 +1970,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -2000,7 +2003,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -2024,15 +2027,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -2043,7 +2046,7 @@

Method Details

"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://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}`. + "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. }, @@ -2055,11 +2058,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -2072,7 +2075,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -2091,9 +2094,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2105,7 +2108,7 @@

Method Details

"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://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}`. + "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. }, @@ -2121,7 +2124,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -2140,7 +2143,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -2152,9 +2155,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2165,7 +2168,7 @@

Method Details

"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://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}`. + "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. }, @@ -2192,9 +2195,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -2202,7 +2205,7 @@

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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Optional. InspectTemplate to use to produce findings. Deprecated: use inspect_config instead. + "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). @@ -2211,7 +2214,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -2226,14 +2229,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -2259,7 +2262,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -2283,15 +2286,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -2302,7 +2305,7 @@

Method Details

"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://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}`. + "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. }, @@ -2314,11 +2317,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -2331,7 +2334,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -2350,9 +2353,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2364,7 +2367,7 @@

Method Details

"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://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}`. + "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. }, @@ -2380,7 +2383,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -2399,7 +2402,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -2411,9 +2414,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2424,7 +2427,7 @@

Method Details

"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://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}`. + "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. }, @@ -2451,9 +2454,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -2489,6 +2492,7 @@

Method Details

"A String", ], }, + "minCount": "A String", # Optional. The minimum total number of findings of all matching info types required for this condition to evaluate to true. Defaults to 1 if unset. }, }, ], @@ -2562,7 +2566,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -2577,14 +2581,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -2610,7 +2614,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -2634,15 +2638,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -2653,7 +2657,7 @@

Method Details

"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://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}`. + "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. }, @@ -2665,11 +2669,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -2682,7 +2686,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -2701,9 +2705,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2715,7 +2719,7 @@

Method Details

"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://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}`. + "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. }, @@ -2731,7 +2735,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -2750,7 +2754,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -2762,9 +2766,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2775,7 +2779,7 @@

Method Details

"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://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}`. + "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. }, @@ -2802,9 +2806,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -2812,7 +2816,7 @@

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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Optional. InspectTemplate to use to produce findings. Deprecated: use inspect_config instead. + "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). @@ -2821,7 +2825,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -2836,14 +2840,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -2869,7 +2873,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -2893,15 +2897,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -2912,7 +2916,7 @@

Method Details

"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://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}`. + "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. }, @@ -2924,11 +2928,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -2941,7 +2945,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -2960,9 +2964,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2974,7 +2978,7 @@

Method Details

"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://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}`. + "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. }, @@ -2990,7 +2994,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -3009,7 +3013,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -3021,9 +3025,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3034,7 +3038,7 @@

Method Details

"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://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}`. + "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. }, @@ -3061,9 +3065,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3099,6 +3103,7 @@

Method Details

"A String", ], }, + "minCount": "A String", # Optional. The minimum total number of findings of all matching info types required for this condition to evaluate to true. Defaults to 1 if unset. }, }, ], @@ -3154,7 +3159,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -3169,14 +3174,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -3202,7 +3207,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -3226,15 +3231,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -3245,7 +3250,7 @@

Method Details

"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://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}`. + "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. }, @@ -3257,11 +3262,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -3274,7 +3279,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -3293,9 +3298,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3307,7 +3312,7 @@

Method Details

"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://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}`. + "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. }, @@ -3323,7 +3328,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -3342,7 +3347,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -3354,9 +3359,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3367,7 +3372,7 @@

Method Details

"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://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}`. + "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. }, @@ -3394,9 +3399,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3404,7 +3409,7 @@

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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Optional. InspectTemplate to use to produce findings. Deprecated: use inspect_config instead. + "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). @@ -3413,7 +3418,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -3428,14 +3433,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -3461,7 +3466,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -3485,15 +3490,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -3504,7 +3509,7 @@

Method Details

"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://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}`. + "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. }, @@ -3516,11 +3521,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -3533,7 +3538,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -3552,9 +3557,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3566,7 +3571,7 @@

Method Details

"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://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}`. + "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. }, @@ -3582,7 +3587,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -3601,7 +3606,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -3613,9 +3618,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3626,7 +3631,7 @@

Method Details

"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://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}`. + "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. }, @@ -3653,9 +3658,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3691,6 +3696,7 @@

Method Details

"A String", ], }, + "minCount": "A String", # Optional. The minimum total number of findings of all matching info types required for this condition to evaluate to true. Defaults to 1 if unset. }, }, ], diff --git a/docs/dyn/dlp_v2.projects.locations.deidentifyTemplates.html b/docs/dyn/dlp_v2.projects.locations.deidentifyTemplates.html index 995d68116c..22e3c1a50b 100644 --- a/docs/dyn/dlp_v2.projects.locations.deidentifyTemplates.html +++ b/docs/dyn/dlp_v2.projects.locations.deidentifyTemplates.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

delete(name, x__xgafv=None)

-

Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Deletes a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

get(name, x__xgafv=None)

-

Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Gets a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Lists DeidentifyTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

+

Updates the DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

Method Details

close() @@ -103,15 +103,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateDeidentifyTemplate.
-  "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The DeidentifyTemplate to create.
+  "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The DeidentifyTemplate to create.
     "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
     "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template.
       "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact.
@@ -129,7 +129,7 @@ 

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -145,7 +145,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -153,7 +153,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -232,7 +232,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -244,16 +244,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -265,13 +265,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -284,20 +284,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -311,7 +311,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -376,7 +376,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -438,7 +438,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -446,7 +446,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -525,7 +525,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -537,16 +537,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -558,13 +558,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -577,20 +577,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -604,7 +604,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -669,7 +669,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -685,7 +685,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -764,7 +764,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -776,16 +776,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -797,13 +797,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -816,20 +816,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -843,7 +843,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -908,7 +908,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -985,7 +985,7 @@

Method Details

Returns: An object of the form: - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1003,7 +1003,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1019,7 +1019,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1027,7 +1027,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1106,7 +1106,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1118,16 +1118,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1139,13 +1139,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1158,20 +1158,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1185,7 +1185,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1250,7 +1250,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1312,7 +1312,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1320,7 +1320,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1399,7 +1399,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1411,16 +1411,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1432,13 +1432,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1451,20 +1451,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1478,7 +1478,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1543,7 +1543,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1559,7 +1559,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1638,7 +1638,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1650,16 +1650,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1671,13 +1671,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1690,20 +1690,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1717,7 +1717,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1782,7 +1782,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1851,7 +1851,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Deletes a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. (required)
@@ -1869,7 +1869,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Gets a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. (required)
@@ -1881,7 +1881,7 @@ 

Method Details

Returns: An object of the form: - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1899,7 +1899,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1915,7 +1915,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1923,7 +1923,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2002,7 +2002,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2014,16 +2014,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2035,13 +2035,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2054,20 +2054,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2081,7 +2081,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2146,7 +2146,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2208,7 +2208,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2216,7 +2216,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2295,7 +2295,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2307,16 +2307,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2328,13 +2328,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2347,20 +2347,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2374,7 +2374,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2439,7 +2439,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2455,7 +2455,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2534,7 +2534,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2546,16 +2546,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2567,13 +2567,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2586,20 +2586,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2613,7 +2613,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2678,7 +2678,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2747,10 +2747,10 @@

Method Details

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Lists DeidentifyTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -2765,7 +2765,7 @@ 

Method Details

{ # Response message for ListDeidentifyTemplates. "deidentifyTemplates": [ # List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest. - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -2783,7 +2783,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -2799,7 +2799,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2807,7 +2807,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2886,7 +2886,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2898,16 +2898,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2919,13 +2919,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2938,20 +2938,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2965,7 +2965,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3030,7 +3030,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3092,7 +3092,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3100,7 +3100,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3179,7 +3179,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3191,16 +3191,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3212,13 +3212,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3231,20 +3231,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3258,7 +3258,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3323,7 +3323,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3339,7 +3339,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3418,7 +3418,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3430,16 +3430,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3451,13 +3451,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3470,20 +3470,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3497,7 +3497,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3562,7 +3562,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3648,7 +3648,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
+  
Updates the DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
   name: string, Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342. (required)
@@ -3656,7 +3656,7 @@ 

Method Details

The object takes the form of: { # Request message for UpdateDeidentifyTemplate. - "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New DeidentifyTemplate value. + "deidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New DeidentifyTemplate value. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -3674,7 +3674,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -3690,7 +3690,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3698,7 +3698,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3777,7 +3777,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3789,16 +3789,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3810,13 +3810,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3829,20 +3829,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3856,7 +3856,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3921,7 +3921,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3983,7 +3983,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -3991,7 +3991,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4070,7 +4070,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4082,16 +4082,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4103,13 +4103,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4122,20 +4122,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4149,7 +4149,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4214,7 +4214,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4230,7 +4230,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4309,7 +4309,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4321,16 +4321,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4342,13 +4342,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4361,20 +4361,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4388,7 +4388,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4453,7 +4453,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4529,7 +4529,7 @@

Method Details

Returns: An object of the form: - { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -4547,7 +4547,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -4563,7 +4563,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4571,7 +4571,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4650,7 +4650,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4662,16 +4662,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4683,13 +4683,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4702,20 +4702,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4729,7 +4729,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4794,7 +4794,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4856,7 +4856,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4864,7 +4864,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4943,7 +4943,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4955,16 +4955,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4976,13 +4976,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4995,20 +4995,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5022,7 +5022,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5087,7 +5087,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -5103,7 +5103,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -5182,7 +5182,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5194,16 +5194,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5215,13 +5215,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5234,20 +5234,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5261,7 +5261,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5326,7 +5326,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html index f300d8800d..49da9ddfc2 100644 --- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html @@ -112,11 +112,11 @@

Method Details

{ # Request message for CreateDiscoveryConfig. "configId": "A String", # The config ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. - "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # Required. The DiscoveryConfig to create. + "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # Required. The DiscoveryConfig to create. "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -143,15 +143,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -187,11 +187,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -354,7 +354,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -373,7 +373,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -423,7 +423,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -469,11 +469,11 @@

Method Details

Returns: An object of the form: - { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -500,15 +500,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -544,11 +544,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -711,7 +711,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -730,7 +730,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -780,7 +780,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -850,11 +850,11 @@

Method Details

Returns: An object of the form: - { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -881,15 +881,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -925,11 +925,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -1092,7 +1092,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -1111,7 +1111,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -1161,7 +1161,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -1218,11 +1218,11 @@

Method Details

{ # Response message for ListDiscoveryConfigs. "discoveryConfigs": [ # List of configs, up to page_size in ListDiscoveryConfigsRequest. - { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -1249,15 +1249,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -1293,11 +1293,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -1460,7 +1460,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -1479,7 +1479,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -1529,7 +1529,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -1594,11 +1594,11 @@

Method Details

The object takes the form of: { # Request message for UpdateDiscoveryConfig. - "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # Required. New DiscoveryConfig value. + "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # Required. New DiscoveryConfig value. "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -1625,15 +1625,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -1669,11 +1669,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -1836,7 +1836,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -1855,7 +1855,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -1905,7 +1905,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -1952,11 +1952,11 @@

Method Details

Returns: An object of the form: - { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -1983,15 +1983,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -2027,11 +2027,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -2194,7 +2194,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -2213,7 +2213,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -2263,7 +2263,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html index 7f72d9cbee..14e487a110 100644 --- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html @@ -76,35 +76,35 @@

Sensitive Data Protection (DLP) . cancel(name, body=None, x__xgafv=None)

-

Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

+

Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

close()

Close httplib2 connections.

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

-

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

+

Creates a new job to inspect storage or calculate risk metrics. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

delete(name, x__xgafv=None)

-

Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

+

Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

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

Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run.

get(name, x__xgafv=None)

-

Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

+

Gets the latest state of a long-running DlpJob. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

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

Inspect hybrid content and store findings to a job. To review the findings, inspect the job. Inspection will occur asynchronously.

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

-

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

+

Lists DlpJobs that match the specified filter in the request. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

list_next()

Retrieves the next page of results.

Method Details

cancel(name, body=None, x__xgafv=None) -
Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
+  
Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
 
 Args:
   name: string, Required. The name of the DlpJob resource to be cancelled. (required)
@@ -133,17 +133,17 @@ 

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
+  
Creates a new job to inspect storage or calculate risk metrics. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.
   "inspectJob": { # Controls what and how to inspect for findings. # An inspection job scans a storage repository for InfoTypes.
     "actions": [ # Actions to execute at the completion of the job.
-      { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more.
+      { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more.
         "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data.
           "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket
           "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV.
@@ -162,14 +162,14 @@ 

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -194,7 +194,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -209,14 +209,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -242,7 +242,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -266,15 +266,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -285,7 +285,7 @@

Method Details

"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://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}`. + "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. }, @@ -297,11 +297,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -314,7 +314,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -333,9 +333,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -347,7 +347,7 @@

Method Details

"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://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}`. + "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. }, @@ -363,7 +363,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -382,7 +382,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -394,9 +394,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -407,7 +407,7 @@

Method Details

"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://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}`. + "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. }, @@ -434,9 +434,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -463,7 +463,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -472,8 +472,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -518,10 +518,10 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -529,9 +529,9 @@

Method Details

}, "jobId": "A String", # The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. "locationId": "A String", # Deprecated. This field has no effect. - "riskJob": { # Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # A risk analysis job calculates re-identification risk metrics for a BigQuery table. + "riskJob": { # Configuration for a risk analysis job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # A risk analysis job calculates re-identification risk metrics for a BigQuery table. "actions": [ # Actions to execute at the completion of the job. Are executed in the order provided. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -550,14 +550,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -614,7 +614,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -666,7 +666,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -709,7 +709,7 @@

Method Details

An object of the form: { # Combines all of the information about a DLP job. - "actionDetails": [ # Events that should occur after the job has completed. + "actionDetails": [ # Output only. Events that should occur after the job has completed. { # The results of an Action. "deidentifyDetails": { # The results of a Deidentify action from an inspect job. # Outcome of a de-identification action. "deidentifyStats": { # Summary of what was modified during a transformation. # Stats about the de-identification operation. @@ -718,7 +718,7 @@

Method Details

"transformedBytes": "A String", # Total size in bytes that were transformed in some way. }, "requestedOptions": { # De-identification options. # De-identification config used for the request. - "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. + "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -736,7 +736,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -752,7 +752,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -760,7 +760,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -839,7 +839,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -851,16 +851,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -872,13 +872,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -891,20 +891,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -918,7 +918,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -983,7 +983,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1045,7 +1045,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1053,7 +1053,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1132,7 +1132,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1144,16 +1144,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1165,13 +1165,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1184,20 +1184,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1211,7 +1211,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1276,7 +1276,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1292,7 +1292,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1371,7 +1371,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1383,16 +1383,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1404,13 +1404,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1423,20 +1423,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1450,7 +1450,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1515,7 +1515,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1580,7 +1580,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1598,7 +1598,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1614,7 +1614,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1622,7 +1622,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1701,7 +1701,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1713,16 +1713,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1734,13 +1734,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1753,20 +1753,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1780,7 +1780,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1845,7 +1845,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1907,7 +1907,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1915,7 +1915,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1994,7 +1994,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2006,16 +2006,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2027,13 +2027,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2046,20 +2046,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2073,7 +2073,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2138,7 +2138,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2154,7 +2154,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2233,7 +2233,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2245,16 +2245,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2266,13 +2266,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2285,20 +2285,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2312,7 +2312,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2377,7 +2377,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2442,7 +2442,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -2460,7 +2460,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -2476,7 +2476,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2484,7 +2484,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2563,7 +2563,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2575,16 +2575,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2596,13 +2596,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2615,20 +2615,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2642,7 +2642,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2707,7 +2707,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2769,7 +2769,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2777,7 +2777,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2856,7 +2856,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2868,16 +2868,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2889,13 +2889,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2908,20 +2908,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2935,7 +2935,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3000,7 +3000,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3016,7 +3016,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -3095,7 +3095,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3107,16 +3107,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3128,13 +3128,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3147,20 +3147,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -3174,7 +3174,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -3239,7 +3239,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -3331,7 +3331,7 @@

Method Details

"requestedOptions": { # Snapshot of the inspection configuration. # The configuration used for this job. "jobConfig": { # Controls what and how to inspect for findings. # Inspect config. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -3350,14 +3350,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -3382,7 +3382,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -3397,14 +3397,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -3430,7 +3430,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -3454,15 +3454,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -3473,7 +3473,7 @@

Method Details

"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://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}`. + "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. }, @@ -3485,11 +3485,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -3502,7 +3502,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -3521,9 +3521,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3535,7 +3535,7 @@

Method Details

"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://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}`. + "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. }, @@ -3551,7 +3551,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -3570,7 +3570,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -3582,9 +3582,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3595,7 +3595,7 @@

Method Details

"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://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}`. + "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. }, @@ -3622,9 +3622,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3651,7 +3651,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -3660,8 +3660,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -3706,16 +3706,16 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, - "snapshotInspectTemplate": { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. + "snapshotInspectTemplate": { # 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. # Output only. If run with an InspectTemplate, a snapshot of its state at the time of this run. "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). @@ -3724,7 +3724,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -3739,14 +3739,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -3772,7 +3772,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -3796,15 +3796,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -3815,7 +3815,7 @@

Method Details

"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://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}`. + "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. }, @@ -3827,11 +3827,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -3844,7 +3844,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -3863,9 +3863,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3877,7 +3877,7 @@

Method Details

"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://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}`. + "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. }, @@ -3893,7 +3893,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -3912,7 +3912,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -3924,9 +3924,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3937,7 +3937,7 @@

Method Details

"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://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}`. + "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. }, @@ -3964,9 +3964,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3978,7 +3978,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, }, - "result": { # All Result fields are updated while the job is processing. # A summary of the outcome of this inspection job. + "result": { # All Result fields are updated while the job is processing. # Output only. A summary of the outcome of this inspection job. "hybridStats": { # Statistics related to processing hybrid inspect requests. # Statistics related to the processing of hybrid inspect. "abortedCount": "A String", # The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed. "pendingCount": "A String", # The number of hybrid requests currently being processed. Only populated when called via method `getDlpJob`. A burst of traffic may cause hybrid inspect requests to be enqueued. Processing will take place as quickly as possible, but resource limitations may impact how long a request is enqueued for. @@ -3988,7 +3988,7 @@

Method Details

{ # Statistics regarding a specific InfoType. "count": "A String", # Number of findings for this infoType. "infoType": { # Type of information detected by the API. # The type of finding this stat is for. - "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://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}`. + "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. }, @@ -4005,7 +4005,7 @@

Method Details

"lastModified": "A String", # Output only. Time when the job was last modified by the system. "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. - "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result + "categoricalStatsResult": { # Result of the categorical stats computation. # Output only. Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. { # Histogram of value frequencies in the column. "bucketSize": "A String", # Total number of values in this bucket. @@ -4039,7 +4039,7 @@

Method Details

}, ], }, - "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Delta-presence result + "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Output only. Delta-presence result "deltaPresenceEstimationHistogram": [ # The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. { # A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset. "bucketSize": "A String", # Number of records within these probability bounds. @@ -4075,7 +4075,7 @@

Method Details

}, ], }, - "kAnonymityResult": { # Result of the k-anonymity computation. # K-anonymity result + "kAnonymityResult": { # Result of the k-anonymity computation. # Output only. K-anonymity result "equivalenceClassHistogramBuckets": [ # Histogram of k-anonymity equivalence classes. { # Histogram of k-anonymity equivalence classes. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -4111,7 +4111,7 @@

Method Details

}, ], }, - "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # K-map result + "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # Output only. K-map result "kMapEstimationHistogram": [ # The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10. { # A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records. "bucketSize": "A String", # Number of records within these anonymity bounds. @@ -4147,7 +4147,7 @@

Method Details

}, ], }, - "lDiversityResult": { # Result of the l-diversity computation. # L-divesity result + "lDiversityResult": { # Result of the l-diversity computation. # Output only. L-divesity result "sensitiveValueFrequencyHistogramBuckets": [ # Histogram of l-diversity equivalence class sensitive value frequencies. { # Histogram of l-diversity equivalence class sensitive value frequencies. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -4208,7 +4208,7 @@

Method Details

}, ], }, - "numericalStatsResult": { # Result of the numerical stats computation. # Numerical stats result + "numericalStatsResult": { # Result of the numerical stats computation. # Output only. Numerical stats result "maxValue": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Maximum value appearing in the column. "booleanValue": True or False, # boolean "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # date @@ -4270,9 +4270,9 @@

Method Details

], }, "requestedOptions": { # Risk analysis options. # The configuration used for this job. - "jobConfig": { # Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. + "jobConfig": { # Configuration for a risk analysis job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. "actions": [ # Actions to execute at the completion of the job. Are executed in the order provided. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -4291,14 +4291,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -4355,7 +4355,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -4407,7 +4407,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -4476,7 +4476,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -4528,7 +4528,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -4568,7 +4568,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
+  
Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
 
 Args:
   name: string, Required. The name of the DlpJob resource to be deleted. (required)
@@ -4610,7 +4610,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
+  
Gets the latest state of a long-running DlpJob. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
 
 Args:
   name: string, Required. The name of the DlpJob resource. (required)
@@ -4623,7 +4623,7 @@ 

Method Details

An object of the form: { # Combines all of the information about a DLP job. - "actionDetails": [ # Events that should occur after the job has completed. + "actionDetails": [ # Output only. Events that should occur after the job has completed. { # The results of an Action. "deidentifyDetails": { # The results of a Deidentify action from an inspect job. # Outcome of a de-identification action. "deidentifyStats": { # Summary of what was modified during a transformation. # Stats about the de-identification operation. @@ -4632,7 +4632,7 @@

Method Details

"transformedBytes": "A String", # Total size in bytes that were transformed in some way. }, "requestedOptions": { # De-identification options. # De-identification config used for the request. - "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. + "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -4650,7 +4650,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -4666,7 +4666,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4674,7 +4674,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -4753,7 +4753,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4765,16 +4765,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4786,13 +4786,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4805,20 +4805,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -4832,7 +4832,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -4897,7 +4897,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -4959,7 +4959,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -4967,7 +4967,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -5046,7 +5046,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5058,16 +5058,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5079,13 +5079,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5098,20 +5098,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5125,7 +5125,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5190,7 +5190,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -5206,7 +5206,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -5285,7 +5285,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5297,16 +5297,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5318,13 +5318,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5337,20 +5337,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5364,7 +5364,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5429,7 +5429,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -5494,7 +5494,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -5512,7 +5512,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -5528,7 +5528,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -5536,7 +5536,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -5615,7 +5615,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5627,16 +5627,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5648,13 +5648,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5667,20 +5667,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5694,7 +5694,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -5759,7 +5759,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -5821,7 +5821,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -5829,7 +5829,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -5908,7 +5908,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5920,16 +5920,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5941,13 +5941,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5960,20 +5960,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -5987,7 +5987,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -6052,7 +6052,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -6068,7 +6068,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -6147,7 +6147,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6159,16 +6159,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6180,13 +6180,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6199,20 +6199,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6226,7 +6226,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -6291,7 +6291,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -6356,7 +6356,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -6374,7 +6374,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -6390,7 +6390,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -6398,7 +6398,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -6477,7 +6477,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6489,16 +6489,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6510,13 +6510,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6529,20 +6529,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6556,7 +6556,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -6621,7 +6621,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -6683,7 +6683,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -6691,7 +6691,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -6770,7 +6770,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6782,16 +6782,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6803,13 +6803,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6822,20 +6822,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -6849,7 +6849,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -6914,7 +6914,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -6930,7 +6930,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -7009,7 +7009,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -7021,16 +7021,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -7042,13 +7042,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -7061,20 +7061,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -7088,7 +7088,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -7153,7 +7153,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -7245,7 +7245,7 @@

Method Details

"requestedOptions": { # Snapshot of the inspection configuration. # The configuration used for this job. "jobConfig": { # Controls what and how to inspect for findings. # Inspect config. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -7264,14 +7264,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -7296,7 +7296,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -7311,14 +7311,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -7344,7 +7344,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -7368,15 +7368,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -7387,7 +7387,7 @@

Method Details

"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://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}`. + "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. }, @@ -7399,11 +7399,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -7416,7 +7416,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -7435,9 +7435,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -7449,7 +7449,7 @@

Method Details

"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://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}`. + "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. }, @@ -7465,7 +7465,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -7484,7 +7484,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -7496,9 +7496,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -7509,7 +7509,7 @@

Method Details

"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://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}`. + "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. }, @@ -7536,9 +7536,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -7565,7 +7565,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -7574,8 +7574,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -7620,16 +7620,16 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, - "snapshotInspectTemplate": { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. + "snapshotInspectTemplate": { # 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. # Output only. If run with an InspectTemplate, a snapshot of its state at the time of this run. "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). @@ -7638,7 +7638,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -7653,14 +7653,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -7686,7 +7686,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -7710,15 +7710,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -7729,7 +7729,7 @@

Method Details

"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://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}`. + "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. }, @@ -7741,11 +7741,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -7758,7 +7758,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -7777,9 +7777,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -7791,7 +7791,7 @@

Method Details

"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://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}`. + "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. }, @@ -7807,7 +7807,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -7826,7 +7826,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -7838,9 +7838,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -7851,7 +7851,7 @@

Method Details

"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://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}`. + "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. }, @@ -7878,9 +7878,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -7892,7 +7892,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, }, - "result": { # All Result fields are updated while the job is processing. # A summary of the outcome of this inspection job. + "result": { # All Result fields are updated while the job is processing. # Output only. A summary of the outcome of this inspection job. "hybridStats": { # Statistics related to processing hybrid inspect requests. # Statistics related to the processing of hybrid inspect. "abortedCount": "A String", # The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed. "pendingCount": "A String", # The number of hybrid requests currently being processed. Only populated when called via method `getDlpJob`. A burst of traffic may cause hybrid inspect requests to be enqueued. Processing will take place as quickly as possible, but resource limitations may impact how long a request is enqueued for. @@ -7902,7 +7902,7 @@

Method Details

{ # Statistics regarding a specific InfoType. "count": "A String", # Number of findings for this infoType. "infoType": { # Type of information detected by the API. # The type of finding this stat is for. - "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://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}`. + "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. }, @@ -7919,7 +7919,7 @@

Method Details

"lastModified": "A String", # Output only. Time when the job was last modified by the system. "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. - "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result + "categoricalStatsResult": { # Result of the categorical stats computation. # Output only. Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. { # Histogram of value frequencies in the column. "bucketSize": "A String", # Total number of values in this bucket. @@ -7953,7 +7953,7 @@

Method Details

}, ], }, - "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Delta-presence result + "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Output only. Delta-presence result "deltaPresenceEstimationHistogram": [ # The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. { # A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset. "bucketSize": "A String", # Number of records within these probability bounds. @@ -7989,7 +7989,7 @@

Method Details

}, ], }, - "kAnonymityResult": { # Result of the k-anonymity computation. # K-anonymity result + "kAnonymityResult": { # Result of the k-anonymity computation. # Output only. K-anonymity result "equivalenceClassHistogramBuckets": [ # Histogram of k-anonymity equivalence classes. { # Histogram of k-anonymity equivalence classes. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -8025,7 +8025,7 @@

Method Details

}, ], }, - "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # K-map result + "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # Output only. K-map result "kMapEstimationHistogram": [ # The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10. { # A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records. "bucketSize": "A String", # Number of records within these anonymity bounds. @@ -8061,7 +8061,7 @@

Method Details

}, ], }, - "lDiversityResult": { # Result of the l-diversity computation. # L-divesity result + "lDiversityResult": { # Result of the l-diversity computation. # Output only. L-divesity result "sensitiveValueFrequencyHistogramBuckets": [ # Histogram of l-diversity equivalence class sensitive value frequencies. { # Histogram of l-diversity equivalence class sensitive value frequencies. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -8122,7 +8122,7 @@

Method Details

}, ], }, - "numericalStatsResult": { # Result of the numerical stats computation. # Numerical stats result + "numericalStatsResult": { # Result of the numerical stats computation. # Output only. Numerical stats result "maxValue": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Maximum value appearing in the column. "booleanValue": True or False, # boolean "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # date @@ -8184,9 +8184,9 @@

Method Details

], }, "requestedOptions": { # Risk analysis options. # The configuration used for this job. - "jobConfig": { # Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. + "jobConfig": { # Configuration for a risk analysis job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. "actions": [ # Actions to execute at the completion of the job. Are executed in the order provided. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -8205,14 +8205,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -8269,7 +8269,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -8321,7 +8321,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -8390,7 +8390,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -8442,7 +8442,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -8577,7 +8577,7 @@

Method Details

}, ], }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -8628,10 +8628,10 @@

Method Details

list(parent, filter=None, locationId=None, orderBy=None, pageSize=None, pageToken=None, type=None, x__xgafv=None) -
Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
+  
Lists DlpJobs that match the specified filter in the request. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`
@@ -8653,7 +8653,7 @@ 

Method Details

{ # The response message for listing DLP jobs. "jobs": [ # A list of DlpJobs that matches the specified filter in the request. { # Combines all of the information about a DLP job. - "actionDetails": [ # Events that should occur after the job has completed. + "actionDetails": [ # Output only. Events that should occur after the job has completed. { # The results of an Action. "deidentifyDetails": { # The results of a Deidentify action from an inspect job. # Outcome of a de-identification action. "deidentifyStats": { # Summary of what was modified during a transformation. # Stats about the de-identification operation. @@ -8662,7 +8662,7 @@

Method Details

"transformedBytes": "A String", # Total size in bytes that were transformed in some way. }, "requestedOptions": { # De-identification options. # De-identification config used for the request. - "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. + "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -8680,7 +8680,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -8696,7 +8696,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -8704,7 +8704,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -8783,7 +8783,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -8795,16 +8795,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -8816,13 +8816,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -8835,20 +8835,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -8862,7 +8862,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -8927,7 +8927,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -8989,7 +8989,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -8997,7 +8997,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -9076,7 +9076,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9088,16 +9088,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9109,13 +9109,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9128,20 +9128,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9155,7 +9155,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -9220,7 +9220,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -9236,7 +9236,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -9315,7 +9315,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9327,16 +9327,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9348,13 +9348,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9367,20 +9367,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9394,7 +9394,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -9459,7 +9459,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -9524,7 +9524,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -9542,7 +9542,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -9558,7 +9558,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -9566,7 +9566,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -9645,7 +9645,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9657,16 +9657,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9678,13 +9678,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9697,20 +9697,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9724,7 +9724,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -9789,7 +9789,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -9851,7 +9851,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -9859,7 +9859,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -9938,7 +9938,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9950,16 +9950,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9971,13 +9971,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -9990,20 +9990,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10017,7 +10017,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -10082,7 +10082,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -10098,7 +10098,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -10177,7 +10177,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10189,16 +10189,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10210,13 +10210,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10229,20 +10229,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10256,7 +10256,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -10321,7 +10321,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -10386,7 +10386,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -10404,7 +10404,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -10420,7 +10420,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -10428,7 +10428,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -10507,7 +10507,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10519,16 +10519,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10540,13 +10540,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10559,20 +10559,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10586,7 +10586,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -10651,7 +10651,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -10713,7 +10713,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -10721,7 +10721,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -10800,7 +10800,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10812,16 +10812,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10833,13 +10833,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10852,20 +10852,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -10879,7 +10879,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -10944,7 +10944,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -10960,7 +10960,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -11039,7 +11039,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -11051,16 +11051,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -11072,13 +11072,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -11091,20 +11091,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -11118,7 +11118,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -11183,7 +11183,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -11275,7 +11275,7 @@

Method Details

"requestedOptions": { # Snapshot of the inspection configuration. # The configuration used for this job. "jobConfig": { # Controls what and how to inspect for findings. # Inspect config. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -11294,14 +11294,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -11326,7 +11326,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -11341,14 +11341,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -11374,7 +11374,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -11398,15 +11398,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -11417,7 +11417,7 @@

Method Details

"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://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}`. + "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. }, @@ -11429,11 +11429,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -11446,7 +11446,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -11465,9 +11465,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -11479,7 +11479,7 @@

Method Details

"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://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}`. + "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. }, @@ -11495,7 +11495,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -11514,7 +11514,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -11526,9 +11526,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -11539,7 +11539,7 @@

Method Details

"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://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}`. + "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. }, @@ -11566,9 +11566,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -11595,7 +11595,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -11604,8 +11604,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -11650,16 +11650,16 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, - "snapshotInspectTemplate": { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. + "snapshotInspectTemplate": { # 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. # Output only. If run with an InspectTemplate, a snapshot of its state at the time of this run. "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). @@ -11668,7 +11668,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -11683,14 +11683,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -11716,7 +11716,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -11740,15 +11740,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -11759,7 +11759,7 @@

Method Details

"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://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}`. + "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. }, @@ -11771,11 +11771,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -11788,7 +11788,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -11807,9 +11807,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -11821,7 +11821,7 @@

Method Details

"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://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}`. + "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. }, @@ -11837,7 +11837,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -11856,7 +11856,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -11868,9 +11868,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -11881,7 +11881,7 @@

Method Details

"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://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}`. + "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. }, @@ -11908,9 +11908,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -11922,7 +11922,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, }, - "result": { # All Result fields are updated while the job is processing. # A summary of the outcome of this inspection job. + "result": { # All Result fields are updated while the job is processing. # Output only. A summary of the outcome of this inspection job. "hybridStats": { # Statistics related to processing hybrid inspect requests. # Statistics related to the processing of hybrid inspect. "abortedCount": "A String", # The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed. "pendingCount": "A String", # The number of hybrid requests currently being processed. Only populated when called via method `getDlpJob`. A burst of traffic may cause hybrid inspect requests to be enqueued. Processing will take place as quickly as possible, but resource limitations may impact how long a request is enqueued for. @@ -11932,7 +11932,7 @@

Method Details

{ # Statistics regarding a specific InfoType. "count": "A String", # Number of findings for this infoType. "infoType": { # Type of information detected by the API. # The type of finding this stat is for. - "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://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}`. + "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. }, @@ -11949,7 +11949,7 @@

Method Details

"lastModified": "A String", # Output only. Time when the job was last modified by the system. "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. - "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result + "categoricalStatsResult": { # Result of the categorical stats computation. # Output only. Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. { # Histogram of value frequencies in the column. "bucketSize": "A String", # Total number of values in this bucket. @@ -11983,7 +11983,7 @@

Method Details

}, ], }, - "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Delta-presence result + "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Output only. Delta-presence result "deltaPresenceEstimationHistogram": [ # The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. { # A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset. "bucketSize": "A String", # Number of records within these probability bounds. @@ -12019,7 +12019,7 @@

Method Details

}, ], }, - "kAnonymityResult": { # Result of the k-anonymity computation. # K-anonymity result + "kAnonymityResult": { # Result of the k-anonymity computation. # Output only. K-anonymity result "equivalenceClassHistogramBuckets": [ # Histogram of k-anonymity equivalence classes. { # Histogram of k-anonymity equivalence classes. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -12055,7 +12055,7 @@

Method Details

}, ], }, - "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # K-map result + "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # Output only. K-map result "kMapEstimationHistogram": [ # The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10. { # A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records. "bucketSize": "A String", # Number of records within these anonymity bounds. @@ -12091,7 +12091,7 @@

Method Details

}, ], }, - "lDiversityResult": { # Result of the l-diversity computation. # L-divesity result + "lDiversityResult": { # Result of the l-diversity computation. # Output only. L-divesity result "sensitiveValueFrequencyHistogramBuckets": [ # Histogram of l-diversity equivalence class sensitive value frequencies. { # Histogram of l-diversity equivalence class sensitive value frequencies. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -12152,7 +12152,7 @@

Method Details

}, ], }, - "numericalStatsResult": { # Result of the numerical stats computation. # Numerical stats result + "numericalStatsResult": { # Result of the numerical stats computation. # Output only. Numerical stats result "maxValue": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Maximum value appearing in the column. "booleanValue": True or False, # boolean "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # date @@ -12214,9 +12214,9 @@

Method Details

], }, "requestedOptions": { # Risk analysis options. # The configuration used for this job. - "jobConfig": { # Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. + "jobConfig": { # Configuration for a risk analysis job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. "actions": [ # Actions to execute at the completion of the job. Are executed in the order provided. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -12235,14 +12235,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -12299,7 +12299,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -12351,7 +12351,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -12420,7 +12420,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -12472,7 +12472,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index 489f1454e3..456443bb49 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -129,11 +129,11 @@

Method Details

{ # The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. * Amazon S3: maps 1:1 with a bucket. "configSnapshot": { # Snapshot of the configurations used to generate the profile. # The snapshot of the configurations used to generate the profile. - "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. + "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. "dataProfileActions": [ # Actions to execute at the completion of the job. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -160,15 +160,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -185,7 +185,7 @@

Method Details

}, }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "location": { # The data that will be profiled. # The data to scan. @@ -200,11 +200,11 @@

Method Details

}, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the DLP API must be enabled. }, - "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. + "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -231,15 +231,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -275,11 +275,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -442,7 +442,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -461,7 +461,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -511,7 +511,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -551,7 +551,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -566,14 +566,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -599,7 +599,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -623,15 +623,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -642,7 +642,7 @@

Method Details

"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://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}`. + "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. }, @@ -654,11 +654,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -671,7 +671,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -690,9 +690,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -704,7 +704,7 @@

Method Details

"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://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}`. + "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. }, @@ -720,7 +720,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -739,7 +739,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -751,9 +751,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -764,7 +764,7 @@

Method Details

"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://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}`. + "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. }, @@ -791,9 +791,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -860,7 +860,7 @@

Method Details

"fileStoreInfoTypeSummaries": [ # InfoTypes detected in this cluster. { # Information regarding the discovered InfoType. "infoType": { # Type of information detected by the API. # The InfoType seen. - "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://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}`. + "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. }, @@ -877,7 +877,7 @@

Method Details

"fileStoreInfoTypeSummaries": [ # InfoTypes detected in this file store. { # Information regarding the discovered InfoType. "infoType": { # Type of information detected by the API. # The InfoType seen. - "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://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}`. + "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. }, @@ -886,7 +886,7 @@

Method Details

}, ], "fileStoreIsEmpty": True or False, # The file store does not have any files. If the profiling operation failed, this is false. - "fileStoreLocation": "A String", # The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints + "fileStoreLocation": "A String", # The location of the file store. * Cloud Storage: https://docs.cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints "fileStorePath": "A String", # The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` * Vertex AI dataset: `projects/{project_number}/locations/{location}/datasets/{dataset_id}` "fullResource": "A String", # The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: `//cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}` "lastModifiedTime": "A String", # The time the file store was last modified. @@ -978,11 +978,11 @@

Method Details

"fileStoreDataProfiles": [ # List of data profiles. { # The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. * Amazon S3: maps 1:1 with a bucket. "configSnapshot": { # Snapshot of the configurations used to generate the profile. # The snapshot of the configurations used to generate the profile. - "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. + "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. "dataProfileActions": [ # Actions to execute at the completion of the job. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -1009,15 +1009,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -1034,7 +1034,7 @@

Method Details

}, }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "location": { # The data that will be profiled. # The data to scan. @@ -1049,11 +1049,11 @@

Method Details

}, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the DLP API must be enabled. }, - "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. + "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -1080,15 +1080,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -1124,11 +1124,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -1291,7 +1291,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -1310,7 +1310,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -1360,7 +1360,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -1400,7 +1400,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1415,14 +1415,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1448,7 +1448,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1472,15 +1472,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1491,7 +1491,7 @@

Method Details

"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://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}`. + "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. }, @@ -1503,11 +1503,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1520,7 +1520,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1539,9 +1539,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1553,7 +1553,7 @@

Method Details

"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://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}`. + "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. }, @@ -1569,7 +1569,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1588,7 +1588,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1600,9 +1600,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1613,7 +1613,7 @@

Method Details

"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://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}`. + "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. }, @@ -1640,9 +1640,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1709,7 +1709,7 @@

Method Details

"fileStoreInfoTypeSummaries": [ # InfoTypes detected in this cluster. { # Information regarding the discovered InfoType. "infoType": { # Type of information detected by the API. # The InfoType seen. - "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://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}`. + "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. }, @@ -1726,7 +1726,7 @@

Method Details

"fileStoreInfoTypeSummaries": [ # InfoTypes detected in this file store. { # Information regarding the discovered InfoType. "infoType": { # Type of information detected by the API. # The InfoType seen. - "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://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}`. + "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. }, @@ -1735,7 +1735,7 @@

Method Details

}, ], "fileStoreIsEmpty": True or False, # The file store does not have any files. If the profiling operation failed, this is false. - "fileStoreLocation": "A String", # The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints + "fileStoreLocation": "A String", # The location of the file store. * Cloud Storage: https://docs.cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints "fileStorePath": "A String", # The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` * Vertex AI dataset: `projects/{project_number}/locations/{location}/datasets/{dataset_id}` "fullResource": "A String", # The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: `//cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}` "lastModifiedTime": "A String", # The time the file store was last modified. diff --git a/docs/dyn/dlp_v2.projects.locations.image.html b/docs/dyn/dlp_v2.projects.locations.image.html index 6e10119a1c..90990ab67d 100644 --- a/docs/dyn/dlp_v2.projects.locations.image.html +++ b/docs/dyn/dlp_v2.projects.locations.image.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.

+

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://docs.cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.

Method Details

close() @@ -88,10 +88,10 @@

Method Details

redact(parent, body=None, x__xgafv=None) -
Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.
+  
Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://docs.cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.
 
 Args:
-  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -104,7 +104,7 @@ 

Method Details

"imageRedactionConfigs": [ # The configuration for specifying what content to redact from images. { # Configuration for determining how redaction of images should occur. "infoType": { # Type of information detected by the API. # Only one per info_type should be provided per request. If not specified, and redact_all_text is false, the DLP API will redact all text that it matches against all info_types that are found, but not specified in another ImageRedactionConfig. - "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://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}`. + "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. }, @@ -123,7 +123,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -138,14 +138,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -171,7 +171,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -195,15 +195,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -214,7 +214,7 @@

Method Details

"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://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}`. + "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. }, @@ -226,11 +226,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -243,7 +243,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -262,9 +262,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -276,7 +276,7 @@

Method Details

"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://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}`. + "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. }, @@ -292,7 +292,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -311,7 +311,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -323,9 +323,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -336,7 +336,7 @@

Method Details

"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://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}`. + "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. }, @@ -363,9 +363,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -393,7 +393,7 @@

Method Details

"createTime": "A String", # Timestamp when finding was detected. "findingId": "A String", # The unique finding id. "infoType": { # Type of information detected by the API. # The type of content that might have been found. Provided if `excluded_types` is false. - "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://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}`. + "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. }, diff --git a/docs/dyn/dlp_v2.projects.locations.infoTypes.html b/docs/dyn/dlp_v2.projects.locations.infoTypes.html index e3a5e8072c..962f538c9e 100644 --- a/docs/dyn/dlp_v2.projects.locations.infoTypes.html +++ b/docs/dyn/dlp_v2.projects.locations.infoTypes.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

list(parent, filter=None, languageCode=None, locationId=None, x__xgafv=None)

-

Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.

+

Returns a list of the sensitive information types that the DLP API supports. See https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.

Method Details

close() @@ -88,7 +88,7 @@

Method Details

list(parent, filter=None, languageCode=None, locationId=None, x__xgafv=None) -
Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.
+  
Returns a list of the sensitive information types that the DLP API supports. See https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.
 
 Args:
   parent: string, The parent resource name. The format of this value is as follows: `locations/{location_id}` (required)
diff --git a/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html b/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html
index 9e890f6740..ed04fcf46e 100644
--- a/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html
+++ b/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html
@@ -79,22 +79,22 @@ 

Instance Methods

Close httplib2 connections.

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

-

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

delete(name, x__xgafv=None)

-

Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Deletes an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

get(name, x__xgafv=None)

-

Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

+

Updates the InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

Method Details

close() @@ -103,15 +103,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateInspectTemplate.
-  "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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The InspectTemplate to create.
+  "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. # Required. The InspectTemplate to create.
     "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).
@@ -120,7 +120,7 @@ 

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -135,14 +135,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -168,7 +168,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -192,15 +192,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -211,7 +211,7 @@

Method Details

"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://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}`. + "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. }, @@ -223,11 +223,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -240,7 +240,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -259,9 +259,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -273,7 +273,7 @@

Method Details

"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://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}`. + "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. }, @@ -289,7 +289,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -308,7 +308,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -320,9 +320,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -333,7 +333,7 @@

Method Details

"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://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}`. + "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. }, @@ -360,9 +360,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -385,7 +385,7 @@

Method Details

Returns: An object of the form: - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -394,7 +394,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -409,14 +409,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -442,7 +442,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -466,15 +466,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -485,7 +485,7 @@

Method Details

"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://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}`. + "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. }, @@ -497,11 +497,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -514,7 +514,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -533,9 +533,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -547,7 +547,7 @@

Method Details

"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://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}`. + "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. }, @@ -563,7 +563,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -582,7 +582,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -594,9 +594,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -607,7 +607,7 @@

Method Details

"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://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}`. + "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. }, @@ -634,9 +634,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -651,7 +651,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Deletes an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. (required)
@@ -669,7 +669,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. (required)
@@ -681,7 +681,7 @@ 

Method Details

Returns: An object of the form: - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -690,7 +690,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -705,14 +705,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -738,7 +738,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -762,15 +762,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -781,7 +781,7 @@

Method Details

"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://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}`. + "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. }, @@ -793,11 +793,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -810,7 +810,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -829,9 +829,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -843,7 +843,7 @@

Method Details

"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://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}`. + "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. }, @@ -859,7 +859,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -878,7 +878,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -890,9 +890,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -903,7 +903,7 @@

Method Details

"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://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}`. + "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. }, @@ -930,9 +930,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -947,10 +947,10 @@

Method Details

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -965,7 +965,7 @@ 

Method Details

{ # Response message for ListInspectTemplates. "inspectTemplates": [ # List of inspectTemplates, up to page_size in ListInspectTemplatesRequest. - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -974,7 +974,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -989,14 +989,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1022,7 +1022,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1046,15 +1046,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1065,7 +1065,7 @@

Method Details

"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://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}`. + "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. }, @@ -1077,11 +1077,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1094,7 +1094,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1113,9 +1113,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1127,7 +1127,7 @@

Method Details

"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://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}`. + "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. }, @@ -1143,7 +1143,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1162,7 +1162,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1174,9 +1174,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1187,7 +1187,7 @@

Method Details

"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://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}`. + "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. }, @@ -1214,9 +1214,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1248,7 +1248,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
+  
Updates the InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
   name: string, Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342. (required)
@@ -1256,7 +1256,7 @@ 

Method Details

The object takes the form of: { # Request message for UpdateInspectTemplate. - "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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New InspectTemplate value. + "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. # New InspectTemplate value. "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). @@ -1265,7 +1265,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1280,14 +1280,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1313,7 +1313,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1337,15 +1337,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1356,7 +1356,7 @@

Method Details

"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://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}`. + "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. }, @@ -1368,11 +1368,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1385,7 +1385,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1404,9 +1404,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1418,7 +1418,7 @@

Method Details

"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://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}`. + "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. }, @@ -1434,7 +1434,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1453,7 +1453,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1465,9 +1465,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1478,7 +1478,7 @@

Method Details

"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://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}`. + "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. }, @@ -1505,9 +1505,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1529,7 +1529,7 @@

Method Details

Returns: An object of the form: - { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. + { # 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. "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). @@ -1538,7 +1538,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1553,14 +1553,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1586,7 +1586,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1610,15 +1610,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1629,7 +1629,7 @@

Method Details

"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://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}`. + "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. }, @@ -1641,11 +1641,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1658,7 +1658,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1677,9 +1677,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1691,7 +1691,7 @@

Method Details

"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://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}`. + "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. }, @@ -1707,7 +1707,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1726,7 +1726,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1738,9 +1738,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1751,7 +1751,7 @@

Method Details

"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://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}`. + "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. }, @@ -1778,9 +1778,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html index 080ad2b812..df492d9785 100644 --- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html @@ -82,25 +82,25 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

delete(name, x__xgafv=None)

-

Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Deletes a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

get(name, x__xgafv=None)

-

Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Gets a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

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

Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger.

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

-

Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Lists job triggers. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

+

Updates a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

Method Details

activate(name, body=None, x__xgafv=None) @@ -123,7 +123,7 @@

Method Details

An object of the form: { # Combines all of the information about a DLP job. - "actionDetails": [ # Events that should occur after the job has completed. + "actionDetails": [ # Output only. Events that should occur after the job has completed. { # The results of an Action. "deidentifyDetails": { # The results of a Deidentify action from an inspect job. # Outcome of a de-identification action. "deidentifyStats": { # Summary of what was modified during a transformation. # Stats about the de-identification operation. @@ -132,7 +132,7 @@

Method Details

"transformedBytes": "A String", # Total size in bytes that were transformed in some way. }, "requestedOptions": { # De-identification options. # De-identification config used for the request. - "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. + "snapshotDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -150,7 +150,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -166,7 +166,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -174,7 +174,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -253,7 +253,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -265,16 +265,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -286,13 +286,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -305,20 +305,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -332,7 +332,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -397,7 +397,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -459,7 +459,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -467,7 +467,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -546,7 +546,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -558,16 +558,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -579,13 +579,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -598,20 +598,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -625,7 +625,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -690,7 +690,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -706,7 +706,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -785,7 +785,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -797,16 +797,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -818,13 +818,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -837,20 +837,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -864,7 +864,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -929,7 +929,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -994,7 +994,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotImageRedactTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1012,7 +1012,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1028,7 +1028,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1036,7 +1036,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1115,7 +1115,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1127,16 +1127,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1148,13 +1148,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1167,20 +1167,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1194,7 +1194,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1259,7 +1259,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1321,7 +1321,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1329,7 +1329,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1408,7 +1408,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1420,16 +1420,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1441,13 +1441,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1460,20 +1460,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1487,7 +1487,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1552,7 +1552,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1568,7 +1568,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1647,7 +1647,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1659,16 +1659,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1680,13 +1680,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1699,20 +1699,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1726,7 +1726,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -1791,7 +1791,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -1856,7 +1856,7 @@

Method Details

"name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, - "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. + "snapshotStructuredDeidentifyTemplate": { # DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "deidentifyConfig": { # The configuration that controls how the data will change. # The core content of the template. "imageTransformations": { # A type of transformation that is applied over images. # Treat the dataset as an image and redact. @@ -1874,7 +1874,7 @@

Method Details

"selectedInfoTypes": { # Apply transformation to the selected info_types. # Apply transformation to the selected info_types. "infoTypes": [ # Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message. { # 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://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}`. + "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. }, @@ -1890,7 +1890,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -1898,7 +1898,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -1977,7 +1977,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -1989,16 +1989,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2010,13 +2010,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2029,20 +2029,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2056,7 +2056,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2121,7 +2121,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2183,7 +2183,7 @@

Method Details

{ # A transformation to apply to text that is identified as a specific info_type. "infoTypes": [ # InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`. { # 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://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}`. + "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. }, @@ -2191,7 +2191,7 @@

Method Details

}, ], "primitiveTransformation": { # A rule for transforming a value. # Required. Primitive transformation to apply to the infoType. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2270,7 +2270,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2282,16 +2282,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2303,13 +2303,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2322,20 +2322,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2349,7 +2349,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2414,7 +2414,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2430,7 +2430,7 @@

Method Details

], }, "primitiveTransformation": { # A rule for transforming a value. # Apply the transformation to the entire field. - "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing + "bucketingConfig": { # Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Bucketing "buckets": [ # Set of buckets. Ranges must be non-overlapping. { # Bucket is represented as a range, along with replacement values. "max": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Upper bound of the range, exclusive; type must match min. @@ -2509,7 +2509,7 @@

Method Details

"name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2521,16 +2521,16 @@

Method Details

}, }, "surrogateInfoType": { # Type of information detected by the API. # The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "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. }, }, - "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto + "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. # Crypto "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # The key used by the hash function. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2542,13 +2542,13 @@

Method Details

}, }, }, - "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. + "cryptoReplaceFfxFpeConfig": { # Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs. # Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs. "commonAlphabet": "A String", # Common alphabets. "context": { # General identifier of a data field in a storage service. # The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Required. The key used by the encryption algorithm. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2561,20 +2561,20 @@

Method Details

}, "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. - "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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://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}`. + "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_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. }, }, - "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift + "dateShiftConfig": { # Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more. # Date Shift "context": { # General identifier of a data field in a storage service. # Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context. "name": "A String", # Name describing the field. }, "cryptoKey": { # This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK. # Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items. - "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS + "kmsWrapped": { # Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). # Key wrapped using Cloud KMS "cryptoKeyName": "A String", # Required. The resource name of the KMS CryptoKey to use for unwrapping. "wrappedKey": "A String", # Required. The wrapped data crypto key. }, @@ -2588,7 +2588,7 @@

Method Details

"lowerBoundDays": 42, # Required. For example, -5 means shift date to at most 5 days back in the past. "upperBoundDays": 42, # Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. }, - "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing + "fixedSizeBucketingConfig": { # Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more. # Fixed size bucketing "bucketSize": 3.14, # Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. "lowerBound": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value "-10". "booleanValue": True or False, # boolean @@ -2653,7 +2653,7 @@

Method Details

}, }, "replaceDictionaryConfig": { # Replace each input value with a value randomly selected from the dictionary. # Replace with a value randomly drawn (with replacement) from a dictionary. - "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. + "wordList": { # Message defining a list of words or phrases to search for in the data. # A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. "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", ], @@ -2745,7 +2745,7 @@

Method Details

"requestedOptions": { # Snapshot of the inspection configuration. # The configuration used for this job. "jobConfig": { # Controls what and how to inspect for findings. # Inspect config. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -2764,14 +2764,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -2796,7 +2796,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -2811,14 +2811,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -2844,7 +2844,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -2868,15 +2868,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -2887,7 +2887,7 @@

Method Details

"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://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}`. + "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. }, @@ -2899,11 +2899,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -2916,7 +2916,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -2935,9 +2935,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -2949,7 +2949,7 @@

Method Details

"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://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}`. + "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. }, @@ -2965,7 +2965,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -2984,7 +2984,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -2996,9 +2996,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3009,7 +3009,7 @@

Method Details

"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://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}`. + "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. }, @@ -3036,9 +3036,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3065,7 +3065,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -3074,8 +3074,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -3120,16 +3120,16 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, - "snapshotInspectTemplate": { # 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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. + "snapshotInspectTemplate": { # 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. # Output only. If run with an InspectTemplate, a snapshot of its state at the time of this run. "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). @@ -3138,7 +3138,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -3153,14 +3153,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -3186,7 +3186,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -3210,15 +3210,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -3229,7 +3229,7 @@

Method Details

"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://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}`. + "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. }, @@ -3241,11 +3241,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -3258,7 +3258,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -3277,9 +3277,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3291,7 +3291,7 @@

Method Details

"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://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}`. + "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. }, @@ -3307,7 +3307,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -3326,7 +3326,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -3338,9 +3338,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -3351,7 +3351,7 @@

Method Details

"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://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}`. + "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. }, @@ -3378,9 +3378,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -3392,7 +3392,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. }, }, - "result": { # All Result fields are updated while the job is processing. # A summary of the outcome of this inspection job. + "result": { # All Result fields are updated while the job is processing. # Output only. A summary of the outcome of this inspection job. "hybridStats": { # Statistics related to processing hybrid inspect requests. # Statistics related to the processing of hybrid inspect. "abortedCount": "A String", # The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed. "pendingCount": "A String", # The number of hybrid requests currently being processed. Only populated when called via method `getDlpJob`. A burst of traffic may cause hybrid inspect requests to be enqueued. Processing will take place as quickly as possible, but resource limitations may impact how long a request is enqueued for. @@ -3402,7 +3402,7 @@

Method Details

{ # Statistics regarding a specific InfoType. "count": "A String", # Number of findings for this infoType. "infoType": { # Type of information detected by the API. # The type of finding this stat is for. - "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://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}`. + "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. }, @@ -3419,7 +3419,7 @@

Method Details

"lastModified": "A String", # Output only. Time when the job was last modified by the system. "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. - "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result + "categoricalStatsResult": { # Result of the categorical stats computation. # Output only. Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. { # Histogram of value frequencies in the column. "bucketSize": "A String", # Total number of values in this bucket. @@ -3453,7 +3453,7 @@

Method Details

}, ], }, - "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Delta-presence result + "deltaPresenceEstimationResult": { # Result of the δ-presence computation. Note that these results are an estimation, not exact values. # Output only. Delta-presence result "deltaPresenceEstimationHistogram": [ # The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4. { # A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset. "bucketSize": "A String", # Number of records within these probability bounds. @@ -3489,7 +3489,7 @@

Method Details

}, ], }, - "kAnonymityResult": { # Result of the k-anonymity computation. # K-anonymity result + "kAnonymityResult": { # Result of the k-anonymity computation. # Output only. K-anonymity result "equivalenceClassHistogramBuckets": [ # Histogram of k-anonymity equivalence classes. { # Histogram of k-anonymity equivalence classes. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -3525,7 +3525,7 @@

Method Details

}, ], }, - "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # K-map result + "kMapEstimationResult": { # Result of the reidentifiability analysis. Note that these results are an estimation, not exact values. # Output only. K-map result "kMapEstimationHistogram": [ # The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10. { # A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records. "bucketSize": "A String", # Number of records within these anonymity bounds. @@ -3561,7 +3561,7 @@

Method Details

}, ], }, - "lDiversityResult": { # Result of the l-diversity computation. # L-divesity result + "lDiversityResult": { # Result of the l-diversity computation. # Output only. L-divesity result "sensitiveValueFrequencyHistogramBuckets": [ # Histogram of l-diversity equivalence class sensitive value frequencies. { # Histogram of l-diversity equivalence class sensitive value frequencies. "bucketSize": "A String", # Total number of equivalence classes in this bucket. @@ -3622,7 +3622,7 @@

Method Details

}, ], }, - "numericalStatsResult": { # Result of the numerical stats computation. # Numerical stats result + "numericalStatsResult": { # Result of the numerical stats computation. # Output only. Numerical stats result "maxValue": { # Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. # Maximum value appearing in the column. "booleanValue": True or False, # boolean "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # date @@ -3684,9 +3684,9 @@

Method Details

], }, "requestedOptions": { # Risk analysis options. # The configuration used for this job. - "jobConfig": { # Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. + "jobConfig": { # Configuration for a risk analysis job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more. # The job config for the risk job. "actions": [ # Actions to execute at the completion of the job. Are executed in the order provided. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -3705,14 +3705,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -3769,7 +3769,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -3821,7 +3821,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -3890,7 +3890,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -3942,7 +3942,7 @@

Method Details

"inferred": { # 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); } # If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data }, "infoType": { # Type of information detected by the API. # A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - "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://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}`. + "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. }, @@ -3987,15 +3987,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateJobTrigger.
-  "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create.
+  "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create.
     "createTime": "A String", # Output only. The creation timestamp of a triggeredJob.
     "description": "A String", # User provided description (max 256 chars)
     "displayName": "A String", # Display name (max 100 chars)
@@ -4018,7 +4018,7 @@ 

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -4037,14 +4037,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -4069,7 +4069,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -4084,14 +4084,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -4117,7 +4117,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -4141,15 +4141,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -4160,7 +4160,7 @@

Method Details

"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://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}`. + "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. }, @@ -4172,11 +4172,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -4189,7 +4189,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -4208,9 +4208,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -4222,7 +4222,7 @@

Method Details

"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://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}`. + "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. }, @@ -4238,7 +4238,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -4257,7 +4257,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -4269,9 +4269,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -4282,7 +4282,7 @@

Method Details

"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://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}`. + "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. }, @@ -4309,9 +4309,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -4338,7 +4338,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -4347,8 +4347,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -4393,17 +4393,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -4428,7 +4428,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -4451,7 +4451,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -4470,14 +4470,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -4502,7 +4502,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -4517,14 +4517,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -4550,7 +4550,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -4574,15 +4574,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -4593,7 +4593,7 @@

Method Details

"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://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}`. + "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. }, @@ -4605,11 +4605,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -4622,7 +4622,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -4641,9 +4641,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -4655,7 +4655,7 @@

Method Details

"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://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}`. + "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. }, @@ -4671,7 +4671,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -4690,7 +4690,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -4702,9 +4702,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -4715,7 +4715,7 @@

Method Details

"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://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}`. + "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. }, @@ -4742,9 +4742,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -4771,7 +4771,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -4780,8 +4780,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -4826,17 +4826,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -4853,7 +4853,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Deletes a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
   name: string, Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)
@@ -4871,7 +4871,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Gets a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
   name: string, Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)
@@ -4883,7 +4883,7 @@ 

Method Details

Returns: An object of the form: - { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -4906,7 +4906,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -4925,14 +4925,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -4957,7 +4957,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -4972,14 +4972,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -5005,7 +5005,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -5029,15 +5029,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -5048,7 +5048,7 @@

Method Details

"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://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}`. + "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. }, @@ -5060,11 +5060,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -5077,7 +5077,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -5096,9 +5096,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -5110,7 +5110,7 @@

Method Details

"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://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}`. + "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. }, @@ -5126,7 +5126,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -5145,7 +5145,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -5157,9 +5157,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -5170,7 +5170,7 @@

Method Details

"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://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}`. + "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. }, @@ -5197,9 +5197,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -5226,7 +5226,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -5235,8 +5235,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -5281,17 +5281,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -5403,7 +5403,7 @@

Method Details

}, ], }, - "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. + "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. @@ -5454,10 +5454,10 @@

Method Details

list(parent, filter=None, locationId=None, orderBy=None, pageSize=None, pageToken=None, type=None, x__xgafv=None) -
Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Lists job triggers. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.
@@ -5478,7 +5478,7 @@ 

Method Details

{ # Response message for ListJobTriggers. "jobTriggers": [ # List of triggeredJobs, up to page_size in ListJobTriggersRequest. - { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -5501,7 +5501,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -5520,14 +5520,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -5552,7 +5552,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -5567,14 +5567,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -5600,7 +5600,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -5624,15 +5624,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -5643,7 +5643,7 @@

Method Details

"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://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}`. + "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. }, @@ -5655,11 +5655,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -5672,7 +5672,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -5691,9 +5691,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -5705,7 +5705,7 @@

Method Details

"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://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}`. + "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. }, @@ -5721,7 +5721,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -5740,7 +5740,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -5752,9 +5752,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -5765,7 +5765,7 @@

Method Details

"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://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}`. + "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. }, @@ -5792,9 +5792,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -5821,7 +5821,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -5830,8 +5830,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -5876,17 +5876,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -5920,7 +5920,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
+  
Updates a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
   name: string, Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`. (required)
@@ -5928,7 +5928,7 @@ 

Method Details

The object takes the form of: { # Request message for UpdateJobTrigger. - "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value. + "jobTrigger": { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -5951,7 +5951,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -5970,14 +5970,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -6002,7 +6002,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -6017,14 +6017,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -6050,7 +6050,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -6074,15 +6074,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -6093,7 +6093,7 @@

Method Details

"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://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}`. + "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. }, @@ -6105,11 +6105,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -6122,7 +6122,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -6141,9 +6141,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -6155,7 +6155,7 @@

Method Details

"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://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}`. + "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. }, @@ -6171,7 +6171,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -6190,7 +6190,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -6202,9 +6202,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -6215,7 +6215,7 @@

Method Details

"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://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}`. + "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. }, @@ -6242,9 +6242,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -6271,7 +6271,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -6280,8 +6280,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -6326,17 +6326,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. @@ -6360,7 +6360,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -6383,7 +6383,7 @@

Method Details

], "inspectJob": { # Controls what and how to inspect for findings. # For inspect jobs, a snapshot of the configuration. "actions": [ # Actions to execute at the completion of the job. - { # A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. + { # A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more. "deidentify": { # Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage # Create a de-identified copy of the input data. "cloudStorageOutput": "A String", # Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket "fileTypesToTransform": [ # List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. @@ -6402,14 +6402,14 @@

Method Details

}, }, }, - "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + "jobNotificationEmails": { # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). # Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts). }, - "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. + "pubSub": { # Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk # Publish a notification to a Pub/Sub topic. "topic": "A String", # Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}. }, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog. }, - "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, @@ -6434,7 +6434,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -6449,14 +6449,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -6482,7 +6482,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -6506,15 +6506,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -6525,7 +6525,7 @@

Method Details

"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://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}`. + "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. }, @@ -6537,11 +6537,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -6554,7 +6554,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -6573,9 +6573,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -6587,7 +6587,7 @@

Method Details

"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://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}`. + "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. }, @@ -6603,7 +6603,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -6622,7 +6622,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -6634,9 +6634,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -6647,7 +6647,7 @@

Method Details

"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://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}`. + "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. }, @@ -6674,9 +6674,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -6703,7 +6703,7 @@

Method Details

}, ], "rowsLimit": "A String", # Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. - "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. + "rowsLimitPercent": 42, # Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead. "sampleMethod": "A String", # How to sample the data. "tableReference": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Complete BigQuery table reference. "datasetId": "A String", # Dataset ID of the table. @@ -6712,8 +6712,8 @@

Method Details

}, }, "cloudStorageOptions": { # Options defining a file or a set of files within a Cloud Storage bucket. # Cloud Storage options. - "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFile": "A String", # Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + "bytesLimitPerFilePercent": 42, # Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). "fileSet": { # Set of files to scan. # The set of one or more files to scan. "regexFileSet": { # Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` # The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. "bucketName": "A String", # The name of a Cloud Storage bucket. Required. @@ -6758,17 +6758,17 @@

Method Details

}, }, "timespanConfig": { # Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery. # Configuration of the timespan of the items to include in scanning. - "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + "enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, }, }, "lastRunTime": "A String", # Output only. The timestamp of the last time this trigger executed. - "name": "A String", # Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. + "name": "A String", # Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. "status": "A String", # Required. A status for this trigger. "triggers": [ # A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. { # What event needs to occur for a new job to be started. diff --git a/docs/dyn/dlp_v2.projects.locations.storedInfoTypes.html b/docs/dyn/dlp_v2.projects.locations.storedInfoTypes.html index 9af8420a87..7676104899 100644 --- a/docs/dyn/dlp_v2.projects.locations.storedInfoTypes.html +++ b/docs/dyn/dlp_v2.projects.locations.storedInfoTypes.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

delete(name, x__xgafv=None)

-

Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

get(name, x__xgafv=None)

-

Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Method Details

close() @@ -103,17 +103,17 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateStoredInfoType.
-  "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Required. Configuration of the storedInfoType to create.
+  "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Required. Configuration of the storedInfoType to create.
     "description": "A String", # Description of the StoredInfoType (max 256 characters).
-    "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://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. # Store dictionary-based CustomInfoType.
+    "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. # Store dictionary-based 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`
       },
@@ -124,7 +124,7 @@ 

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -163,9 +163,9 @@

Method Details

{ # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -176,7 +176,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -229,9 +229,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -242,7 +242,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -298,7 +298,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required)
@@ -316,7 +316,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required)
@@ -330,9 +330,9 @@ 

Method Details

{ # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -343,7 +343,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -396,9 +396,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -409,7 +409,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -465,10 +465,10 @@

Method Details

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -486,9 +486,9 @@ 

Method Details

"storedInfoTypes": [ # List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest. { # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -499,7 +499,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -552,9 +552,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -565,7 +565,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -637,7 +637,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
   name: string, Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required)
@@ -645,9 +645,9 @@ 

Method Details

The object takes the form of: { # Request message for UpdateStoredInfoType. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -658,7 +658,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -696,9 +696,9 @@

Method Details

{ # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -709,7 +709,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -762,9 +762,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -775,7 +775,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index 11a75608e9..eb021b8224 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -129,11 +129,11 @@

Method Details

{ # The profile for a scanned table. "configSnapshot": { # Snapshot of the configurations used to generate the profile. # The snapshot of the configurations used to generate the profile. - "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. + "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. "dataProfileActions": [ # Actions to execute at the completion of the job. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -160,15 +160,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -185,7 +185,7 @@

Method Details

}, }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "location": { # The data that will be profiled. # The data to scan. @@ -200,11 +200,11 @@

Method Details

}, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the DLP API must be enabled. }, - "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. + "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -231,15 +231,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -275,11 +275,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -442,7 +442,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -461,7 +461,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -511,7 +511,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -551,7 +551,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -566,14 +566,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -599,7 +599,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -623,15 +623,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -642,7 +642,7 @@

Method Details

"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://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}`. + "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. }, @@ -654,11 +654,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -671,7 +671,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -690,9 +690,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -704,7 +704,7 @@

Method Details

"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://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}`. + "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. }, @@ -720,7 +720,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -739,7 +739,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -751,9 +751,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -764,7 +764,7 @@

Method Details

"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://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}`. + "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. }, @@ -791,9 +791,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -812,7 +812,7 @@

Method Details

"dataSource": "A String", # A string that identifies the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "datasetId": "A String", # If the resource is BigQuery, the dataset ID. - "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations. + "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://docs.cloud.google.com/bigquery/docs/locations for supported locations. "datasetProjectId": "A String", # The Google Cloud project ID that owns the resource. "domains": [ # Domains associated with the profile. { # A domain represents a thematic category that a data profile can fall under. @@ -833,7 +833,7 @@

Method Details

"estimatedPrevalence": 42, # Approximate percentage of non-null rows that contained data detected by this infotype. "excludedFromAnalysis": True or False, # Whether this infoType was excluded from sensitivity and risk analysis due to factors such as low prevalence (subject to change). "infoType": { # Type of information detected by the API. # The other infoType. - "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://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}`. + "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. }, @@ -845,7 +845,7 @@

Method Details

{ # The infoType details for this column. "estimatedPrevalence": 42, # Not populated for predicted infotypes. "infoType": { # Type of information detected by the API. # The infoType. - "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://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}`. + "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. }, @@ -922,11 +922,11 @@

Method Details

"tableDataProfiles": [ # List of data profiles. { # The profile for a scanned table. "configSnapshot": { # Snapshot of the configurations used to generate the profile. # The snapshot of the configurations used to generate the profile. - "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. + "dataProfileJob": { # Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will. "dataProfileActions": [ # Actions to execute at the completion of the job. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -953,15 +953,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -978,7 +978,7 @@

Method Details

}, }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "location": { # The data that will be profiled. # The data to scan. @@ -993,11 +993,11 @@

Method Details

}, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the DLP API must be enabled. }, - "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. + "discoveryConfig": { # Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). # A copy of the configuration used to generate this profile. "actions": [ # Actions to execute at the completion of scanning. { # A task to execute when a data profile has been generated. "exportData": { # If set, the detailed data profiles will be persisted to the location of your choice whenever updated. # Export data profiles into a provided location. - "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. + "profileTable": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. "datasetId": "A String", # Dataset ID of the table. "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call. "tableId": "A String", # Name of the table. @@ -1024,15 +1024,15 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, - "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). }, - "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. + "publishToDataplexCatalog": { # Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects. # Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile. "lowerDataRiskToLow": True or False, # Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. }, "publishToScc": { # If set, a summary finding will be created or updated in Security Command Center for each profile. # Publishes findings to Security Command Center for each data profile. }, - "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. - "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "tagResources": { # If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. "A String", ], @@ -1068,11 +1068,11 @@

Method Details

], }, ], - "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. "A String", ], "lastRunTime": "A String", # Output only. The timestamp of the last time this config was executed. - "name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + "name": "A String", # Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project "folderId": "A String", # The ID of the folder within an organization to be scanned. @@ -1235,7 +1235,7 @@

Method Details

}, ], }, - "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). + "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules). "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection. { # A single tag to filter against. "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent. @@ -1254,7 +1254,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. }, }, - "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. + "otherCloudTarget": { # Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. # Other clouds target for discovery. The first target to match a resource will be the one applied. "conditions": { # Requirements that must be true before a resource is profiled for the first time. # Optional. In addition to matching the filter, these conditions must be true before a profile is generated. "amazonS3BucketConditions": { # Amazon S3 bucket conditions. # Amazon S3 bucket conditions. "bucketTypes": [ # Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. @@ -1304,7 +1304,7 @@

Method Details

"refreshFrequency": "A String", # Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. }, }, - "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. + "secretsTarget": { # Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center. # Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. }, "vertexDatasetTarget": { # Target used to match against for discovery with Vertex AI datasets. # Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. "conditions": { # Requirements that must be true before a dataset is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. @@ -1344,7 +1344,7 @@

Method Details

"contentOptions": [ # Deprecated and unused. "A String", ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. + "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. @@ -1359,14 +1359,14 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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://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. + "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` }, @@ -1392,7 +1392,7 @@

Method Details

}, }, "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://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}`. + "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. }, @@ -1416,15 +1416,15 @@

Method Details

"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://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. + "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://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. + "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://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}`. + "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. }, @@ -1435,7 +1435,7 @@

Method Details

"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://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}`. + "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. }, @@ -1447,11 +1447,11 @@

Method Details

"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://cloud.google.com/sensitive-data-protection/docs/likelihood). + "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://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}`. + "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. }, @@ -1464,7 +1464,7 @@

Method Details

{ # 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://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}`. + "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. }, @@ -1483,9 +1483,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1497,7 +1497,7 @@

Method Details

"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://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}`. + "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. }, @@ -1513,7 +1513,7 @@

Method Details

}, }, "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://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. + "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` }, @@ -1532,7 +1532,7 @@

Method Details

}, "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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. @@ -1544,9 +1544,9 @@

Method Details

"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://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. + "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://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}`. + "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. }, @@ -1557,7 +1557,7 @@

Method Details

"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://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}`. + "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. }, @@ -1584,9 +1584,9 @@

Method Details

"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://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 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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "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). }, }, }, @@ -1605,7 +1605,7 @@

Method Details

"dataSource": "A String", # A string that identifies the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "datasetId": "A String", # If the resource is BigQuery, the dataset ID. - "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations. + "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://docs.cloud.google.com/bigquery/docs/locations for supported locations. "datasetProjectId": "A String", # The Google Cloud project ID that owns the resource. "domains": [ # Domains associated with the profile. { # A domain represents a thematic category that a data profile can fall under. @@ -1626,7 +1626,7 @@

Method Details

"estimatedPrevalence": 42, # Approximate percentage of non-null rows that contained data detected by this infotype. "excludedFromAnalysis": True or False, # Whether this infoType was excluded from sensitivity and risk analysis due to factors such as low prevalence (subject to change). "infoType": { # Type of information detected by the API. # The other infoType. - "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://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}`. + "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. }, @@ -1638,7 +1638,7 @@

Method Details

{ # The infoType details for this column. "estimatedPrevalence": 42, # Not populated for predicted infotypes. "infoType": { # Type of information detected by the API. # The infoType. - "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://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}`. + "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. }, diff --git a/docs/dyn/dlp_v2.projects.storedInfoTypes.html b/docs/dyn/dlp_v2.projects.storedInfoTypes.html index d8649a2e9e..0817a366d0 100644 --- a/docs/dyn/dlp_v2.projects.storedInfoTypes.html +++ b/docs/dyn/dlp_v2.projects.storedInfoTypes.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

delete(name, x__xgafv=None)

-

Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

get(name, x__xgafv=None)

-

Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

list_next()

Retrieves the next page of results.

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

-

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

+

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Method Details

close() @@ -103,17 +103,17 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for CreateStoredInfoType.
-  "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Required. Configuration of the storedInfoType to create.
+  "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Required. Configuration of the storedInfoType to create.
     "description": "A String", # Description of the StoredInfoType (max 256 characters).
-    "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://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. # Store dictionary-based CustomInfoType.
+    "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. # Store dictionary-based 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`
       },
@@ -124,7 +124,7 @@ 

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -163,9 +163,9 @@

Method Details

{ # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -176,7 +176,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -229,9 +229,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -242,7 +242,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -298,7 +298,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required)
@@ -316,7 +316,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
   name: string, Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required)
@@ -330,9 +330,9 @@ 

Method Details

{ # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -343,7 +343,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -396,9 +396,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -409,7 +409,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -465,10 +465,10 @@

Method Details

list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -486,9 +486,9 @@ 

Method Details

"storedInfoTypes": [ # List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest. { # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -499,7 +499,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -552,9 +552,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -565,7 +565,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -637,7 +637,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
+  
Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
   name: string, Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required)
@@ -645,9 +645,9 @@ 

Method Details

The object takes the form of: { # Request message for UpdateStoredInfoType. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -658,7 +658,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -696,9 +696,9 @@

Method Details

{ # StoredInfoType resource message that contains information about the current version and any pending updates. "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -709,7 +709,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. @@ -762,9 +762,9 @@

Method Details

"name": "A String", # Output only. Resource name. "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. - "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. + "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. # StoredInfoType configuration. "description": "A String", # Description of the StoredInfoType (max 256 characters). - "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://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. # Store dictionary-based CustomInfoType. + "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. # Store dictionary-based 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` }, @@ -775,7 +775,7 @@

Method Details

}, }, "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). - "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. + "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. "name": "A String", # Name describing the field. diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index cd047096bd..bdcfea1e06 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -350,7 +350,7 @@ "infoTypes": { "methods": { "list": { -"description": "Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.", +"description": "Returns a list of the sensitive information types that the DLP API supports. See https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.", "flatPath": "v2/infoTypes", "httpMethod": "GET", "id": "dlp.infoTypes.list", @@ -392,7 +392,7 @@ "infoTypes": { "methods": { "list": { -"description": "Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.", +"description": "Returns a list of the sensitive information types that the DLP API supports. See https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.", "flatPath": "v2/locations/{locationsId}/infoTypes", "httpMethod": "GET", "id": "dlp.locations.infoTypes.list", @@ -440,7 +440,7 @@ "deidentifyTemplates": { "methods": { "create": { -"description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates", "httpMethod": "POST", "id": "dlp.organizations.deidentifyTemplates.create", @@ -449,7 +449,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -468,7 +468,7 @@ ] }, "delete": { -"description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Deletes a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "DELETE", "id": "dlp.organizations.deidentifyTemplates.delete", @@ -493,7 +493,7 @@ ] }, "get": { -"description": "Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Gets a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "GET", "id": "dlp.organizations.deidentifyTemplates.get", @@ -518,7 +518,7 @@ ] }, "list": { -"description": "Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Lists DeidentifyTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates", "httpMethod": "GET", "id": "dlp.organizations.deidentifyTemplates.list", @@ -548,7 +548,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -564,7 +564,7 @@ ] }, "patch": { -"description": "Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Updates the DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "PATCH", "id": "dlp.organizations.deidentifyTemplates.patch", @@ -596,7 +596,7 @@ "inspectTemplates": { "methods": { "create": { -"description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates", "httpMethod": "POST", "id": "dlp.organizations.inspectTemplates.create", @@ -605,7 +605,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -624,7 +624,7 @@ ] }, "delete": { -"description": "Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Deletes an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "DELETE", "id": "dlp.organizations.inspectTemplates.delete", @@ -649,7 +649,7 @@ ] }, "get": { -"description": "Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "GET", "id": "dlp.organizations.inspectTemplates.get", @@ -674,7 +674,7 @@ ] }, "list": { -"description": "Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates", "httpMethod": "GET", "id": "dlp.organizations.inspectTemplates.list", @@ -704,7 +704,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -720,7 +720,7 @@ ] }, "patch": { -"description": "Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Updates the InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "PATCH", "id": "dlp.organizations.inspectTemplates.patch", @@ -1021,7 +1021,7 @@ "deidentifyTemplates": { "methods": { "create": { -"description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates", "httpMethod": "POST", "id": "dlp.organizations.locations.deidentifyTemplates.create", @@ -1030,7 +1030,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1049,7 +1049,7 @@ ] }, "delete": { -"description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Deletes a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "DELETE", "id": "dlp.organizations.locations.deidentifyTemplates.delete", @@ -1074,7 +1074,7 @@ ] }, "get": { -"description": "Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Gets a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "GET", "id": "dlp.organizations.locations.deidentifyTemplates.get", @@ -1099,7 +1099,7 @@ ] }, "list": { -"description": "Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Lists DeidentifyTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates", "httpMethod": "GET", "id": "dlp.organizations.locations.deidentifyTemplates.list", @@ -1129,7 +1129,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1145,7 +1145,7 @@ ] }, "patch": { -"description": "Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Updates the DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "PATCH", "id": "dlp.organizations.locations.deidentifyTemplates.patch", @@ -1328,7 +1328,7 @@ "dlpJobs": { "methods": { "list": { -"description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", +"description": "Lists DlpJobs that match the specified filter in the request. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/dlpJobs", "httpMethod": "GET", "id": "dlp.organizations.locations.dlpJobs.list", @@ -1363,7 +1363,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1498,7 +1498,7 @@ "infoTypes": { "methods": { "list": { -"description": "Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.", +"description": "Returns a list of the sensitive information types that the DLP API supports. See https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/infoTypes", "httpMethod": "GET", "id": "dlp.organizations.locations.infoTypes.list", @@ -1542,7 +1542,7 @@ "inspectTemplates": { "methods": { "create": { -"description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates", "httpMethod": "POST", "id": "dlp.organizations.locations.inspectTemplates.create", @@ -1551,7 +1551,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1570,7 +1570,7 @@ ] }, "delete": { -"description": "Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Deletes an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "DELETE", "id": "dlp.organizations.locations.inspectTemplates.delete", @@ -1595,7 +1595,7 @@ ] }, "get": { -"description": "Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "GET", "id": "dlp.organizations.locations.inspectTemplates.get", @@ -1620,7 +1620,7 @@ ] }, "list": { -"description": "Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates", "httpMethod": "GET", "id": "dlp.organizations.locations.inspectTemplates.list", @@ -1650,7 +1650,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1666,7 +1666,7 @@ ] }, "patch": { -"description": "Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Updates the InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "PATCH", "id": "dlp.organizations.locations.inspectTemplates.patch", @@ -1698,7 +1698,7 @@ "jobTriggers": { "methods": { "create": { -"description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers", "httpMethod": "POST", "id": "dlp.organizations.locations.jobTriggers.create", @@ -1707,7 +1707,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1726,7 +1726,7 @@ ] }, "delete": { -"description": "Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Deletes a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "DELETE", "id": "dlp.organizations.locations.jobTriggers.delete", @@ -1751,7 +1751,7 @@ ] }, "get": { -"description": "Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Gets a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "GET", "id": "dlp.organizations.locations.jobTriggers.get", @@ -1776,7 +1776,7 @@ ] }, "list": { -"description": "Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Lists job triggers. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers", "httpMethod": "GET", "id": "dlp.organizations.locations.jobTriggers.list", @@ -1811,7 +1811,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1842,7 +1842,7 @@ ] }, "patch": { -"description": "Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Updates a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "PATCH", "id": "dlp.organizations.locations.jobTriggers.patch", @@ -1949,7 +1949,7 @@ "storedInfoTypes": { "methods": { "create": { -"description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes", "httpMethod": "POST", "id": "dlp.organizations.locations.storedInfoTypes.create", @@ -1958,7 +1958,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1977,7 +1977,7 @@ ] }, "delete": { -"description": "Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "DELETE", "id": "dlp.organizations.locations.storedInfoTypes.delete", @@ -2002,7 +2002,7 @@ ] }, "get": { -"description": "Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "GET", "id": "dlp.organizations.locations.storedInfoTypes.get", @@ -2027,7 +2027,7 @@ ] }, "list": { -"description": "Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes", "httpMethod": "GET", "id": "dlp.organizations.locations.storedInfoTypes.list", @@ -2057,7 +2057,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -2073,7 +2073,7 @@ ] }, "patch": { -"description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "PATCH", "id": "dlp.organizations.locations.storedInfoTypes.patch", @@ -2207,7 +2207,7 @@ "storedInfoTypes": { "methods": { "create": { -"description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes", "httpMethod": "POST", "id": "dlp.organizations.storedInfoTypes.create", @@ -2216,7 +2216,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2235,7 +2235,7 @@ ] }, "delete": { -"description": "Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "DELETE", "id": "dlp.organizations.storedInfoTypes.delete", @@ -2260,7 +2260,7 @@ ] }, "get": { -"description": "Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "GET", "id": "dlp.organizations.storedInfoTypes.get", @@ -2285,7 +2285,7 @@ ] }, "list": { -"description": "Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes", "httpMethod": "GET", "id": "dlp.organizations.storedInfoTypes.list", @@ -2315,7 +2315,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2331,7 +2331,7 @@ ] }, "patch": { -"description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "PATCH", "id": "dlp.organizations.storedInfoTypes.patch", @@ -2367,7 +2367,7 @@ "content": { "methods": { "deidentify": { -"description": "De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", +"description": "De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://docs.cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/content:deidentify", "httpMethod": "POST", "id": "dlp.projects.content.deidentify", @@ -2376,7 +2376,7 @@ ], "parameters": { "parent": { -"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2395,7 +2395,7 @@ ] }, "inspect": { -"description": "Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,", +"description": "Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text,", "flatPath": "v2/projects/{projectsId}/content:inspect", "httpMethod": "POST", "id": "dlp.projects.content.inspect", @@ -2404,7 +2404,7 @@ ], "parameters": { "parent": { -"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2423,7 +2423,7 @@ ] }, "reidentify": { -"description": "Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.", +"description": "Re-identifies content that has been de-identified. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.", "flatPath": "v2/projects/{projectsId}/content:reidentify", "httpMethod": "POST", "id": "dlp.projects.content.reidentify", @@ -2432,7 +2432,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2455,7 +2455,7 @@ "deidentifyTemplates": { "methods": { "create": { -"description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates", "httpMethod": "POST", "id": "dlp.projects.deidentifyTemplates.create", @@ -2464,7 +2464,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2483,7 +2483,7 @@ ] }, "delete": { -"description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Deletes a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "DELETE", "id": "dlp.projects.deidentifyTemplates.delete", @@ -2508,7 +2508,7 @@ ] }, "get": { -"description": "Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Gets a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "GET", "id": "dlp.projects.deidentifyTemplates.get", @@ -2533,7 +2533,7 @@ ] }, "list": { -"description": "Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Lists DeidentifyTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates", "httpMethod": "GET", "id": "dlp.projects.deidentifyTemplates.list", @@ -2563,7 +2563,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2579,7 +2579,7 @@ ] }, "patch": { -"description": "Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Updates the DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "PATCH", "id": "dlp.projects.deidentifyTemplates.patch", @@ -2611,7 +2611,7 @@ "dlpJobs": { "methods": { "cancel": { -"description": "Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", +"description": "Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel", "httpMethod": "POST", "id": "dlp.projects.dlpJobs.cancel", @@ -2639,7 +2639,7 @@ ] }, "create": { -"description": "Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", +"description": "Creates a new job to inspect storage or calculate risk metrics. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/dlpJobs", "httpMethod": "POST", "id": "dlp.projects.dlpJobs.create", @@ -2648,7 +2648,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2667,7 +2667,7 @@ ] }, "delete": { -"description": "Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", +"description": "Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}", "httpMethod": "DELETE", "id": "dlp.projects.dlpJobs.delete", @@ -2692,7 +2692,7 @@ ] }, "get": { -"description": "Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", +"description": "Gets the latest state of a long-running DlpJob. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}", "httpMethod": "GET", "id": "dlp.projects.dlpJobs.get", @@ -2717,7 +2717,7 @@ ] }, "list": { -"description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", +"description": "Lists DlpJobs that match the specified filter in the request. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/dlpJobs", "httpMethod": "GET", "id": "dlp.projects.dlpJobs.list", @@ -2752,7 +2752,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2787,7 +2787,7 @@ "image": { "methods": { "redact": { -"description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.", +"description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://docs.cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.", "flatPath": "v2/projects/{projectsId}/image:redact", "httpMethod": "POST", "id": "dlp.projects.image.redact", @@ -2796,7 +2796,7 @@ ], "parameters": { "parent": { -"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2819,7 +2819,7 @@ "inspectTemplates": { "methods": { "create": { -"description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates", "httpMethod": "POST", "id": "dlp.projects.inspectTemplates.create", @@ -2828,7 +2828,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2847,7 +2847,7 @@ ] }, "delete": { -"description": "Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Deletes an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "DELETE", "id": "dlp.projects.inspectTemplates.delete", @@ -2872,7 +2872,7 @@ ] }, "get": { -"description": "Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "GET", "id": "dlp.projects.inspectTemplates.get", @@ -2897,7 +2897,7 @@ ] }, "list": { -"description": "Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates", "httpMethod": "GET", "id": "dlp.projects.inspectTemplates.list", @@ -2927,7 +2927,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2943,7 +2943,7 @@ ] }, "patch": { -"description": "Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Updates the InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "PATCH", "id": "dlp.projects.inspectTemplates.patch", @@ -3003,7 +3003,7 @@ ] }, "create": { -"description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers", "httpMethod": "POST", "id": "dlp.projects.jobTriggers.create", @@ -3012,7 +3012,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -3031,7 +3031,7 @@ ] }, "delete": { -"description": "Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Deletes a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}", "httpMethod": "DELETE", "id": "dlp.projects.jobTriggers.delete", @@ -3056,7 +3056,7 @@ ] }, "get": { -"description": "Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Gets a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}", "httpMethod": "GET", "id": "dlp.projects.jobTriggers.get", @@ -3081,7 +3081,7 @@ ] }, "list": { -"description": "Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Lists job triggers. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers", "httpMethod": "GET", "id": "dlp.projects.jobTriggers.list", @@ -3116,7 +3116,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -3147,7 +3147,7 @@ ] }, "patch": { -"description": "Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Updates a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}", "httpMethod": "PATCH", "id": "dlp.projects.jobTriggers.patch", @@ -3448,7 +3448,7 @@ "content": { "methods": { "deidentify": { -"description": "De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", +"description": "De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://docs.cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/content:deidentify", "httpMethod": "POST", "id": "dlp.projects.locations.content.deidentify", @@ -3457,7 +3457,7 @@ ], "parameters": { "parent": { -"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3476,7 +3476,7 @@ ] }, "inspect": { -"description": "Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,", +"description": "Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text,", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/content:inspect", "httpMethod": "POST", "id": "dlp.projects.locations.content.inspect", @@ -3485,7 +3485,7 @@ ], "parameters": { "parent": { -"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3504,7 +3504,7 @@ ] }, "reidentify": { -"description": "Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.", +"description": "Re-identifies content that has been de-identified. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/content:reidentify", "httpMethod": "POST", "id": "dlp.projects.locations.content.reidentify", @@ -3513,7 +3513,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3682,7 +3682,7 @@ "deidentifyTemplates": { "methods": { "create": { -"description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates", "httpMethod": "POST", "id": "dlp.projects.locations.deidentifyTemplates.create", @@ -3691,7 +3691,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3710,7 +3710,7 @@ ] }, "delete": { -"description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Deletes a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.deidentifyTemplates.delete", @@ -3735,7 +3735,7 @@ ] }, "get": { -"description": "Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Gets a DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "GET", "id": "dlp.projects.locations.deidentifyTemplates.get", @@ -3760,7 +3760,7 @@ ] }, "list": { -"description": "Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Lists DeidentifyTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates", "httpMethod": "GET", "id": "dlp.projects.locations.deidentifyTemplates.list", @@ -3790,7 +3790,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3806,7 +3806,7 @@ ] }, "patch": { -"description": "Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", +"description": "Updates the DeidentifyTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}", "httpMethod": "PATCH", "id": "dlp.projects.locations.deidentifyTemplates.patch", @@ -3989,7 +3989,7 @@ "dlpJobs": { "methods": { "cancel": { -"description": "Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", +"description": "Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:cancel", "httpMethod": "POST", "id": "dlp.projects.locations.dlpJobs.cancel", @@ -4017,7 +4017,7 @@ ] }, "create": { -"description": "Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", +"description": "Creates a new job to inspect storage or calculate risk metrics. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs", "httpMethod": "POST", "id": "dlp.projects.locations.dlpJobs.create", @@ -4026,7 +4026,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4045,7 +4045,7 @@ ] }, "delete": { -"description": "Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", +"description": "Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.dlpJobs.delete", @@ -4098,7 +4098,7 @@ ] }, "get": { -"description": "Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", +"description": "Gets the latest state of a long-running DlpJob. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}", "httpMethod": "GET", "id": "dlp.projects.locations.dlpJobs.get", @@ -4151,7 +4151,7 @@ ] }, "list": { -"description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", +"description": "Lists DlpJobs that match the specified filter in the request. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://docs.cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs", "httpMethod": "GET", "id": "dlp.projects.locations.dlpJobs.list", @@ -4186,7 +4186,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4321,7 +4321,7 @@ "image": { "methods": { "redact": { -"description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.", +"description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://docs.cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/image:redact", "httpMethod": "POST", "id": "dlp.projects.locations.image.redact", @@ -4330,7 +4330,7 @@ ], "parameters": { "parent": { -"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4353,7 +4353,7 @@ "infoTypes": { "methods": { "list": { -"description": "Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.", +"description": "Returns a list of the sensitive information types that the DLP API supports. See https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/infoTypes", "httpMethod": "GET", "id": "dlp.projects.locations.infoTypes.list", @@ -4397,7 +4397,7 @@ "inspectTemplates": { "methods": { "create": { -"description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates", "httpMethod": "POST", "id": "dlp.projects.locations.inspectTemplates.create", @@ -4406,7 +4406,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4425,7 +4425,7 @@ ] }, "delete": { -"description": "Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Deletes an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.inspectTemplates.delete", @@ -4450,7 +4450,7 @@ ] }, "get": { -"description": "Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Gets an InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "GET", "id": "dlp.projects.locations.inspectTemplates.get", @@ -4475,7 +4475,7 @@ ] }, "list": { -"description": "Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Lists InspectTemplates. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates", "httpMethod": "GET", "id": "dlp.projects.locations.inspectTemplates.list", @@ -4505,7 +4505,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4521,7 +4521,7 @@ ] }, "patch": { -"description": "Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", +"description": "Updates the InspectTemplate. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}", "httpMethod": "PATCH", "id": "dlp.projects.locations.inspectTemplates.patch", @@ -4581,7 +4581,7 @@ ] }, "create": { -"description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers", "httpMethod": "POST", "id": "dlp.projects.locations.jobTriggers.create", @@ -4590,7 +4590,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4609,7 +4609,7 @@ ] }, "delete": { -"description": "Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Deletes a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.jobTriggers.delete", @@ -4634,7 +4634,7 @@ ] }, "get": { -"description": "Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Gets a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "GET", "id": "dlp.projects.locations.jobTriggers.get", @@ -4687,7 +4687,7 @@ ] }, "list": { -"description": "Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Lists job triggers. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers", "httpMethod": "GET", "id": "dlp.projects.locations.jobTriggers.list", @@ -4722,7 +4722,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4753,7 +4753,7 @@ ] }, "patch": { -"description": "Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", +"description": "Updates a job trigger. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}", "httpMethod": "PATCH", "id": "dlp.projects.locations.jobTriggers.patch", @@ -4860,7 +4860,7 @@ "storedInfoTypes": { "methods": { "create": { -"description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes", "httpMethod": "POST", "id": "dlp.projects.locations.storedInfoTypes.create", @@ -4869,7 +4869,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4888,7 +4888,7 @@ ] }, "delete": { -"description": "Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "DELETE", "id": "dlp.projects.locations.storedInfoTypes.delete", @@ -4913,7 +4913,7 @@ ] }, "get": { -"description": "Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "GET", "id": "dlp.projects.locations.storedInfoTypes.get", @@ -4938,7 +4938,7 @@ ] }, "list": { -"description": "Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes", "httpMethod": "GET", "id": "dlp.projects.locations.storedInfoTypes.list", @@ -4968,7 +4968,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4984,7 +4984,7 @@ ] }, "patch": { -"description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "PATCH", "id": "dlp.projects.locations.storedInfoTypes.patch", @@ -5118,7 +5118,7 @@ "storedInfoTypes": { "methods": { "create": { -"description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Creates a pre-built stored infoType to be used for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes", "httpMethod": "POST", "id": "dlp.projects.storedInfoTypes.create", @@ -5127,7 +5127,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5146,7 +5146,7 @@ ] }, "delete": { -"description": "Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Deletes a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "DELETE", "id": "dlp.projects.storedInfoTypes.delete", @@ -5171,7 +5171,7 @@ ] }, "get": { -"description": "Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Gets a stored infoType. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "GET", "id": "dlp.projects.storedInfoTypes.get", @@ -5196,7 +5196,7 @@ ] }, "list": { -"description": "Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Lists stored infoTypes. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes", "httpMethod": "GET", "id": "dlp.projects.storedInfoTypes.list", @@ -5226,7 +5226,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://docs.cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5242,7 +5242,7 @@ ] }, "patch": { -"description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", +"description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.", "flatPath": "v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}", "httpMethod": "PATCH", "id": "dlp.projects.storedInfoTypes.patch", @@ -5274,11 +5274,11 @@ } } }, -"revision": "20260704", +"revision": "20260725", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { -"description": "A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more.", +"description": "A task to execute on the completion of a job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more.", "id": "GooglePrivacyDlpV2Action", "properties": { "deidentify": { @@ -5287,7 +5287,7 @@ }, "jobNotificationEmails": { "$ref": "GooglePrivacyDlpV2JobNotificationEmails", -"description": "Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts)." +"description": "Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts)." }, "pubSub": { "$ref": "GooglePrivacyDlpV2PublishToPubSub", @@ -5343,7 +5343,7 @@ "description": "Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings." }, "infoTypes": { -"description": "A list of image-supported infoTypes\u2014excluding [document infoTypes](https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)\u2014to 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.", +"description": "A list of image-supported infoTypes\u2014excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)\u2014to 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.", "items": { "$ref": "GooglePrivacyDlpV2InfoType" }, @@ -5562,27 +5562,33 @@ "properties": { "categoricalStatsResult": { "$ref": "GooglePrivacyDlpV2CategoricalStatsResult", -"description": "Categorical stats result" +"description": "Output only. Categorical stats result", +"readOnly": true }, "deltaPresenceEstimationResult": { "$ref": "GooglePrivacyDlpV2DeltaPresenceEstimationResult", -"description": "Delta-presence result" +"description": "Output only. Delta-presence result", +"readOnly": true }, "kAnonymityResult": { "$ref": "GooglePrivacyDlpV2KAnonymityResult", -"description": "K-anonymity result" +"description": "Output only. K-anonymity result", +"readOnly": true }, "kMapEstimationResult": { "$ref": "GooglePrivacyDlpV2KMapEstimationResult", -"description": "K-map result" +"description": "Output only. K-map result", +"readOnly": true }, "lDiversityResult": { "$ref": "GooglePrivacyDlpV2LDiversityResult", -"description": "L-divesity result" +"description": "Output only. L-divesity result", +"readOnly": true }, "numericalStatsResult": { "$ref": "GooglePrivacyDlpV2NumericalStatsResult", -"description": "Numerical stats result" +"description": "Output only. Numerical stats result", +"readOnly": true }, "requestedOptions": { "$ref": "GooglePrivacyDlpV2RequestedRiskAnalysisOptions", @@ -5766,7 +5772,7 @@ "type": "string" }, "rowsLimitPercent": { -"description": "Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead.", +"description": "Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead.", "format": "int32", "type": "integer" }, @@ -5927,7 +5933,7 @@ "type": "object" }, "GooglePrivacyDlpV2BucketingConfig": { -"description": "Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more.", +"description": "Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more.", "id": "GooglePrivacyDlpV2BucketingConfig", "properties": { "buckets": { @@ -6143,7 +6149,7 @@ "type": "object" }, "GooglePrivacyDlpV2CloudSqlIamCredential": { -"description": "Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication.", +"description": "Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://docs.cloud.google.com/sql/docs/postgres/authentication and https://docs.cloud.google.com/sql/docs/mysql/authentication.", "id": "GooglePrivacyDlpV2CloudSqlIamCredential", "properties": {}, "type": "object" @@ -6225,12 +6231,12 @@ "id": "GooglePrivacyDlpV2CloudStorageOptions", "properties": { "bytesLimitPerFile": { -"description": "Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).", +"description": "Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).", "format": "int64", "type": "string" }, "bytesLimitPerFilePercent": { -"description": "Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).", +"description": "Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://docs.cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).", "format": "int32", "type": "integer" }, @@ -6448,7 +6454,7 @@ "type": "string" }, "datasetLocation": { -"description": "If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations.", +"description": "If supported, the location where the dataset's data is stored. See https://docs.cloud.google.com/bigquery/docs/locations for supported BigQuery locations.", "type": "string" }, "datasetProjectId": { @@ -6710,7 +6716,7 @@ }, "table": { "$ref": "GooglePrivacyDlpV2Table", -"description": "Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more." +"description": "Structured content for inspection. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more." }, "value": { "description": "String data to inspect or redact.", @@ -7078,7 +7084,7 @@ "type": "object" }, "GooglePrivacyDlpV2CryptoHashConfig": { -"description": "Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more.", +"description": "Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more.", "id": "GooglePrivacyDlpV2CryptoHashConfig", "properties": { "cryptoKey": { @@ -7108,7 +7114,7 @@ "type": "object" }, "GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig": { -"description": "Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs.", +"description": "Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://docs.cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs.", "id": "GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig", "properties": { "commonAlphabet": { @@ -7148,7 +7154,7 @@ }, "surrogateInfoType": { "$ref": "GooglePrivacyDlpV2InfoType", -"description": "The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: \u29ddMY_TOKEN_TYPE" +"description": "The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: \u29ddMY_TOKEN_TYPE" } }, "type": "object" @@ -7245,7 +7251,7 @@ }, "publishToChronicle": { "$ref": "GooglePrivacyDlpV2PublishToChronicle", -"description": "Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download)." +"description": "Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://docs.cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download)." }, "publishToDataplexCatalog": { "$ref": "GooglePrivacyDlpV2PublishToDataplexCatalog", @@ -7332,7 +7338,7 @@ }, "infotype": { "$ref": "GooglePrivacyDlpV2InfoType", -"description": "The [type of content](https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference) that might have been found." +"description": "The [type of content](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference) that might have been found." }, "location": { "$ref": "GooglePrivacyDlpV2DataProfileFindingLocation", @@ -7397,7 +7403,7 @@ "type": "object" }, "GooglePrivacyDlpV2DataProfileJobConfig": { -"description": "Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention).", +"description": "Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention).", "id": "GooglePrivacyDlpV2DataProfileJobConfig", "properties": { "dataProfileActions": { @@ -7408,7 +7414,7 @@ "type": "array" }, "inspectTemplates": { -"description": "Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including \"global\"). Each region is scanned using the applicable template. If no region-specific template is specified, but a \"global\" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.", +"description": "Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including \"global\"). Each region is scanned using the applicable template. If no region-specific template is specified, but a \"global\" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.", "items": { "type": "string" }, @@ -7624,7 +7630,7 @@ "type": "object" }, "GooglePrivacyDlpV2DateShiftConfig": { -"description": "Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more.", +"description": "Shifts dates by random number of days, with option to be consistent for the same context. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more.", "id": "GooglePrivacyDlpV2DateShiftConfig", "properties": { "context": { @@ -7850,7 +7856,7 @@ "type": "object" }, "GooglePrivacyDlpV2DeidentifyTemplate": { -"description": "DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.", +"description": "DeidentifyTemplates contains instructions on how to de-identify content. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.", "id": "GooglePrivacyDlpV2DeidentifyTemplate", "properties": { "createTime": { @@ -7989,7 +7995,7 @@ "type": "object" }, "GooglePrivacyDlpV2Dictionary": { -"description": "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://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.", +"description": "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.", "id": "GooglePrivacyDlpV2Dictionary", "properties": { "cloudStoragePath": { @@ -8171,8 +8177,8 @@ "enumDescriptions": [ "Unused.", "Scan buckets regardless of the attribute.", -"Buckets with [Autoclass](https://cloud.google.com/storage/docs/autoclass) disabled. Only one of AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set.", -"Buckets with [Autoclass](https://cloud.google.com/storage/docs/autoclass) enabled. Only one of AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. Scanning Autoclass-enabled buckets can affect object storage classes." +"Buckets with [Autoclass](https://docs.cloud.google.com/storage/docs/autoclass) disabled. Only one of AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set.", +"Buckets with [Autoclass](https://docs.cloud.google.com/storage/docs/autoclass) enabled. Only one of AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. Scanning Autoclass-enabled buckets can affect object storage classes." ], "type": "string" }, @@ -8257,7 +8263,7 @@ "type": "object" }, "GooglePrivacyDlpV2DiscoveryConfig": { -"description": "Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention).", +"description": "Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#retention).", "id": "GooglePrivacyDlpV2DiscoveryConfig", "properties": { "actions": { @@ -8286,7 +8292,7 @@ "type": "array" }, "inspectTemplates": { -"description": "Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including \"global\"). Each region is scanned using the applicable template. If no region-specific template is specified, but a \"global\" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.", +"description": "Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including \"global\"). Each region is scanned using the applicable template. If no region-specific template is specified, but a \"global\" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.", "items": { "type": "string" }, @@ -8299,7 +8305,8 @@ "type": "string" }, "name": { -"description": "Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`.", +"description": "Output only. Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`.", +"readOnly": true, "type": "string" }, "orgConfig": { @@ -8679,10 +8686,11 @@ "id": "GooglePrivacyDlpV2DlpJob", "properties": { "actionDetails": { -"description": "Events that should occur after the job has completed.", +"description": "Output only. Events that should occur after the job has completed.", "items": { "$ref": "GooglePrivacyDlpV2ActionDetails" }, +"readOnly": true, "type": "array" }, "createTime": { @@ -8838,8 +8846,8 @@ "One or more machine learning models are present.", "A table appears to contain text embeddings.", "A table appears to contain embeddings of any type (for example, text, image, multimodal). The `TEXT_EMBEDDING` signal might also be present if the table contains text embeddings.", -"The [Cloud SQL Vertex AI](https://cloud.google.com/sql/docs/postgres/integrate-cloud-sql-with-vertex-ai) plugin is installed on the database.", -"Support for [Cloud SQL vector embeddings](https://cloud.google.com/sql/docs/mysql/enable-vector-search) is enabled on the database.", +"The [Cloud SQL Vertex AI](https://docs.cloud.google.com/sql/docs/postgres/integrate-cloud-sql-with-vertex-ai) plugin is installed on the database.", +"Support for [Cloud SQL vector embeddings](https://docs.cloud.google.com/sql/docs/mysql/enable-vector-search) is enabled on the database.", "Source code is present.", "If the service determines the category type. For example, Vertex AI assets would always have a `Category` of `AI`." ], @@ -8924,7 +8932,7 @@ "description": "Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings." }, "infoTypes": { -"description": "A list of image-supported infoTypes\u2014excluding [document infoTypes](https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)\u2014to 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.", +"description": "A list of image-supported infoTypes\u2014excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)\u2014to 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.", "items": { "$ref": "GooglePrivacyDlpV2InfoType" }, @@ -8998,7 +9006,7 @@ "properties": { "profileTable": { "$ref": "GooglePrivacyDlpV2BigQueryTable", -"description": "Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary." +"description": "Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Data Studio reports](https://docs.cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary." }, "sampleFindingsTable": { "$ref": "GooglePrivacyDlpV2BigQueryTable", @@ -9221,7 +9229,7 @@ }, "includeTags": { "$ref": "GooglePrivacyDlpV2TagFilters", -"description": "Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules)." +"description": "Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://docs.cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules)." } }, "type": "object" @@ -9280,7 +9288,7 @@ "type": "boolean" }, "fileStoreLocation": { -"description": "The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints", +"description": "The location of the file store. * Cloud Storage: https://docs.cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints", "type": "string" }, "fileStorePath": { @@ -9537,7 +9545,7 @@ "type": "object" }, "GooglePrivacyDlpV2FixedSizeBucketingConfig": { -"description": "Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with \"10-20\". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more.", +"description": "Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with \"10-20\". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more.", "id": "GooglePrivacyDlpV2FixedSizeBucketingConfig", "properties": { "bucketSize": { @@ -9618,7 +9626,7 @@ }, "proximity": { "$ref": "GooglePrivacyDlpV2Proximity", -"description": "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values)." +"description": "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)." } }, "type": "object" @@ -9858,7 +9866,7 @@ "id": "GooglePrivacyDlpV2InfoType", "properties": { "name": { -"description": "Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://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}`.", +"description": "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}`.", "type": "string" }, "sensitivityScore": { @@ -10046,6 +10054,11 @@ "infoTypes": { "$ref": "GooglePrivacyDlpV2InfoTypes", "description": "match any of these info types." +}, +"minCount": { +"description": "Optional. The minimum total number of findings of all matching info types required for this condition to evaluate to true. Defaults to 1 if unset.", +"format": "int64", +"type": "string" } }, "type": "object" @@ -10283,7 +10296,7 @@ "type": "array" }, "customInfoTypes": { -"description": "CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more.", +"description": "CustomInfoTypes provided by the user. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more.", "items": { "$ref": "GooglePrivacyDlpV2CustomInfoType" }, @@ -10298,7 +10311,7 @@ "type": "boolean" }, "infoTypes": { -"description": "Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://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.", +"description": "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.", "items": { "$ref": "GooglePrivacyDlpV2InfoType" }, @@ -10309,7 +10322,7 @@ "description": "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." }, "minLikelihood": { -"description": "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://cloud.google.com/sensitive-data-protection/docs/likelihood).", +"description": "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).", "enum": [ "LIKELIHOOD_UNSPECIFIED", "VERY_UNLIKELY", @@ -10389,7 +10402,8 @@ }, "result": { "$ref": "GooglePrivacyDlpV2Result", -"description": "A summary of the outcome of this inspection job." +"description": "Output only. A summary of the outcome of this inspection job.", +"readOnly": true } }, "type": "object" @@ -10439,7 +10453,7 @@ "type": "object" }, "GooglePrivacyDlpV2InspectTemplate": { -"description": "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://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.", +"description": "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.", "id": "GooglePrivacyDlpV2InspectTemplate", "properties": { "allowLimitedAvailabilityInfoTypes": { @@ -10519,13 +10533,13 @@ "type": "object" }, "GooglePrivacyDlpV2JobNotificationEmails": { -"description": "Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts).", +"description": "Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://docs.cloud.google.com/resource-manager/docs/managing-notification-contacts).", "id": "GooglePrivacyDlpV2JobNotificationEmails", "properties": {}, "type": "object" }, "GooglePrivacyDlpV2JobTrigger": { -"description": "Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.", +"description": "Contains a configuration to make API calls on a repeating basis. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.", "id": "GooglePrivacyDlpV2JobTrigger", "properties": { "createTime": { @@ -10561,7 +10575,8 @@ "type": "string" }, "name": { -"description": "Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`.", +"description": "Output only. Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`.", +"readOnly": true, "type": "string" }, "status": { @@ -10829,7 +10844,7 @@ "type": "object" }, "GooglePrivacyDlpV2KmsWrappedCryptoKey": { -"description": "Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing).", +"description": "Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://docs.cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing).", "id": "GooglePrivacyDlpV2KmsWrappedCryptoKey", "properties": { "cryptoKeyName": { @@ -10972,7 +10987,7 @@ "type": "object" }, "GooglePrivacyDlpV2LargeCustomDictionaryConfig": { -"description": "Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements.", +"description": "Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements.", "id": "GooglePrivacyDlpV2LargeCustomDictionaryConfig", "properties": { "bigQueryField": { @@ -11489,7 +11504,7 @@ "type": "object" }, "GooglePrivacyDlpV2OtherCloudDiscoveryTarget": { -"description": "Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature.", +"description": "Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://docs.cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature.", "id": "GooglePrivacyDlpV2OtherCloudDiscoveryTarget", "properties": { "conditions": { @@ -11892,7 +11907,7 @@ "type": "integer" }, "windowBefore": { -"description": "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://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values).", +"description": "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).", "format": "int32", "type": "integer" } @@ -12018,7 +12033,7 @@ "type": "object" }, "GooglePrivacyDlpV2PublishFindingsToDataplexCatalog": { -"description": "Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect", +"description": "Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect", "id": "GooglePrivacyDlpV2PublishFindingsToDataplexCatalog", "properties": {}, "type": "object" @@ -12036,7 +12051,7 @@ "type": "object" }, "GooglePrivacyDlpV2PublishToDataplexCatalog": { -"description": "Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects.", +"description": "Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://docs.cloud.google.com/sensitive-data-protection/docs/add-aspects.", "id": "GooglePrivacyDlpV2PublishToDataplexCatalog", "properties": { "lowerDataRiskToLow": { @@ -12047,7 +12062,7 @@ "type": "object" }, "GooglePrivacyDlpV2PublishToPubSub": { -"description": "Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk", +"description": "Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk", "id": "GooglePrivacyDlpV2PublishToPubSub", "properties": { "topic": { @@ -12400,7 +12415,7 @@ "properties": { "wordList": { "$ref": "GooglePrivacyDlpV2WordList", -"description": "A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries." +"description": "A list of words to select from for random replacement. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries." } }, "type": "object" @@ -12451,7 +12466,8 @@ }, "snapshotInspectTemplate": { "$ref": "GooglePrivacyDlpV2InspectTemplate", -"description": "If run with an InspectTemplate, a snapshot of its state at the time of this run." +"description": "Output only. If run with an InspectTemplate, a snapshot of its state at the time of this run.", +"readOnly": true } }, "type": "object" @@ -12501,7 +12517,7 @@ "type": "object" }, "GooglePrivacyDlpV2RiskAnalysisJobConfig": { -"description": "Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more.", +"description": "Configuration for a risk analysis job. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more.", "id": "GooglePrivacyDlpV2RiskAnalysisJobConfig", "properties": { "actions": { @@ -12647,7 +12663,7 @@ "type": "object" }, "GooglePrivacyDlpV2SecretsDiscoveryTarget": { -"description": "Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center.", +"description": "Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center.", "id": "GooglePrivacyDlpV2SecretsDiscoveryTarget", "properties": {}, "type": "object" @@ -12797,7 +12813,7 @@ "type": "object" }, "GooglePrivacyDlpV2StoredInfoTypeConfig": { -"description": "Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes.", +"description": "Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes.", "id": "GooglePrivacyDlpV2StoredInfoTypeConfig", "properties": { "description": { @@ -12944,13 +12960,13 @@ "type": "object" }, "GooglePrivacyDlpV2SurrogateType": { -"description": "Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://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`.", +"description": "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`.", "id": "GooglePrivacyDlpV2SurrogateType", "properties": {}, "type": "object" }, "GooglePrivacyDlpV2Table": { -"description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more.", +"description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://docs.cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more.", "id": "GooglePrivacyDlpV2Table", "properties": { "headers": { @@ -12996,7 +13012,7 @@ "type": "string" }, "datasetLocation": { -"description": "If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations.", +"description": "If supported, the location where the dataset's data is stored. See https://docs.cloud.google.com/bigquery/docs/locations for supported locations.", "type": "string" }, "datasetProjectId": { @@ -13264,11 +13280,11 @@ "type": "object" }, "GooglePrivacyDlpV2TagResources": { -"description": "If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag.", +"description": "If set, attaches the [tags] (https://docs.cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://docs.cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag.", "id": "GooglePrivacyDlpV2TagResources", "properties": { "lowerDataRiskToLow": { -"description": "Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles.", +"description": "Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://docs.cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles.", "type": "boolean" }, "profileGenerationsToTag": { @@ -13384,7 +13400,7 @@ "id": "GooglePrivacyDlpV2TimespanConfig", "properties": { "enableAutoPopulationOfTimespanConfig": { -"description": "When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation.", +"description": "When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation.", "type": "boolean" }, "endTime": { @@ -13399,7 +13415,7 @@ }, "timestampField": { "$ref": "GooglePrivacyDlpV2FieldId", -"description": "Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation." +"description": "Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://docs.cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://docs.cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation." } }, "type": "object" From c59d8c4d7a30f3d6af966f3003050f27fe4d8321 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:05 +0000 Subject: [PATCH 47/84] feat(drive): update the api #### drive:v3 The following keys were added: - schemas.Approval.properties.fileContentChangeBehavior (Total Keys: 2) - schemas.StartApprovalRequest.properties.fileContentChangeBehavior.type (Total Keys: 1) --- docs/dyn/drive_v3.approvals.html | 9 ++++ docs/dyn/drive_v3.changes.html | 6 +-- docs/dyn/drive_v3.comments.html | 2 +- docs/dyn/drive_v3.drives.html | 2 +- docs/dyn/drive_v3.files.html | 18 +++---- docs/dyn/drive_v3.permissions.html | 2 +- docs/dyn/drive_v3.replies.html | 2 +- docs/dyn/drive_v3.revisions.html | 2 +- .../discovery_cache/documents/drive.v3.json | 49 +++++++++++++++---- 9 files changed, 65 insertions(+), 27 deletions(-) diff --git a/docs/dyn/drive_v3.approvals.html b/docs/dyn/drive_v3.approvals.html index f1b846cb4b..61ce1636b6 100644 --- a/docs/dyn/drive_v3.approvals.html +++ b/docs/dyn/drive_v3.approvals.html @@ -132,6 +132,7 @@

Method Details

"completeTime": "A String", # Output only. The time the approval was completed. "createTime": "A String", # Output only. The time the approval was created. "dueTime": "A String", # The time that the approval is due. + "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -188,6 +189,7 @@

Method Details

"completeTime": "A String", # Output only. The time the approval was completed. "createTime": "A String", # Output only. The time the approval was created. "dueTime": "A String", # The time that the approval is due. + "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -249,6 +251,7 @@

Method Details

"completeTime": "A String", # Output only. The time the approval was completed. "createTime": "A String", # Output only. The time the approval was created. "dueTime": "A String", # The time that the approval is due. + "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -305,6 +308,7 @@

Method Details

"completeTime": "A String", # Output only. The time the approval was completed. "createTime": "A String", # Output only. The time the approval was created. "dueTime": "A String", # The time that the approval is due. + "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -354,6 +358,7 @@

Method Details

"completeTime": "A String", # Output only. The time the approval was completed. "createTime": "A String", # Output only. The time the approval was created. "dueTime": "A String", # The time that the approval is due. + "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -406,6 +411,7 @@

Method Details

"completeTime": "A String", # Output only. The time the approval was completed. "createTime": "A String", # Output only. The time the approval was created. "dueTime": "A String", # The time that the approval is due. + "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -491,6 +497,7 @@

Method Details

"completeTime": "A String", # Output only. The time the approval was completed. "createTime": "A String", # Output only. The time the approval was created. "dueTime": "A String", # The time that the approval is due. + "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -531,6 +538,7 @@

Method Details

{ # Allows creating an approval on a file. "dueTime": "A String", # Optional. The time that the approval is due. + "fileContentChangeBehavior": "A String", # Optional. The behavior of the approval when the file content changes. "lockFile": True or False, # Optional. Whether to lock the file when starting the approval. "message": "A String", # Optional. A message to send to reviewers when notifying them of the approval request. "reviewerEmails": [ # Required. The emails of the users who are set to review the approval. @@ -551,6 +559,7 @@

Method Details

"completeTime": "A String", # Output only. The time the approval was completed. "createTime": "A String", # Output only. The time the approval was created. "dueTime": "A String", # The time that the approval is due. + "fileContentChangeBehavior": "A String", # Output only. The behavior of the approval when the file content changes. "initiator": { # Information about a Drive user. # The user that requested the approval. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. diff --git a/docs/dyn/drive_v3.changes.html b/docs/dyn/drive_v3.changes.html index 1c36ff14de..2df39ecbae 100644 --- a/docs/dyn/drive_v3.changes.html +++ b/docs/dyn/drive_v3.changes.html @@ -131,7 +131,7 @@

Method Details

includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. includeRemoved: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. includeTeamDriveItems: boolean, Deprecated: Use `includeItemsFromAllDrives` instead. - pageSize: integer, The maximum number of changes to return per page. + pageSize: integer, The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. restrictToMyDrive: boolean, Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive. spaces: string, A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. @@ -208,7 +208,7 @@

Method Details

}, "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. + "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility). "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. @@ -619,7 +619,7 @@

Method Details

includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. includeRemoved: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. includeTeamDriveItems: boolean, Deprecated: Use `includeItemsFromAllDrives` instead. - pageSize: integer, The maximum number of changes to return per page. + pageSize: integer, The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. restrictToMyDrive: boolean, Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive. spaces: string, A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. diff --git a/docs/dyn/drive_v3.comments.html b/docs/dyn/drive_v3.comments.html index 6263e6efa7..e98e1a5f8f 100644 --- a/docs/dyn/drive_v3.comments.html +++ b/docs/dyn/drive_v3.comments.html @@ -313,7 +313,7 @@

Method Details

Args: fileId: string, The ID of the file. (required) includeDeleted: boolean, Whether to include deleted comments. Deleted comments will not include their original content. - pageSize: integer, The maximum number of comments to return per page. + pageSize: integer, The maximum number of comments to return. The service may return fewer than this value. If unspecified, at most 20 comments will be returned. The maximum value is 100; values above 100 will be coerced to 100. pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. startModifiedTime: string, The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time). x__xgafv: string, V1 error format. diff --git a/docs/dyn/drive_v3.drives.html b/docs/dyn/drive_v3.drives.html index 23354916d6..5684784e4c 100644 --- a/docs/dyn/drive_v3.drives.html +++ b/docs/dyn/drive_v3.drives.html @@ -384,7 +384,7 @@

Method Details

 Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](https://developers.google.com/workspace/drive/api/guides/search-shareddrives) guide.
 
 Args:
-  pageSize: integer, Maximum number of shared drives to return per page.
+  pageSize: integer, The maximum number of shared drives to return. The service may return fewer than this value. If unspecified, at most 10 shared drives will be returned. The maximum value is 100; values above 100 will be coerced to 100.
   pageToken: string, Page token for shared drives.
   q: string, Query string for searching shared drives.
   useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.
diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html
index 578368bf99..3402232637 100644
--- a/docs/dyn/drive_v3.files.html
+++ b/docs/dyn/drive_v3.files.html
@@ -153,7 +153,7 @@ 

Method Details

}, "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. + "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility). "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. @@ -478,7 +478,7 @@

Method Details

}, "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. + "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility). "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. @@ -796,7 +796,7 @@

Method Details

}, "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. + "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility). "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. @@ -1124,7 +1124,7 @@

Method Details

}, "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. + "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility). "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. @@ -1597,7 +1597,7 @@

Method Details

}, "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. + "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility). "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. @@ -1938,7 +1938,7 @@

Method Details

includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. includeTeamDriveItems: boolean, Deprecated: Use `includeItemsFromAllDrives` instead. orderBy: string, A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. Avoid using this key for queries on large item collections as it might result in timeouts or other issues. For time-related sorting on large item collections, use `modifiedTime desc` instead. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`. - pageSize: integer, The maximum number of files to return per page. Pages may be partial or empty even before reaching the end of the file list. If unspecified, at most 100 files are returned for shared drives, and the entire list of files for non-shared drives. The maximum value is 100; values above 100 are changed to 100. + pageSize: integer, The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned for shared drives, and the entire list of files for non-shared drives. The maximum value is 1000; values above 1000 will be coerced to 1000. pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response. q: string, A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files). spaces: string, A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization). @@ -1962,7 +1962,7 @@

Method Details

}, "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. + "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility). "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. @@ -2463,7 +2463,7 @@

Method Details

}, "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. + "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility). "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. @@ -2792,7 +2792,7 @@

Method Details

}, "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. + "canAccessViaGenAi": True or False, # Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility). "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. diff --git a/docs/dyn/drive_v3.permissions.html b/docs/dyn/drive_v3.permissions.html index e596e46b27..aeedd7445d 100644 --- a/docs/dyn/drive_v3.permissions.html +++ b/docs/dyn/drive_v3.permissions.html @@ -271,7 +271,7 @@

Method Details

Args: fileId: string, The ID of the file or shared drive. (required) includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. - pageSize: integer, The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned. + pageSize: integer, The maximum number of permissions to return. The service may return fewer than this value. If unspecified, at most 100 permissions will be returned for shared drives, and the entire list of permissions for non-shared drives. The maximum value is 100; values above 100 will be coerced to 100. pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. diff --git a/docs/dyn/drive_v3.replies.html b/docs/dyn/drive_v3.replies.html index 95cf03ef4b..b812a04acf 100644 --- a/docs/dyn/drive_v3.replies.html +++ b/docs/dyn/drive_v3.replies.html @@ -230,7 +230,7 @@

Method Details

fileId: string, The ID of the file. (required) commentId: string, The ID of the comment. (required) includeDeleted: boolean, Whether to include deleted replies. Deleted replies don't include their original content. - pageSize: integer, The maximum number of replies to return per page. + pageSize: integer, The maximum number of replies to return. The service may return fewer than this value. If unspecified, at most 20 replies will be returned. The maximum value is 100; values above 100 will be coerced to 100. pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/drive_v3.revisions.html b/docs/dyn/drive_v3.revisions.html index 3992636f2a..fb6885bb6e 100644 --- a/docs/dyn/drive_v3.revisions.html +++ b/docs/dyn/drive_v3.revisions.html @@ -183,7 +183,7 @@

Method Details

Args: fileId: string, The ID of the file. (required) - pageSize: integer, The maximum number of revisions to return per page. + pageSize: integer, The maximum number of revisions to return. The service may return fewer than this value. If unspecified, at most 200 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. x__xgafv: string, V1 error format. Allowed values diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 8b04756040..1aa1e332c2 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -721,7 +721,7 @@ }, "pageSize": { "default": "100", -"description": "The maximum number of changes to return per page.", +"description": "The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "maximum": "1000", @@ -833,7 +833,7 @@ }, "pageSize": { "default": "100", -"description": "The maximum number of changes to return per page.", +"description": "The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "maximum": "1000", @@ -1049,7 +1049,7 @@ }, "pageSize": { "default": "20", -"description": "The maximum number of comments to return per page.", +"description": "The maximum number of comments to return. The service may return fewer than this value. If unspecified, at most 20 comments will be returned. The maximum value is 100; values above 100 will be coerced to 100.", "format": "int32", "location": "query", "maximum": "100", @@ -1241,7 +1241,7 @@ "parameters": { "pageSize": { "default": "10", -"description": "Maximum number of shared drives to return per page.", +"description": "The maximum number of shared drives to return. The service may return fewer than this value. If unspecified, at most 10 shared drives will be returned. The maximum value is 100; values above 100 will be coerced to 100.", "format": "int32", "location": "query", "maximum": "100", @@ -1829,7 +1829,7 @@ }, "pageSize": { "default": "100", -"description": "The maximum number of files to return per page. Pages may be partial or empty even before reaching the end of the file list. If unspecified, at most 100 files are returned for shared drives, and the entire list of files for non-shared drives. The maximum value is 100; values above 100 are changed to 100.", +"description": "The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned for shared drives, and the entire list of files for non-shared drives. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "maximum": "1000", @@ -2379,7 +2379,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.", +"description": "The maximum number of permissions to return. The service may return fewer than this value. If unspecified, at most 100 permissions will be returned for shared drives, and the entire list of permissions for non-shared drives. The maximum value is 100; values above 100 will be coerced to 100.", "format": "int32", "location": "query", "maximum": "100", @@ -2650,7 +2650,7 @@ }, "pageSize": { "default": "20", -"description": "The maximum number of replies to return per page.", +"description": "The maximum number of replies to return. The service may return fewer than this value. If unspecified, at most 20 replies will be returned. The maximum value is 100; values above 100 will be coerced to 100.", "format": "int32", "location": "query", "maximum": "100", @@ -2813,7 +2813,7 @@ }, "pageSize": { "default": "200", -"description": "The maximum number of revisions to return per page.", +"description": "The maximum number of revisions to return. The service may return fewer than this value. If unspecified, at most 200 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "maximum": "1000", @@ -3038,7 +3038,7 @@ } } }, -"revision": "20260624", +"revision": "20260720", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3440,6 +3440,21 @@ "format": "google-datetime", "type": "string" }, +"fileContentChangeBehavior": { +"description": "Output only. The behavior of the approval when the file content changes.", +"enum": [ +"FILE_CONTENT_CHANGE_BEHAVIOR_UNSPECIFIED", +"RESET_APPROVAL", +"NO_APPROVAL_ACTION" +], +"enumDescriptions": [ +"The behavior is unspecified.", +"Any ReviewerResponse with a Response of APPROVED will be reset to NO_DECISION when the file content changes while the approval has a Status of IN_PROGRESS. When the approval has a Status of APPROVED and RESET_APPROVAL is selected, the file is locked.", +"No action is taken when the file content changes." +], +"readOnly": true, +"type": "string" +}, "initiator": { "$ref": "User", "description": "The user that requested the approval." @@ -4150,7 +4165,7 @@ "type": "boolean" }, "canAccessViaGenAi": { -"description": "Whether the current user can access this file via Gen AI features.", +"description": "Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility).", "type": "boolean" }, "canAddChildren": { @@ -5629,6 +5644,20 @@ "format": "google-datetime", "type": "string" }, +"fileContentChangeBehavior": { +"description": "Optional. The behavior of the approval when the file content changes.", +"enum": [ +"FILE_CONTENT_CHANGE_BEHAVIOR_UNSPECIFIED", +"RESET_APPROVAL", +"NO_APPROVAL_ACTION" +], +"enumDescriptions": [ +"The behavior is unspecified.", +"Any ReviewerResponse with a Response of APPROVED will be reset to NO_DECISION when the file content changes while the approval has a Status of IN_PROGRESS. When the approval has a Status of APPROVED and RESET_APPROVAL is selected, the file is locked.", +"No action is taken when the file content changes." +], +"type": "string" +}, "lockFile": { "description": "Optional. Whether to lock the file when starting the approval.", "type": "boolean" From c0b250511c9634bd23e40b65539d1e495c463730 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:05 +0000 Subject: [PATCH 48/84] feat(file): update the api #### file:v1 The following keys were added: - endpoints (Total Keys: 1) #### file:v1beta1 The following keys were added: - endpoints (Total Keys: 1) - schemas.FileShareConfig.properties.restoreConfig.$ref (Total Keys: 1) - schemas.RestoreConfig (Total Keys: 4) --- ..._v1beta1.projects.locations.instances.html | 20 ++ .../discovery_cache/documents/file.v1.json | 239 +++++++++++++++- .../documents/file.v1beta1.json | 257 +++++++++++++++++- 3 files changed, 514 insertions(+), 2 deletions(-) diff --git a/docs/dyn/file_v1beta1.projects.locations.instances.html b/docs/dyn/file_v1beta1.projects.locations.instances.html index adafa4702b..e93944fd77 100644 --- a/docs/dyn/file_v1beta1.projects.locations.instances.html +++ b/docs/dyn/file_v1beta1.projects.locations.instances.html @@ -178,6 +178,11 @@

Method Details

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], + "restoreConfig": { # Optional configuration for restore backup operations. # Optional. Input only. Specifies options for restoring from a backup source. Use this field to configure a partial restore, allowing recovery of specific files or directories instead of the entire backup. This field is only valid if the source oneof is set to `source_backup` or `source_backupdr_backup`. If this field is not provided, restoring from a backup will perform a full restore. + "pathPatterns": [ # Optional. Example: If you want to restore `/mnt/share/dir1/file.txt`, the path pattern must be `/dir1/file.txt`. If you want to restore `/mnt/share/dir1/`, the path pattern must be `/dir1`. Currently only single path is supported, Glob patterns are not supported. + "A String", + ], + }, "sourceBackup": "A String", # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from. "sourceBackupdrBackup": "A String", # The resource name of the BackupDR backup, in the format `projects/{project_id}/locations/{location_id}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id}`, }, @@ -373,6 +378,11 @@

Method Details

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], + "restoreConfig": { # Optional configuration for restore backup operations. # Optional. Input only. Specifies options for restoring from a backup source. Use this field to configure a partial restore, allowing recovery of specific files or directories instead of the entire backup. This field is only valid if the source oneof is set to `source_backup` or `source_backupdr_backup`. If this field is not provided, restoring from a backup will perform a full restore. + "pathPatterns": [ # Optional. Example: If you want to restore `/mnt/share/dir1/file.txt`, the path pattern must be `/dir1/file.txt`. If you want to restore `/mnt/share/dir1/`, the path pattern must be `/dir1`. Currently only single path is supported, Glob patterns are not supported. + "A String", + ], + }, "sourceBackup": "A String", # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from. "sourceBackupdrBackup": "A String", # The resource name of the BackupDR backup, in the format `projects/{project_id}/locations/{location_id}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id}`, }, @@ -509,6 +519,11 @@

Method Details

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], + "restoreConfig": { # Optional configuration for restore backup operations. # Optional. Input only. Specifies options for restoring from a backup source. Use this field to configure a partial restore, allowing recovery of specific files or directories instead of the entire backup. This field is only valid if the source oneof is set to `source_backup` or `source_backupdr_backup`. If this field is not provided, restoring from a backup will perform a full restore. + "pathPatterns": [ # Optional. Example: If you want to restore `/mnt/share/dir1/file.txt`, the path pattern must be `/dir1/file.txt`. If you want to restore `/mnt/share/dir1/`, the path pattern must be `/dir1`. Currently only single path is supported, Glob patterns are not supported. + "A String", + ], + }, "sourceBackup": "A String", # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from. "sourceBackupdrBackup": "A String", # The resource name of the BackupDR backup, in the format `projects/{project_id}/locations/{location_id}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id}`, }, @@ -654,6 +669,11 @@

Method Details

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], + "restoreConfig": { # Optional configuration for restore backup operations. # Optional. Input only. Specifies options for restoring from a backup source. Use this field to configure a partial restore, allowing recovery of specific files or directories instead of the entire backup. This field is only valid if the source oneof is set to `source_backup` or `source_backupdr_backup`. If this field is not provided, restoring from a backup will perform a full restore. + "pathPatterns": [ # Optional. Example: If you want to restore `/mnt/share/dir1/file.txt`, the path pattern must be `/dir1/file.txt`. If you want to restore `/mnt/share/dir1/`, the path pattern must be `/dir1`. Currently only single path is supported, Glob patterns are not supported. + "A String", + ], + }, "sourceBackup": "A String", # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from. "sourceBackupdrBackup": "A String", # The resource name of the BackupDR backup, in the format `projects/{project_id}/locations/{location_id}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id}`, }, diff --git a/googleapiclient/discovery_cache/documents/file.v1.json b/googleapiclient/discovery_cache/documents/file.v1.json index 241bffa493..edf39dd8d4 100644 --- a/googleapiclient/discovery_cache/documents/file.v1.json +++ b/googleapiclient/discovery_cache/documents/file.v1.json @@ -15,6 +15,243 @@ "description": "The Cloud Filestore API is used for creating and managing cloud file servers.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/filestore/", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west15.rep.googleapis.com/", +"location": "europe-west15" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-west8.rep.googleapis.com/", +"location": "us-west8" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -969,7 +1206,7 @@ } } }, -"revision": "20260422", +"revision": "20260710", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { diff --git a/googleapiclient/discovery_cache/documents/file.v1beta1.json b/googleapiclient/discovery_cache/documents/file.v1beta1.json index 17837bbe1e..8e9f228c26 100644 --- a/googleapiclient/discovery_cache/documents/file.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/file.v1beta1.json @@ -15,6 +15,243 @@ "description": "The Cloud Filestore API is used for creating and managing cloud file servers.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/filestore/", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west15.rep.googleapis.com/", +"location": "europe-west15" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://file.us-west8.rep.googleapis.com/", +"location": "us-west8" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1196,7 +1433,7 @@ } } }, -"revision": "20260612", +"revision": "20260710", "rootUrl": "https://file.googleapis.com/", "schemas": { "AcquireShareRequest": { @@ -1473,6 +1710,10 @@ }, "type": "array" }, +"restoreConfig": { +"$ref": "RestoreConfig", +"description": "Optional. Input only. Specifies options for restoring from a backup source. Use this field to configure a partial restore, allowing recovery of specific files or directories instead of the entire backup. This field is only valid if the source oneof is set to `source_backup` or `source_backupdr_backup`. If this field is not provided, restoring from a backup will perform a full restore." +}, "sourceBackup": { "description": "The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from.", "type": "string" @@ -2722,6 +2963,20 @@ }, "type": "object" }, +"RestoreConfig": { +"description": "Optional configuration for restore backup operations.", +"id": "RestoreConfig", +"properties": { +"pathPatterns": { +"description": "Optional. Example: If you want to restore `/mnt/share/dir1/file.txt`, the path pattern must be `/dir1/file.txt`. If you want to restore `/mnt/share/dir1/`, the path pattern must be `/dir1`. Currently only single path is supported, Glob patterns are not supported.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "RestoreInstanceRequest": { "description": "RestoreInstanceRequest restores an existing instance's file share from a backup.", "id": "RestoreInstanceRequest", From 7d4c0a5949f987eff984449746f9c157959cc4b5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:05 +0000 Subject: [PATCH 49/84] feat(firebaseappcheck): update the api #### firebaseappcheck:v1 The following keys were deleted: - resources.projects.resources.apps.methods.exchangeSafetyNetToken (Total Keys: 13) - resources.projects.resources.apps.resources.safetyNetConfig (Total Keys: 44) - schemas.GoogleFirebaseAppcheckV1BatchGetSafetyNetConfigsResponse (Total Keys: 5) - schemas.GoogleFirebaseAppcheckV1ExchangeSafetyNetTokenRequest (Total Keys: 4) - schemas.GoogleFirebaseAppcheckV1SafetyNetConfig (Total Keys: 6) The following keys were added: - schemas.GoogleFirebaseAppcheckV1ExchangeCustomTokenRequest.properties.jti.type (Total Keys: 1) #### firebaseappcheck:v1beta The following keys were deleted: - resources.projects.resources.apps.methods.exchangeSafetyNetToken (Total Keys: 13) - resources.projects.resources.apps.resources.safetyNetConfig (Total Keys: 44) - schemas.GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse (Total Keys: 5) - schemas.GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest (Total Keys: 4) - schemas.GoogleFirebaseAppcheckV1betaSafetyNetConfig (Total Keys: 6) --- ...appcheck_v1.projects.apps.debugTokens.html | 12 +- .../firebaseappcheck_v1.projects.apps.html | 36 +-- ...ck_v1.projects.apps.recaptchaV3Config.html | 4 +- ...firebaseappcheck_v1.projects.services.html | 42 ++-- ...v1.projects.services.resourcePolicies.html | 24 +- ...heck_v1beta.projects.apps.debugTokens.html | 12 +- ...firebaseappcheck_v1beta.projects.apps.html | 38 +-- ...1beta.projects.apps.recaptchaV3Config.html | 4 +- ...baseappcheck_v1beta.projects.services.html | 42 ++-- ...ta.projects.services.resourcePolicies.html | 24 +- .../documents/firebaseappcheck.v1.json | 227 +++--------------- .../documents/firebaseappcheck.v1beta.json | 225 ++--------------- 12 files changed, 137 insertions(+), 553 deletions(-) diff --git a/docs/dyn/firebaseappcheck_v1.projects.apps.debugTokens.html b/docs/dyn/firebaseappcheck_v1.projects.apps.debugTokens.html index 3660ba2d34..a093fa80df 100644 --- a/docs/dyn/firebaseappcheck_v1.projects.apps.debugTokens.html +++ b/docs/dyn/firebaseappcheck_v1.projects.apps.debugTokens.html @@ -114,7 +114,7 @@

Method Details

"displayName": "A String", # Required. A human readable display name used to identify this debug token. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` - "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. + "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. } @@ -130,7 +130,7 @@

Method Details

"displayName": "A String", # Required. A human readable display name used to identify this debug token. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` - "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. + "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. }
@@ -172,7 +172,7 @@

Method Details

"displayName": "A String", # Required. A human readable display name used to identify this debug token. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` - "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. + "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. }
@@ -199,7 +199,7 @@

Method Details

"displayName": "A String", # Required. A human readable display name used to identify this debug token. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` - "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. + "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. }, ], @@ -234,7 +234,7 @@

Method Details

"displayName": "A String", # Required. A human readable display name used to identify this debug token. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` - "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. + "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. } @@ -251,7 +251,7 @@

Method Details

"displayName": "A String", # Required. A human readable display name used to identify this debug token. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` - "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. + "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. }
diff --git a/docs/dyn/firebaseappcheck_v1.projects.apps.html b/docs/dyn/firebaseappcheck_v1.projects.apps.html index 9cbcf64883..042bc05eca 100644 --- a/docs/dyn/firebaseappcheck_v1.projects.apps.html +++ b/docs/dyn/firebaseappcheck_v1.projects.apps.html @@ -104,11 +104,6 @@

Instance Methods

Returns the recaptchaV3Config Resource.

-

- safetyNetConfig() -

-

Returns the safetyNetConfig Resource.

-

close()

Close httplib2 connections.

@@ -136,9 +131,6 @@

Instance Methods

exchangeRecaptchaV3Token(app, body=None, x__xgafv=None)

Validates a [reCAPTCHA v3 response token](https://developers.google.com/recaptcha/docs/v3). If valid, returns an AppCheckToken.

-

- exchangeSafetyNetToken(app, body=None, x__xgafv=None)

-

Validates a [SafetyNet token](https://developer.android.com/training/safetynet/attestation#request-attestation-step). If valid, returns an AppCheckToken.

generateAppAttestChallenge(app, body=None, x__xgafv=None)

Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.

@@ -225,6 +217,7 @@

Method Details

{ # Request message for the ExchangeCustomToken method. "customToken": "A String", # Required. A custom token signed using your project's Admin SDK service account credentials. + "jti": "A String", # Optional. When `limited_use` is set to `true`, this field specifies the desired `jti` claim (Section 4.1.7 of RFC 7519) in the returned App Check token. *Limited use* App Check tokens with the same `jti` will be counted as the same token for the purposes of replay protection. An error is returned if this field is specified without setting `limited_use` to `true`. The size of this field is limited to 500 bytes. If specified, its length must be at least 16 bytes. If this field is omitted or is empty and `limited_use` is set to `true`, a randomly generated `jti` claim with length between 16 and 500 bytes (inclusive) will be used in the returned App Check token. Leaving this field empty is only recommended if your custom attestation provider itself is not vulnerable to replay attacks. When `limited_use` is set to `false`, the presence and the contents of the `jti` claim in the returned App Check token are unspecified. To ensure that the returned App Check token is eligible for limited-use functionality, set `limited_use` to `true`. "limitedUse": True or False, # Specifies whether this attestation is for use in a *limited use* (`true`) or *session based* (`false`) context. To enable this attestation to be used with the *replay protection* feature, set this to `true`. The default value is `false`. } @@ -382,33 +375,6 @@

Method Details

}
-
- exchangeSafetyNetToken(app, body=None, x__xgafv=None) -
Validates a [SafetyNet token](https://developer.android.com/training/safetynet/attestation#request-attestation-step). If valid, returns an AppCheckToken.
-
-Args:
-  app: string, Required. The relative resource name of the Android app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for the ExchangeSafetyNetToken method.
-  "safetyNetToken": "A String", # Required. The [SafetyNet attestation response](https://developer.android.com/training/safetynet/attestation#request-attestation-step) issued to your app.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Encapsulates an *App Check token*, which are used to access backend services protected by App Check.
-  "token": "A String", # The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and GCP project. This token is used to access Google services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK or third-party libraries.
-  "ttl": "A String", # The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.
-}
-
-
generateAppAttestChallenge(app, body=None, x__xgafv=None)
Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.
diff --git a/docs/dyn/firebaseappcheck_v1.projects.apps.recaptchaV3Config.html b/docs/dyn/firebaseappcheck_v1.projects.apps.recaptchaV3Config.html
index 49c2bca27c..ea4c0eb320 100644
--- a/docs/dyn/firebaseappcheck_v1.projects.apps.recaptchaV3Config.html
+++ b/docs/dyn/firebaseappcheck_v1.projects.apps.recaptchaV3Config.html
@@ -85,7 +85,7 @@ 

Instance Methods

Gets the RecaptchaV3Config for the specified app. For security reasons, the `site_secret` field is never populated in the response.

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

-

Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.

+

Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA v3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.

Method Details

batchGet(parent, names=None, x__xgafv=None) @@ -145,7 +145,7 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.
+  
Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA v3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.
 
 Args:
   name: string, Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ``` (required)
diff --git a/docs/dyn/firebaseappcheck_v1.projects.services.html b/docs/dyn/firebaseappcheck_v1.projects.services.html
index 29a27a87c3..87aff81931 100644
--- a/docs/dyn/firebaseappcheck_v1.projects.services.html
+++ b/docs/dyn/firebaseappcheck_v1.projects.services.html
@@ -110,11 +110,11 @@ 

Method Details

{ # Request message for the BatchUpdateServices method. "requests": [ # Required. The request messages specifying the Services to update. A maximum of 100 objects can be updated in a batch. { # Request message for the UpdateService method as well as an individual update message for the BatchUpdateServices method. - "service": { # The enforcement configuration for a Firebase service supported by App Check. # Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) - "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "service": { # The enforcement configuration for a Firebase service supported by App Check. # Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the Service.name field for a list of supported service IDs. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this service. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. - "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) - "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation. + "replayProtection": "A String", # Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }, "updateMask": "A String", # Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`. @@ -134,10 +134,10 @@

Method Details

{ # Response message for the BatchUpdateServices method. "services": [ # Service objects after the updates have been applied. { # The enforcement configuration for a Firebase service supported by App Check. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this service. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. - "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) - "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation. + "replayProtection": "A String", # Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }, ], @@ -154,7 +154,7 @@

Method Details

Gets the Service configuration for the specified service name.
 
 Args:
-  name: string, Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) (required)
+  name: string, Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the Service.name field for a list of supported service IDs. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -164,10 +164,10 @@ 

Method Details

An object of the form: { # The enforcement configuration for a Firebase service supported by App Check. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this service. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. - "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) - "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation. + "replayProtection": "A String", # Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }
@@ -192,10 +192,10 @@

Method Details

"nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListServices to find the next group of Services. Page tokens are short-lived and should not be persisted. "services": [ # The Services retrieved. { # The enforcement configuration for a Firebase service supported by App Check. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this service. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. - "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) - "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation. + "replayProtection": "A String", # Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }, ], @@ -221,15 +221,15 @@

Method Details

Updates the specified Service configuration.
 
 Args:
-  name: string, Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) (required)
+  name: string, Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # The enforcement configuration for a Firebase service supported by App Check.
-  "enforcementMode": "A String", # Required. The App Check enforcement mode for this service.
+  "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this service.
   "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.
-  "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS)
-  "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`.
+  "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation.
+  "replayProtection": "A String", # Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`.
   "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated.
 }
 
@@ -243,10 +243,10 @@ 

Method Details

An object of the form: { # The enforcement configuration for a Firebase service supported by App Check. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this service. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. - "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) - "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation. + "replayProtection": "A String", # Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }
diff --git a/docs/dyn/firebaseappcheck_v1.projects.services.resourcePolicies.html b/docs/dyn/firebaseappcheck_v1.projects.services.resourcePolicies.html index 63ccd60208..a65b867e09 100644 --- a/docs/dyn/firebaseappcheck_v1.projects.services.resourcePolicies.html +++ b/docs/dyn/firebaseappcheck_v1.projects.services.resourcePolicies.html @@ -111,8 +111,8 @@

Method Details

{ # Request message for the BatchUpdateResourcePolicies method. "requests": [ # Required. The request messages specifying the ResourcePolicy objects to update. A maximum of 100 objects can be updated in a batch. { # Request message for the UpdateResourcePolicy method as well as an individual update message for the BatchUpdateResourcePolicies method. - "resourcePolicy": { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. # Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service. + "resourcePolicy": { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. # Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. @@ -135,7 +135,7 @@

Method Details

{ # Response message for the BatchUpdateResourcePolicies method. "resourcePolicies": [ # ResourcePolicy objects after the updates have been applied. { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. @@ -155,12 +155,12 @@

Method Details

Creates the specified ResourcePolicy configuration.
 
 Args:
-  parent: string, Required. The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) (required)
+  parent: string, Required. The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration.
-  "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service.
+  "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode.
   "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.
   "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.
   "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.
@@ -176,7 +176,7 @@ 

Method Details

An object of the form: { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. @@ -208,7 +208,7 @@

Method Details

Gets the requested ResourcePolicy configuration.
 
 Args:
-  name: string, Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) (required)
+  name: string, Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -218,7 +218,7 @@ 

Method Details

An object of the form: { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. @@ -231,7 +231,7 @@

Method Details

Lists all ResourcePolicy configurations for the specified project and service.
 
 Args:
-  parent: string, Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) (required)
+  parent: string, Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs. (required)
   filter: string, Optional. Filters the results by the specified rule. For the exact syntax of this field, please consult the [AIP-160](https://google.aip.dev/160) standard. Currently, since the only fields in the ResourcePolicy resource are the scalar fields `enforcement_mode` and `target_resource`, this method does not support the traversal operator (`.`) or the has operator (`:`). Here are some examples of valid filters: * `enforcement_mode = ENFORCED` * `target_resource = "//oauth2.googleapis.com/projects/12345/oauthClients/"` * `enforcement_mode = ENFORCED AND target_resource = "//oauth2.googleapis.com/projects/12345/oauthClients/"`
   pageSize: integer, The maximum number of ResourcePolicy objects to return in the response. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.
   pageToken: string, Token returned from a previous call to ListResourcePolicies indicating where in the set of ResourcePolicy objects to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourcePolicies must match the call that provided the page token; if they do not match, the result is undefined.
@@ -247,7 +247,7 @@ 

Method Details

"nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListResourcePolicies to find the next group of ResourcePolicy objects. Page tokens are short-lived and should not be persisted. "resourcePolicies": [ # The ResourcePolicy objects retrieved. { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. @@ -281,7 +281,7 @@

Method Details

The object takes the form of: { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. @@ -298,7 +298,7 @@

Method Details

An object of the form: { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.debugTokens.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.debugTokens.html index 742dde5392..ad4d62f1ef 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.apps.debugTokens.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.debugTokens.html @@ -114,7 +114,7 @@

Method Details

"displayName": "A String", # Required. A human readable display name used to identify this debug token. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` - "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. + "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. } @@ -130,7 +130,7 @@

Method Details

"displayName": "A String", # Required. A human readable display name used to identify this debug token. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` - "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. + "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. }
@@ -172,7 +172,7 @@

Method Details

"displayName": "A String", # Required. A human readable display name used to identify this debug token. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` - "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. + "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. }
@@ -199,7 +199,7 @@

Method Details

"displayName": "A String", # Required. A human readable display name used to identify this debug token. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` - "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. + "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. }, ], @@ -234,7 +234,7 @@

Method Details

"displayName": "A String", # Required. A human readable display name used to identify this debug token. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` - "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. + "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. } @@ -251,7 +251,7 @@

Method Details

"displayName": "A String", # Required. A human readable display name used to identify this debug token. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` - "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. + "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. }
diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.html index 7079e0a445..25b1bbab14 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.apps.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.html @@ -109,11 +109,6 @@

Instance Methods

Returns the recaptchaV3Config Resource.

-

- safetyNetConfig() -

-

Returns the safetyNetConfig Resource.

-

close()

Close httplib2 connections.

@@ -144,9 +139,6 @@

Instance Methods

exchangeRecaptchaV3Token(app, body=None, x__xgafv=None)

Validates a [reCAPTCHA v3 response token](https://developers.google.com/recaptcha/docs/v3). If valid, returns an AppCheckToken.

-

- exchangeSafetyNetToken(app, body=None, x__xgafv=None)

-

Validates a [SafetyNet token](https://developer.android.com/training/safetynet/attestation#request-attestation-step). If valid, returns an AppCheckToken.

generateAppAttestChallenge(app, body=None, x__xgafv=None)

Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.

@@ -239,7 +231,7 @@

Method Details

{ # Request message for the ExchangeCustomToken method. "customToken": "A String", # Required. A custom token signed using your project's Admin SDK service account credentials. - "jti": "A String", # Optional. When `limited_use` is set to `true`, this field specifies the desired `jti` claim (Section 4.1.7 of RFC 7519) in the returned App Check token. *Limited use* App Check tokens with the same `jti` will be counted as the same token for the purposes of replay protection. An error is returned if this field is specified without setting `limited_use` to `true`. The size of this field is limited to 500 bytes. If specified, its length must be at least 16 bytes. If this field is omitted or is empty and `limited_use` is set to `true`, a randomly generated `jti` claim with length between 16 and 500 bytes (inclusive) will be used in the returned App Check token. Leaving this field empty is only recommended if your custom attestation provider itself is not vulnerable to replay attacks. When `limited_use` is set to `false`, neither the presence nor the contents of the `jti` claim in the returned App Check token is specified. To ensure that the returned App Check token is eligible for limited use functionality, set `limited_use` to `true`. + "jti": "A String", # Optional. When `limited_use` is set to `true`, this field specifies the desired `jti` claim (Section 4.1.7 of RFC 7519) in the returned App Check token. *Limited use* App Check tokens with the same `jti` will be counted as the same token for the purposes of replay protection. An error is returned if this field is specified without setting `limited_use` to `true`. The size of this field is limited to 500 bytes. If specified, its length must be at least 16 bytes. If this field is omitted or is empty and `limited_use` is set to `true`, a randomly generated `jti` claim with length between 16 and 500 bytes (inclusive) will be used in the returned App Check token. Leaving this field empty is only recommended if your custom attestation provider itself is not vulnerable to replay attacks. When `limited_use` is set to `false`, the presence and the contents of the `jti` claim in the returned App Check token are unspecified. To ensure that the returned App Check token is eligible for limited-use functionality, set `limited_use` to `true`. "limitedUse": True or False, # Specifies whether this attestation is for use in a *limited use* (`true`) or *session based* (`false`) context. To enable this attestation to be used with the *replay protection* feature, set this to `true`. The default value is `false`. } @@ -431,34 +423,6 @@

Method Details

}
-
- exchangeSafetyNetToken(app, body=None, x__xgafv=None) -
Validates a [SafetyNet token](https://developer.android.com/training/safetynet/attestation#request-attestation-step). If valid, returns an AppCheckToken.
-
-Args:
-  app: string, Required. The relative resource name of the Android app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for the ExchangeSafetyNetToken method.
-  "safetyNetToken": "A String", # Required. The [SafetyNet attestation response](https://developer.android.com/training/safetynet/attestation#request-attestation-step) issued to your app.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Encapsulates an *App Check token*, which are used to access backend services protected by App Check.
-  "attestationToken": "A String", # The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and GCP project. This token is used to access Google services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK or third-party libraries.
-  "token": "A String", # The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and GCP project. This token is used to access Google services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK or third-party libraries.
-  "ttl": "A String", # The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.
-}
-
-
generateAppAttestChallenge(app, body=None, x__xgafv=None)
Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.
diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaV3Config.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaV3Config.html
index a440c31ab5..1974f71262 100644
--- a/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaV3Config.html
+++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaV3Config.html
@@ -85,7 +85,7 @@ 

Instance Methods

Gets the RecaptchaV3Config for the specified app. For security reasons, the `site_secret` field is never populated in the response.

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

-

Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.

+

Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA v3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.

Method Details

batchGet(parent, names=None, x__xgafv=None) @@ -145,7 +145,7 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.
+  
Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA v3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.
 
 Args:
   name: string, Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ``` (required)
diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.services.html b/docs/dyn/firebaseappcheck_v1beta.projects.services.html
index b4529ebd31..9b054d79c8 100644
--- a/docs/dyn/firebaseappcheck_v1beta.projects.services.html
+++ b/docs/dyn/firebaseappcheck_v1beta.projects.services.html
@@ -110,11 +110,11 @@ 

Method Details

{ # Request message for the BatchUpdateServices method. "requests": [ # Required. The request messages specifying the Services to update. A maximum of 100 objects can be updated in a batch. { # Request message for the UpdateService method as well as an individual update message for the BatchUpdateServices method. - "service": { # The enforcement configuration for a Firebase service supported by App Check. # Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) For Firebase Authentication to work with App Check, you must first upgrade to [Firebase Authentication with Identity Platform](https://firebase.google.com/docs/auth#identity-platform). - "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "service": { # The enforcement configuration for a Firebase service supported by App Check. # Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the Service.name field for a list of supported service IDs. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this service. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. - "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) - "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation. + "replayProtection": "A String", # Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }, "updateMask": "A String", # Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`. @@ -134,10 +134,10 @@

Method Details

{ # Response message for the BatchUpdateServices method. "services": [ # Service objects after the updates have been applied. { # The enforcement configuration for a Firebase service supported by App Check. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this service. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. - "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) - "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation. + "replayProtection": "A String", # Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }, ], @@ -154,7 +154,7 @@

Method Details

Gets the Service configuration for the specified service name.
 
 Args:
-  name: string, Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) (required)
+  name: string, Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the Service.name field for a list of supported service IDs. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -164,10 +164,10 @@ 

Method Details

An object of the form: { # The enforcement configuration for a Firebase service supported by App Check. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this service. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. - "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) - "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation. + "replayProtection": "A String", # Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }
@@ -192,10 +192,10 @@

Method Details

"nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListServices to find the next group of Services. Page tokens are short-lived and should not be persisted. "services": [ # The Services retrieved. { # The enforcement configuration for a Firebase service supported by App Check. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this service. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. - "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) - "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation. + "replayProtection": "A String", # Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }, ], @@ -221,15 +221,15 @@

Method Details

Updates the specified Service configuration.
 
 Args:
-  name: string, Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) (required)
+  name: string, Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # The enforcement configuration for a Firebase service supported by App Check.
-  "enforcementMode": "A String", # Required. The App Check enforcement mode for this service.
+  "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this service.
   "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.
-  "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS)
-  "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`.
+  "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation.
+  "replayProtection": "A String", # Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`.
   "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated.
 }
 
@@ -243,10 +243,10 @@ 

Method Details

An object of the form: { # The enforcement configuration for a Firebase service supported by App Check. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this service. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. - "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) - "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation. + "replayProtection": "A String", # Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }
diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.services.resourcePolicies.html b/docs/dyn/firebaseappcheck_v1beta.projects.services.resourcePolicies.html index 44e12841f8..0944c7e506 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.services.resourcePolicies.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.services.resourcePolicies.html @@ -111,8 +111,8 @@

Method Details

{ # Request message for the BatchUpdateResourcePolicies method. "requests": [ # Required. The request messages specifying the ResourcePolicy objects to update. A maximum of 100 objects can be updated in a batch. { # Request message for the UpdateResourcePolicy method as well as an individual update message for the BatchUpdateResourcePolicies method. - "resourcePolicy": { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. # Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the parent service. + "resourcePolicy": { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. # Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. @@ -135,7 +135,7 @@

Method Details

{ # Response message for the BatchUpdateResourcePolicies method. "resourcePolicies": [ # ResourcePolicy objects after the updates have been applied. { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the parent service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. @@ -155,12 +155,12 @@

Method Details

Creates the specified ResourcePolicy configuration.
 
 Args:
-  parent: string, Required. The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) (required)
+  parent: string, Required. The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration.
-  "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the parent service.
+  "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode.
   "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.
   "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.
   "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.
@@ -176,7 +176,7 @@ 

Method Details

An object of the form: { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the parent service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. @@ -208,7 +208,7 @@

Method Details

Gets the requested ResourcePolicy configuration.
 
 Args:
-  name: string, Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) (required)
+  name: string, Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -218,7 +218,7 @@ 

Method Details

An object of the form: { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the parent service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. @@ -231,7 +231,7 @@

Method Details

Lists all ResourcePolicy configurations for the specified project and service.
 
 Args:
-  parent: string, Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) (required)
+  parent: string, Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs. (required)
   filter: string, Optional. Filters the results by the specified rule. For the exact syntax of this field, please consult the [AIP-160](https://google.aip.dev/160) standard. Currently, since the only fields in the ResourcePolicy resource are the scalar fields `enforcement_mode` and `target_resource`, this method does not support the traversal operator (`.`) or the has operator (`:`). Here are some examples of valid filters: * `enforcement_mode = ENFORCED` * `target_resource = "//oauth2.googleapis.com/projects/12345/oauthClients/"` * `enforcement_mode = ENFORCED AND target_resource = "//oauth2.googleapis.com/projects/12345/oauthClients/"`
   pageSize: integer, The maximum number of ResourcePolicy objects to return in the response. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.
   pageToken: string, Token returned from a previous call to ListResourcePolicies indicating where in the set of ResourcePolicy objects to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourcePolicies must match the call that provided the page token; if they do not match, the result is undefined.
@@ -247,7 +247,7 @@ 

Method Details

"nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListResourcePolicies to find the next group of ResourcePolicy objects. Page tokens are short-lived and should not be persisted. "resourcePolicies": [ # The ResourcePolicy objects retrieved. { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the parent service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. @@ -281,7 +281,7 @@

Method Details

The object takes the form of: { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the parent service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. @@ -298,7 +298,7 @@

Method Details

An object of the form: { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. - "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the parent service. + "enforcementMode": "A String", # Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. "targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json index 6dc71d3c1a..6cfa77647a 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json @@ -494,36 +494,6 @@ "https://www.googleapis.com/auth/firebase" ] }, -"exchangeSafetyNetToken": { -"deprecated": true, -"description": "Validates a [SafetyNet token](https://developer.android.com/training/safetynet/attestation#request-attestation-step). If valid, returns an AppCheckToken.", -"flatPath": "v1/projects/{projectsId}/apps/{appsId}:exchangeSafetyNetToken", -"httpMethod": "POST", -"id": "firebaseappcheck.projects.apps.exchangeSafetyNetToken", -"parameterOrder": [ -"app" -], -"parameters": { -"app": { -"description": "Required. The relative resource name of the Android app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard.", -"location": "path", -"pattern": "^projects/[^/]+/apps/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+app}:exchangeSafetyNetToken", -"request": { -"$ref": "GoogleFirebaseAppcheckV1ExchangeSafetyNetTokenRequest" -}, -"response": { -"$ref": "GoogleFirebaseAppcheckV1AppCheckToken" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/firebase" -] -}, "generateAppAttestChallenge": { "description": "Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.", "flatPath": "v1/projects/{projectsId}/apps/{appsId}:generateAppAttestChallenge", @@ -1195,7 +1165,7 @@ ] }, "patch": { -"description": "Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.", +"description": "Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA v3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.", "flatPath": "v1/projects/{projectsId}/apps/{appsId}/recaptchaV3Config", "httpMethod": "PATCH", "id": "firebaseappcheck.projects.apps.recaptchaV3Config.patch", @@ -1230,107 +1200,6 @@ ] } } -}, -"safetyNetConfig": { -"deprecated": true, -"methods": { -"batchGet": { -"deprecated": true, -"description": "Atomically gets the SafetyNetConfigs for the specified list of apps.", -"flatPath": "v1/projects/{projectsId}/apps/-/safetyNetConfig:batchGet", -"httpMethod": "GET", -"id": "firebaseappcheck.projects.apps.safetyNetConfig.batchGet", -"parameterOrder": [ -"parent" -], -"parameters": { -"names": { -"description": "Required. The relative resource names of the SafetyNetConfigs to retrieve, in the format ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` A maximum of 100 objects can be retrieved in a batch.", -"location": "query", -"repeated": true, -"type": "string" -}, -"parent": { -"description": "Required. The parent project name shared by all SafetyNetConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.", -"location": "path", -"pattern": "^projects/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/apps/-/safetyNetConfig:batchGet", -"response": { -"$ref": "GoogleFirebaseAppcheckV1BatchGetSafetyNetConfigsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/firebase" -] -}, -"get": { -"deprecated": true, -"description": "Gets the SafetyNetConfig for the specified app.", -"flatPath": "v1/projects/{projectsId}/apps/{appsId}/safetyNetConfig", -"httpMethod": "GET", -"id": "firebaseappcheck.projects.apps.safetyNetConfig.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The relative resource name of the SafetyNetConfig, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```", -"location": "path", -"pattern": "^projects/[^/]+/apps/[^/]+/safetyNetConfig$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleFirebaseAppcheckV1SafetyNetConfig" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/firebase" -] -}, -"patch": { -"deprecated": true, -"description": "Updates the SafetyNetConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange SafetyNet tokens for App Check tokens.", -"flatPath": "v1/projects/{projectsId}/apps/{appsId}/safetyNetConfig", -"httpMethod": "PATCH", -"id": "firebaseappcheck.projects.apps.safetyNetConfig.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```", -"location": "path", -"pattern": "^projects/[^/]+/apps/[^/]+/safetyNetConfig$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. A comma-separated list of names of fields in the SafetyNetConfig to update. Example: `token_ttl`.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+name}", -"request": { -"$ref": "GoogleFirebaseAppcheckV1SafetyNetConfig" -}, -"response": { -"$ref": "GoogleFirebaseAppcheckV1SafetyNetConfig" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/firebase" -] -} -} } } }, @@ -1375,7 +1244,7 @@ ], "parameters": { "name": { -"description": "Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS)", +"description": "Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the Service.name field for a list of supported service IDs.", "location": "path", "pattern": "^projects/[^/]+/services/[^/]+$", "required": true, @@ -1438,7 +1307,7 @@ ], "parameters": { "name": { -"description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS)", +"description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation.", "location": "path", "pattern": "^projects/[^/]+/services/[^/]+$", "required": true, @@ -1506,7 +1375,7 @@ ], "parameters": { "parent": { -"description": "Required. The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)", +"description": "Required. The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs.", "location": "path", "pattern": "^projects/[^/]+/services/[^/]+$", "required": true, @@ -1566,7 +1435,7 @@ ], "parameters": { "name": { -"description": "Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)", +"description": "Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs.", "location": "path", "pattern": "^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$", "required": true, @@ -1608,7 +1477,7 @@ "type": "string" }, "parent": { -"description": "Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)", +"description": "Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs.", "location": "path", "pattern": "^projects/[^/]+/services/[^/]+$", "required": true, @@ -1666,7 +1535,7 @@ } } }, -"revision": "20260403", +"revision": "20260717", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1AppAttestConfig": { @@ -1771,21 +1640,6 @@ }, "type": "object" }, -"GoogleFirebaseAppcheckV1BatchGetSafetyNetConfigsResponse": { -"deprecated": true, -"description": "Response message for the BatchGetSafetyNetConfigs method.", -"id": "GoogleFirebaseAppcheckV1BatchGetSafetyNetConfigsResponse", -"properties": { -"configs": { -"description": "SafetyNetConfigs retrieved.", -"items": { -"$ref": "GoogleFirebaseAppcheckV1SafetyNetConfig" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest": { "description": "Request message for the BatchUpdateResourcePolicies method.", "id": "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest", @@ -1869,7 +1723,7 @@ "type": "string" }, "token": { -"description": "Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response.", +"description": "Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response.", "type": "string" }, "updateTime": { @@ -1986,6 +1840,10 @@ "description": "Required. A custom token signed using your project's Admin SDK service account credentials.", "type": "string" }, +"jti": { +"description": "Optional. When `limited_use` is set to `true`, this field specifies the desired `jti` claim (Section 4.1.7 of RFC 7519) in the returned App Check token. *Limited use* App Check tokens with the same `jti` will be counted as the same token for the purposes of replay protection. An error is returned if this field is specified without setting `limited_use` to `true`. The size of this field is limited to 500 bytes. If specified, its length must be at least 16 bytes. If this field is omitted or is empty and `limited_use` is set to `true`, a randomly generated `jti` claim with length between 16 and 500 bytes (inclusive) will be used in the returned App Check token. Leaving this field empty is only recommended if your custom attestation provider itself is not vulnerable to replay attacks. When `limited_use` is set to `false`, the presence and the contents of the `jti` claim in the returned App Check token are unspecified. To ensure that the returned App Check token is eligible for limited-use functionality, set `limited_use` to `true`.", +"type": "string" +}, "limitedUse": { "description": "Specifies whether this attestation is for use in a *limited use* (`true`) or *session based* (`false`) context. To enable this attestation to be used with the *replay protection* feature, set this to `true`. The default value is `false`.", "type": "boolean" @@ -2068,18 +1926,6 @@ }, "type": "object" }, -"GoogleFirebaseAppcheckV1ExchangeSafetyNetTokenRequest": { -"deprecated": true, -"description": "Request message for the ExchangeSafetyNetToken method.", -"id": "GoogleFirebaseAppcheckV1ExchangeSafetyNetTokenRequest", -"properties": { -"safetyNetToken": { -"description": "Required. The [SafetyNet attestation response](https://developer.android.com/training/safetynet/attestation#request-attestation-step) issued to your app.", -"type": "string" -} -}, -"type": "object" -}, "GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest": { "description": "Request message for the GenerateAppAttestChallenge method.", "id": "GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest", @@ -2243,7 +2089,7 @@ "MEETS_STRONG_INTEGRITY" ], "enumDescriptions": [ -"Default value. Do not specify this value directly. When this default value is detected in a configuration, the `NO_INTEGRITY` default level takes effect.", +"Default value. Do not specify this value directly. If this value is detected in a configuration, it will have the same effect as the value `NO_INTEGRITY`.", "If this level is set, no explicit device integrity label requirements will be checked. However, because Play Integrity's other features may perform (and require) their own intrinsic device integrity checks, your `app_integrity` and `account_details` settings may still cause some device integrity checks to be performed.", "This level corresponds to the `MEETS_BASIC_INTEGRITY` [optional device recognition label](https://developer.android.com/google/play/integrity/verdicts#optional-device-labels). This value represents the most basic level of device integrity, and is the minimum allowed in App Check's standard implementation of Play Integrity. Warning: Because this is an optional response, you **must** first explicitly [opt in your app in the Play Console](https://developer.android.com/google/play/integrity/setup#optional) in order to receive this label. Without this opt-in, **your app may break** for any user whose device is eligible for `MEETS_BASIC_INTEGRITY` but not `MEETS_DEVICE_INTEGRITY`. This API is **not** responsible for any such opt-ins.", "This level corresponds to the `MEETS_DEVICE_INTEGRITY` [device recognition verdict](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field). Any app integrated with Play Integrity will automatically be eligible to receive this label without any additional action from you. At this level, devices that have the `MEETS_BASIC_INTEGRITY` label but **not** the `MEETS_DEVICE_INTEGRITY` label will be rejected.", @@ -2370,16 +2216,16 @@ "id": "GoogleFirebaseAppcheckV1ResourcePolicy", "properties": { "enforcementMode": { -"description": "Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service.", +"description": "Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode.", "enum": [ "OFF", "UNENFORCED", "ENFORCED" ], "enumDescriptions": [ -"The relevant App Check protection is not enforced for the service or resource, nor are App Check metrics collected. Though the relevant App Check protection is not applied, other applicable protections, such as user authorization, are still enforced. An unconfigured protection is in this mode by default.", -"The relevant App Check protection is not enforced for the service or resource. App Check metrics are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by the relevant App Check protection, but that traffic will not be rejected until you turn on enforcement. Though the relevant App Check protection is not enforced, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", -"The relevant App Check protection is enforced for the service or resource. The service or resource will reject any traffic not accompanied by an App Check token that is deemded valid by the relevant protection. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide whether to enforce App Check on your services and resources. If your app has not launched yet, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." +"When a particular protection is set to this mode, that protection is not applied for the service or resource, nor are metrics related to that protection collected. Though the relevant App Check protection is not applied, other applicable protections outside of App Check, such as user authorization, are still applied. An unconfigured EnforcementMode is in this mode by default.", +"When a particular protection is set to this mode, that protection is not enforced for the service or resource. Metrics related to that protection are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by that protection, but that traffic will not be rejected until you turn on enforcement. This `UNENFORCED` mode is also known as monitoring-only mode. Though the relevant App Check protection is not enforced, other applicable protections outside of App Check, such as user authorization, are still applied. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", +"When a particular protection is set to this mode, that protection is enforced for the service or resource. It will reject any traffic not accompanied by an App Check token that it deems valid. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections outside of App Check, such as user authorization, continue to be applied at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide when to enforce that protection on your services and resources. If you have not yet published your app, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." ], "type": "string" }, @@ -2404,38 +2250,21 @@ }, "type": "object" }, -"GoogleFirebaseAppcheckV1SafetyNetConfig": { -"deprecated": true, -"description": "An app's SafetyNet configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangeSafetyNetToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by SafetyNet; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v11/projects.androidApps.sha/create).", -"id": "GoogleFirebaseAppcheckV1SafetyNetConfig", -"properties": { -"name": { -"description": "Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```", -"type": "string" -}, -"tokenTtl": { -"description": "Specifies the duration for which App Check tokens exchanged from SafetyNet tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.", -"format": "google-duration", -"type": "string" -} -}, -"type": "object" -}, "GoogleFirebaseAppcheckV1Service": { "description": "The enforcement configuration for a Firebase service supported by App Check.", "id": "GoogleFirebaseAppcheckV1Service", "properties": { "enforcementMode": { -"description": "Required. The App Check enforcement mode for this service.", +"description": "Required. The baseline protection EnforcementMode for this service.", "enum": [ "OFF", "UNENFORCED", "ENFORCED" ], "enumDescriptions": [ -"The relevant App Check protection is not enforced for the service or resource, nor are App Check metrics collected. Though the relevant App Check protection is not applied, other applicable protections, such as user authorization, are still enforced. An unconfigured protection is in this mode by default.", -"The relevant App Check protection is not enforced for the service or resource. App Check metrics are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by the relevant App Check protection, but that traffic will not be rejected until you turn on enforcement. Though the relevant App Check protection is not enforced, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", -"The relevant App Check protection is enforced for the service or resource. The service or resource will reject any traffic not accompanied by an App Check token that is deemded valid by the relevant protection. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide whether to enforce App Check on your services and resources. If your app has not launched yet, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." +"When a particular protection is set to this mode, that protection is not applied for the service or resource, nor are metrics related to that protection collected. Though the relevant App Check protection is not applied, other applicable protections outside of App Check, such as user authorization, are still applied. An unconfigured EnforcementMode is in this mode by default.", +"When a particular protection is set to this mode, that protection is not enforced for the service or resource. Metrics related to that protection are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by that protection, but that traffic will not be rejected until you turn on enforcement. This `UNENFORCED` mode is also known as monitoring-only mode. Though the relevant App Check protection is not enforced, other applicable protections outside of App Check, such as user authorization, are still applied. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", +"When a particular protection is set to this mode, that protection is enforced for the service or resource. It will reject any traffic not accompanied by an App Check token that it deems valid. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections outside of App Check, such as user authorization, continue to be applied at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide when to enforce that protection on your services and resources. If you have not yet published your app, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." ], "type": "string" }, @@ -2444,20 +2273,20 @@ "type": "string" }, "name": { -"description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS)", +"description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation.", "type": "string" }, "replayProtection": { -"description": "Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`.", +"description": "Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`.", "enum": [ "OFF", "UNENFORCED", "ENFORCED" ], "enumDescriptions": [ -"The relevant App Check protection is not enforced for the service or resource, nor are App Check metrics collected. Though the relevant App Check protection is not applied, other applicable protections, such as user authorization, are still enforced. An unconfigured protection is in this mode by default.", -"The relevant App Check protection is not enforced for the service or resource. App Check metrics are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by the relevant App Check protection, but that traffic will not be rejected until you turn on enforcement. Though the relevant App Check protection is not enforced, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", -"The relevant App Check protection is enforced for the service or resource. The service or resource will reject any traffic not accompanied by an App Check token that is deemded valid by the relevant protection. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide whether to enforce App Check on your services and resources. If your app has not launched yet, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." +"When a particular protection is set to this mode, that protection is not applied for the service or resource, nor are metrics related to that protection collected. Though the relevant App Check protection is not applied, other applicable protections outside of App Check, such as user authorization, are still applied. An unconfigured EnforcementMode is in this mode by default.", +"When a particular protection is set to this mode, that protection is not enforced for the service or resource. Metrics related to that protection are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by that protection, but that traffic will not be rejected until you turn on enforcement. This `UNENFORCED` mode is also known as monitoring-only mode. Though the relevant App Check protection is not enforced, other applicable protections outside of App Check, such as user authorization, are still applied. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", +"When a particular protection is set to this mode, that protection is enforced for the service or resource. It will reject any traffic not accompanied by an App Check token that it deems valid. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections outside of App Check, such as user authorization, continue to be applied at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide when to enforce that protection on your services and resources. If you have not yet published your app, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." ], "type": "string" }, @@ -2476,7 +2305,7 @@ "properties": { "resourcePolicy": { "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy", -"description": "Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)" +"description": "Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs." }, "updateMask": { "description": "Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`.", @@ -2492,7 +2321,7 @@ "properties": { "service": { "$ref": "GoogleFirebaseAppcheckV1Service", -"description": "Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS)" +"description": "Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the Service.name field for a list of supported service IDs." }, "updateMask": { "description": "Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`.", diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json index 77a33a0839..a6e77058ab 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json @@ -555,36 +555,6 @@ "https://www.googleapis.com/auth/firebase" ] }, -"exchangeSafetyNetToken": { -"deprecated": true, -"description": "Validates a [SafetyNet token](https://developer.android.com/training/safetynet/attestation#request-attestation-step). If valid, returns an AppCheckToken.", -"flatPath": "v1beta/projects/{projectsId}/apps/{appsId}:exchangeSafetyNetToken", -"httpMethod": "POST", -"id": "firebaseappcheck.projects.apps.exchangeSafetyNetToken", -"parameterOrder": [ -"app" -], -"parameters": { -"app": { -"description": "Required. The relative resource name of the Android app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard.", -"location": "path", -"pattern": "^projects/[^/]+/apps/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta/{+app}:exchangeSafetyNetToken", -"request": { -"$ref": "GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest" -}, -"response": { -"$ref": "GoogleFirebaseAppcheckV1betaAppCheckToken" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/firebase" -] -}, "generateAppAttestChallenge": { "description": "Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.", "flatPath": "v1beta/projects/{projectsId}/apps/{appsId}:generateAppAttestChallenge", @@ -1357,7 +1327,7 @@ ] }, "patch": { -"description": "Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.", +"description": "Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA v3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.", "flatPath": "v1beta/projects/{projectsId}/apps/{appsId}/recaptchaV3Config", "httpMethod": "PATCH", "id": "firebaseappcheck.projects.apps.recaptchaV3Config.patch", @@ -1392,107 +1362,6 @@ ] } } -}, -"safetyNetConfig": { -"deprecated": true, -"methods": { -"batchGet": { -"deprecated": true, -"description": "Atomically gets the SafetyNetConfigs for the specified list of apps.", -"flatPath": "v1beta/projects/{projectsId}/apps/-/safetyNetConfig:batchGet", -"httpMethod": "GET", -"id": "firebaseappcheck.projects.apps.safetyNetConfig.batchGet", -"parameterOrder": [ -"parent" -], -"parameters": { -"names": { -"description": "Required. The relative resource names of the SafetyNetConfigs to retrieve, in the format ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` A maximum of 100 objects can be retrieved in a batch.", -"location": "query", -"repeated": true, -"type": "string" -}, -"parent": { -"description": "Required. The parent project name shared by all SafetyNetConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.", -"location": "path", -"pattern": "^projects/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta/{+parent}/apps/-/safetyNetConfig:batchGet", -"response": { -"$ref": "GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/firebase" -] -}, -"get": { -"deprecated": true, -"description": "Gets the SafetyNetConfig for the specified app.", -"flatPath": "v1beta/projects/{projectsId}/apps/{appsId}/safetyNetConfig", -"httpMethod": "GET", -"id": "firebaseappcheck.projects.apps.safetyNetConfig.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The relative resource name of the SafetyNetConfig, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```", -"location": "path", -"pattern": "^projects/[^/]+/apps/[^/]+/safetyNetConfig$", -"required": true, -"type": "string" -} -}, -"path": "v1beta/{+name}", -"response": { -"$ref": "GoogleFirebaseAppcheckV1betaSafetyNetConfig" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/firebase" -] -}, -"patch": { -"deprecated": true, -"description": "Updates the SafetyNetConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange SafetyNet tokens for App Check tokens.", -"flatPath": "v1beta/projects/{projectsId}/apps/{appsId}/safetyNetConfig", -"httpMethod": "PATCH", -"id": "firebaseappcheck.projects.apps.safetyNetConfig.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```", -"location": "path", -"pattern": "^projects/[^/]+/apps/[^/]+/safetyNetConfig$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. A comma-separated list of names of fields in the SafetyNetConfig to update. Example: `token_ttl`.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1beta/{+name}", -"request": { -"$ref": "GoogleFirebaseAppcheckV1betaSafetyNetConfig" -}, -"response": { -"$ref": "GoogleFirebaseAppcheckV1betaSafetyNetConfig" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/firebase" -] -} -} } } }, @@ -1537,7 +1406,7 @@ ], "parameters": { "name": { -"description": "Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS)", +"description": "Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the Service.name field for a list of supported service IDs.", "location": "path", "pattern": "^projects/[^/]+/services/[^/]+$", "required": true, @@ -1600,7 +1469,7 @@ ], "parameters": { "name": { -"description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS)", +"description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation.", "location": "path", "pattern": "^projects/[^/]+/services/[^/]+$", "required": true, @@ -1668,7 +1537,7 @@ ], "parameters": { "parent": { -"description": "Required. The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)", +"description": "Required. The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs.", "location": "path", "pattern": "^projects/[^/]+/services/[^/]+$", "required": true, @@ -1728,7 +1597,7 @@ ], "parameters": { "name": { -"description": "Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)", +"description": "Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs.", "location": "path", "pattern": "^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$", "required": true, @@ -1770,7 +1639,7 @@ "type": "string" }, "parent": { -"description": "Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)", +"description": "Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs.", "location": "path", "pattern": "^projects/[^/]+/services/[^/]+$", "required": true, @@ -1828,7 +1697,7 @@ } } }, -"revision": "20260403", +"revision": "20260717", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestConfig": { @@ -1970,21 +1839,6 @@ }, "type": "object" }, -"GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse": { -"deprecated": true, -"description": "Response message for the BatchGetSafetyNetConfigs method.", -"id": "GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse", -"properties": { -"configs": { -"description": "SafetyNetConfigs retrieved.", -"items": { -"$ref": "GoogleFirebaseAppcheckV1betaSafetyNetConfig" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesRequest": { "description": "Request message for the BatchUpdateResourcePolicies method.", "id": "GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesRequest", @@ -2068,7 +1922,7 @@ "type": "string" }, "token": { -"description": "Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response.", +"description": "Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during a UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response.", "type": "string" }, "updateTime": { @@ -2191,7 +2045,7 @@ "type": "string" }, "jti": { -"description": "Optional. When `limited_use` is set to `true`, this field specifies the desired `jti` claim (Section 4.1.7 of RFC 7519) in the returned App Check token. *Limited use* App Check tokens with the same `jti` will be counted as the same token for the purposes of replay protection. An error is returned if this field is specified without setting `limited_use` to `true`. The size of this field is limited to 500 bytes. If specified, its length must be at least 16 bytes. If this field is omitted or is empty and `limited_use` is set to `true`, a randomly generated `jti` claim with length between 16 and 500 bytes (inclusive) will be used in the returned App Check token. Leaving this field empty is only recommended if your custom attestation provider itself is not vulnerable to replay attacks. When `limited_use` is set to `false`, neither the presence nor the contents of the `jti` claim in the returned App Check token is specified. To ensure that the returned App Check token is eligible for limited use functionality, set `limited_use` to `true`.", +"description": "Optional. When `limited_use` is set to `true`, this field specifies the desired `jti` claim (Section 4.1.7 of RFC 7519) in the returned App Check token. *Limited use* App Check tokens with the same `jti` will be counted as the same token for the purposes of replay protection. An error is returned if this field is specified without setting `limited_use` to `true`. The size of this field is limited to 500 bytes. If specified, its length must be at least 16 bytes. If this field is omitted or is empty and `limited_use` is set to `true`, a randomly generated `jti` claim with length between 16 and 500 bytes (inclusive) will be used in the returned App Check token. Leaving this field empty is only recommended if your custom attestation provider itself is not vulnerable to replay attacks. When `limited_use` is set to `false`, the presence and the contents of the `jti` claim in the returned App Check token are unspecified. To ensure that the returned App Check token is eligible for limited-use functionality, set `limited_use` to `true`.", "type": "string" }, "limitedUse": { @@ -2288,18 +2142,6 @@ }, "type": "object" }, -"GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest": { -"deprecated": true, -"description": "Request message for the ExchangeSafetyNetToken method.", -"id": "GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest", -"properties": { -"safetyNetToken": { -"description": "Required. The [SafetyNet attestation response](https://developer.android.com/training/safetynet/attestation#request-attestation-step) issued to your app.", -"type": "string" -} -}, -"type": "object" -}, "GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest": { "description": "Request message for the GenerateAppAttestChallenge method.", "id": "GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest", @@ -2463,7 +2305,7 @@ "MEETS_STRONG_INTEGRITY" ], "enumDescriptions": [ -"Default value. Do not specify this value directly. When this default value is detected in a configuration, the `NO_INTEGRITY` default level takes effect.", +"Default value. Do not specify this value directly. If this value is detected in a configuration, it will have the same effect as the value `NO_INTEGRITY`.", "If this level is set, no explicit device integrity label requirements will be checked. However, because Play Integrity's other features may perform (and require) their own intrinsic device integrity checks, your `app_integrity` and `account_details` settings may still cause some device integrity checks to be performed.", "This level corresponds to the `MEETS_BASIC_INTEGRITY` [optional device recognition label](https://developer.android.com/google/play/integrity/verdicts#optional-device-labels). This value represents the most basic level of device integrity, and is the minimum allowed in App Check's standard implementation of Play Integrity. Warning: Because this is an optional response, you **must** first explicitly [opt in your app in the Play Console](https://developer.android.com/google/play/integrity/setup#optional) in order to receive this label. Without this opt-in, **your app may break** for any user whose device is eligible for `MEETS_BASIC_INTEGRITY` but not `MEETS_DEVICE_INTEGRITY`. This API is **not** responsible for any such opt-ins.", "This level corresponds to the `MEETS_DEVICE_INTEGRITY` [device recognition verdict](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field). Any app integrated with Play Integrity will automatically be eligible to receive this label without any additional action from you. At this level, devices that have the `MEETS_BASIC_INTEGRITY` label but **not** the `MEETS_DEVICE_INTEGRITY` label will be rejected.", @@ -2621,16 +2463,16 @@ "id": "GoogleFirebaseAppcheckV1betaResourcePolicy", "properties": { "enforcementMode": { -"description": "Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the parent service.", +"description": "Required. The baseline protection EnforcementMode for this resource. This will override the service-level baseline protection EnforcementMode.", "enum": [ "OFF", "UNENFORCED", "ENFORCED" ], "enumDescriptions": [ -"The relevant App Check protection is not enforced for the service or resource, nor are App Check metrics collected. Though the relevant App Check protection is not applied, other applicable protections, such as user authorization, are still enforced. An unconfigured protection is in this mode by default.", -"The relevant App Check protection is not enforced for the service or resource. App Check metrics are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by the relevant App Check protection, but that traffic will not be rejected until you turn on enforcement. Though the relevant App Check protection is not enforced, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", -"The relevant App Check protection is enforced for the service or resource. The service or resource will reject any traffic not accompanied by an App Check token that is deemded valid by the relevant protection. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide whether to enforce App Check on your services and resources. If your app has not launched yet, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." +"When a particular protection is set to this mode, that protection is not applied for the service or resource, nor are metrics related to that protection collected. Though the relevant App Check protection is not applied, other applicable protections outside of App Check, such as user authorization, are still applied. An unconfigured EnforcementMode is in this mode by default.", +"When a particular protection is set to this mode, that protection is not enforced for the service or resource. Metrics related to that protection are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by that protection, but that traffic will not be rejected until you turn on enforcement. This `UNENFORCED` mode is also known as monitoring-only mode. Though the relevant App Check protection is not enforced, other applicable protections outside of App Check, such as user authorization, are still applied. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", +"When a particular protection is set to this mode, that protection is enforced for the service or resource. It will reject any traffic not accompanied by an App Check token that it deems valid. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections outside of App Check, such as user authorization, continue to be applied at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide when to enforce that protection on your services and resources. If you have not yet published your app, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." ], "type": "string" }, @@ -2655,38 +2497,21 @@ }, "type": "object" }, -"GoogleFirebaseAppcheckV1betaSafetyNetConfig": { -"deprecated": true, -"description": "An app's SafetyNet configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangeSafetyNetToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by SafetyNet; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).", -"id": "GoogleFirebaseAppcheckV1betaSafetyNetConfig", -"properties": { -"name": { -"description": "Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```", -"type": "string" -}, -"tokenTtl": { -"description": "Specifies the duration for which App Check tokens exchanged from SafetyNet tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.", -"format": "google-duration", -"type": "string" -} -}, -"type": "object" -}, "GoogleFirebaseAppcheckV1betaService": { "description": "The enforcement configuration for a Firebase service supported by App Check.", "id": "GoogleFirebaseAppcheckV1betaService", "properties": { "enforcementMode": { -"description": "Required. The App Check enforcement mode for this service.", +"description": "Required. The baseline protection EnforcementMode for this service.", "enum": [ "OFF", "UNENFORCED", "ENFORCED" ], "enumDescriptions": [ -"The relevant App Check protection is not enforced for the service or resource, nor are App Check metrics collected. Though the relevant App Check protection is not applied, other applicable protections, such as user authorization, are still enforced. An unconfigured protection is in this mode by default.", -"The relevant App Check protection is not enforced for the service or resource. App Check metrics are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by the relevant App Check protection, but that traffic will not be rejected until you turn on enforcement. Though the relevant App Check protection is not enforced, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", -"The relevant App Check protection is enforced for the service or resource. The service or resource will reject any traffic not accompanied by an App Check token that is deemded valid by the relevant protection. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide whether to enforce App Check on your services and resources. If your app has not launched yet, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." +"When a particular protection is set to this mode, that protection is not applied for the service or resource, nor are metrics related to that protection collected. Though the relevant App Check protection is not applied, other applicable protections outside of App Check, such as user authorization, are still applied. An unconfigured EnforcementMode is in this mode by default.", +"When a particular protection is set to this mode, that protection is not enforced for the service or resource. Metrics related to that protection are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by that protection, but that traffic will not be rejected until you turn on enforcement. This `UNENFORCED` mode is also known as monitoring-only mode. Though the relevant App Check protection is not enforced, other applicable protections outside of App Check, such as user authorization, are still applied. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", +"When a particular protection is set to this mode, that protection is enforced for the service or resource. It will reject any traffic not accompanied by an App Check token that it deems valid. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections outside of App Check, such as user authorization, continue to be applied at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide when to enforce that protection on your services and resources. If you have not yet published your app, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." ], "type": "string" }, @@ -2695,20 +2520,20 @@ "type": "string" }, "name": { -"description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS)", +"description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * `identitytoolkit.googleapis.com` (Firebase Authentication) * `firebasedataconnect.googleapis.com` (Firebase SQL Connect) * `firestore.googleapis.com` (Cloud Firestore) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebaseml.googleapis.com` (Firebase AI Logic) Google Maps Platform services: * `maps-backend.googleapis.com` (Maps JavaScript API) * `places.googleapis.com` (Places API (New)) Other supported Google services: * `oauth2.googleapis.com` (Google Identity for iOS) Note: While all the supported `service_id`s may appear to be subdomains of `googleapis.com`, the `service_id` has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation.", "type": "string" }, "replayProtection": { -"description": "Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`.", +"description": "Optional. The replay protection EnforcementMode for this service. Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to `OFF`.", "enum": [ "OFF", "UNENFORCED", "ENFORCED" ], "enumDescriptions": [ -"The relevant App Check protection is not enforced for the service or resource, nor are App Check metrics collected. Though the relevant App Check protection is not applied, other applicable protections, such as user authorization, are still enforced. An unconfigured protection is in this mode by default.", -"The relevant App Check protection is not enforced for the service or resource. App Check metrics are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by the relevant App Check protection, but that traffic will not be rejected until you turn on enforcement. Though the relevant App Check protection is not enforced, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", -"The relevant App Check protection is enforced for the service or resource. The service or resource will reject any traffic not accompanied by an App Check token that is deemded valid by the relevant protection. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide whether to enforce App Check on your services and resources. If your app has not launched yet, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." +"When a particular protection is set to this mode, that protection is not applied for the service or resource, nor are metrics related to that protection collected. Though the relevant App Check protection is not applied, other applicable protections outside of App Check, such as user authorization, are still applied. An unconfigured EnforcementMode is in this mode by default.", +"When a particular protection is set to this mode, that protection is not enforced for the service or resource. Metrics related to that protection are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by that protection, but that traffic will not be rejected until you turn on enforcement. This `UNENFORCED` mode is also known as monitoring-only mode. Though the relevant App Check protection is not enforced, other applicable protections outside of App Check, such as user authorization, are still applied. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", +"When a particular protection is set to this mode, that protection is enforced for the service or resource. It will reject any traffic not accompanied by an App Check token that it deems valid. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections outside of App Check, such as user authorization, continue to be applied at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide when to enforce that protection on your services and resources. If you have not yet published your app, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." ], "type": "string" }, @@ -2727,7 +2552,7 @@ "properties": { "resourcePolicy": { "$ref": "GoogleFirebaseAppcheckV1betaResourcePolicy", -"description": "Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)" +"description": "Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs." }, "updateMask": { "description": "Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`.", @@ -2743,7 +2568,7 @@ "properties": { "service": { "$ref": "GoogleFirebaseAppcheckV1betaService", -"description": "Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) For Firebase Authentication to work with App Check, you must first upgrade to [Firebase Authentication with Identity Platform](https://firebase.google.com/docs/auth#identity-platform)." +"description": "Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Consult the Service.name field for a list of supported service IDs." }, "updateMask": { "description": "Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`.", From f2863a04f76af5478cb60965aba4835243ee3589 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:05 +0000 Subject: [PATCH 50/84] feat(firebaseappdistribution): update the api #### firebaseappdistribution:v1 The following keys were added: - schemas.GoogleFirebaseAppdistroV1ListReleasesResponse.properties.totalSize (Total Keys: 2) - schemas.GoogleFirebaseAppdistroV1Release.properties.acceptedInvitationCount (Total Keys: 3) - schemas.GoogleFirebaseAppdistroV1Release.properties.androidPackageRegistrationState (Total Keys: 2) - schemas.GoogleFirebaseAppdistroV1Release.properties.binaryType (Total Keys: 2) - schemas.GoogleFirebaseAppdistroV1Release.properties.feedbackCount (Total Keys: 3) - schemas.GoogleFirebaseAppdistroV1Release.properties.installationCount (Total Keys: 3) - schemas.GoogleFirebaseAppdistroV1Release.properties.openInvitationCount (Total Keys: 3) - schemas.GoogleFirebaseAppdistroV1Release.properties.testState (Total Keys: 2) #### firebaseappdistribution:v1alpha The following keys were added: - schemas.GoogleFirebaseAppdistroV1Release.properties.acceptedInvitationCount (Total Keys: 3) - schemas.GoogleFirebaseAppdistroV1Release.properties.androidPackageRegistrationState (Total Keys: 2) - schemas.GoogleFirebaseAppdistroV1Release.properties.binaryType (Total Keys: 2) - schemas.GoogleFirebaseAppdistroV1Release.properties.feedbackCount (Total Keys: 3) - schemas.GoogleFirebaseAppdistroV1Release.properties.installationCount (Total Keys: 3) - schemas.GoogleFirebaseAppdistroV1Release.properties.openInvitationCount (Total Keys: 3) - schemas.GoogleFirebaseAppdistroV1Release.properties.testState (Total Keys: 2) --- ...istribution_v1.projects.apps.releases.html | 41 +++++++-- .../documents/firebaseappdistribution.v1.json | 92 ++++++++++++++++++- .../firebaseappdistribution.v1alpha.json | 83 ++++++++++++++++- 3 files changed, 204 insertions(+), 12 deletions(-) diff --git a/docs/dyn/firebaseappdistribution_v1.projects.apps.releases.html b/docs/dyn/firebaseappdistribution_v1.projects.apps.releases.html index 4ce3a57330..ba8ff46924 100644 --- a/docs/dyn/firebaseappdistribution_v1.projects.apps.releases.html +++ b/docs/dyn/firebaseappdistribution_v1.projects.apps.releases.html @@ -183,16 +183,23 @@

Method Details

An object of the form: { # A release of a Firebase app. + "acceptedInvitationCount": 42, # Output only. Number of testers with accepted invitations. + "androidPackageRegistrationState": "A String", # Output only. Registration state of the Android package (BinaryType.APK). "binaryDownloadUri": "A String", # Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file. + "binaryType": "A String", # Output only. Type of binary. "buildVersion": "A String", # Output only. Build version of the release. For an Android release, the build version is the `versionCode`. For an iOS release, the build version is the `CFBundleVersion`. "createTime": "A String", # Output only. The time the release was created. "displayVersion": "A String", # Output only. Display version of the release. For an Android release, the display version is the `versionName`. For an iOS release, the display version is the `CFBundleShortVersionString`. "expireTime": "A String", # Output only. The time the release will expire. + "feedbackCount": 42, # Output only. Number of feedback reports left by testers. "firebaseConsoleUri": "A String", # Output only. A link to the Firebase console displaying a single release. + "installationCount": 42, # Output only. Number of testers who have downloaded this release. "name": "A String", # The name of the release resource. Format: `projects/{project_number}/apps/{app}/releases/{release}` - "releaseNotes": { # Notes that belong to a release. # Notes of the release. + "openInvitationCount": 42, # Output only. Number of testers who were invited (incl. expired invitations), but did not (yet) accept the invitation. + "releaseNotes": { # Notes that belong to a release. # Notes about the release. "text": "A String", # The text of the release notes. }, + "testState": "A String", # Output only. The overall state of tests run on this release "testingUri": "A String", # Output only. A link to the release in the tester web clip or Android app that lets testers (which were granted access to the app) view release notes and install the app onto their devices. "updateTime": "A String", # Output only. The time the release was last updated. }
@@ -204,8 +211,8 @@

Method Details

Args: parent: string, Required. The name of the app resource, which is the parent of the release resources. Format: `projects/{project_number}/apps/{app}` (required) - filter: string, Optional. The expression to filter releases listed in the response. To learn more about filtering, refer to [Google's AIP-160 standard](http://aip.dev/160). Supported fields: - `releaseNotes.text` supports `=` (can contain a wildcard character (`*`) at the beginning or end of the string) - `createTime` supports `<`, `<=`, `>` and `>=`, and expects an RFC-3339 formatted string Examples: - `createTime <= "2021-09-08T00:00:00+04:00"` - `releaseNotes.text="fixes" AND createTime >= "2021-09-08T00:00:00.0Z"` - `releaseNotes.text="*v1.0.0-rc*"` - orderBy: string, Optional. The fields used to order releases. Supported fields: - `createTime` To specify descending order for a field, append a "desc" suffix, for example, `createTime desc`. If this parameter is not set, releases are ordered by `createTime` in descending order. + filter: string, Optional. The expression to filter releases listed in the response. To learn more about filtering, refer to the [AIP-160 standard](http://aip.dev/160). Supported fields: - Time fields supporting `<`, `<=`, `>` and `>=`; expecting an RFC-3339 formatted string: - `create_time` (or `createTime`) - `update_time` (or `updateTime`) - `expire_time` (or `expireTime`) - Text fields supporting `=`. The compared text can contain a wildcard character (`*`) at the beginning and/or end of the string which also enables case-insensitive matching: - `release_notes.text` (or `releaseNotes.text`) - `display_version` (or `displayVersion`) - `build_version` (or `buildVersion`). Examples: - `createTime <= "2021-09-08T00:00:00+04:00"` - `expire_time > "2021-09-08T00:00:00+04:00"` - `releaseNotes.text="fixes" AND createTime >= "2021-09-08T00:00:00.0Z"` - `releaseNotes.text="*v1.0.0-rc*"` - `(display_version = "v1.0.0-rc2" AND `build_version = "123") OR release_notes = "*v1.0.0-rc2 (123)*"` + orderBy: string, Optional. The fields used to order releases. Supported fields: - `create_time` (or `createTime`) - `update_time` (or `updateTime`) - `expire_time` (or `expireTime`) To specify descending order for a field, append a "desc" suffix, for example, `createTime desc`. If this parameter is not set, releases are ordered by `createTime` in descending order. pageSize: integer, Optional. The maximum number of releases to return. The service may return fewer than this value. The valid range is [1-100]; If unspecified (0), at most 25 releases are returned. Values above 100 are coerced to 100. pageToken: string, Optional. A page token, received from a previous `ListReleases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleases` must match the call that provided the page token. x__xgafv: string, V1 error format. @@ -220,20 +227,28 @@

Method Details

"nextPageToken": "A String", # A short-lived token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. "releases": [ # The releases { # A release of a Firebase app. + "acceptedInvitationCount": 42, # Output only. Number of testers with accepted invitations. + "androidPackageRegistrationState": "A String", # Output only. Registration state of the Android package (BinaryType.APK). "binaryDownloadUri": "A String", # Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file. + "binaryType": "A String", # Output only. Type of binary. "buildVersion": "A String", # Output only. Build version of the release. For an Android release, the build version is the `versionCode`. For an iOS release, the build version is the `CFBundleVersion`. "createTime": "A String", # Output only. The time the release was created. "displayVersion": "A String", # Output only. Display version of the release. For an Android release, the display version is the `versionName`. For an iOS release, the display version is the `CFBundleShortVersionString`. "expireTime": "A String", # Output only. The time the release will expire. + "feedbackCount": 42, # Output only. Number of feedback reports left by testers. "firebaseConsoleUri": "A String", # Output only. A link to the Firebase console displaying a single release. + "installationCount": 42, # Output only. Number of testers who have downloaded this release. "name": "A String", # The name of the release resource. Format: `projects/{project_number}/apps/{app}/releases/{release}` - "releaseNotes": { # Notes that belong to a release. # Notes of the release. + "openInvitationCount": 42, # Output only. Number of testers who were invited (incl. expired invitations), but did not (yet) accept the invitation. + "releaseNotes": { # Notes that belong to a release. # Notes about the release. "text": "A String", # The text of the release notes. }, + "testState": "A String", # Output only. The overall state of tests run on this release "testingUri": "A String", # Output only. A link to the release in the tester web clip or Android app that lets testers (which were granted access to the app) view release notes and install the app onto their devices. "updateTime": "A String", # Output only. The time the release was last updated. }, ], + "totalSize": 42, # The total number of releases. }
@@ -261,16 +276,23 @@

Method Details

The object takes the form of: { # A release of a Firebase app. + "acceptedInvitationCount": 42, # Output only. Number of testers with accepted invitations. + "androidPackageRegistrationState": "A String", # Output only. Registration state of the Android package (BinaryType.APK). "binaryDownloadUri": "A String", # Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file. + "binaryType": "A String", # Output only. Type of binary. "buildVersion": "A String", # Output only. Build version of the release. For an Android release, the build version is the `versionCode`. For an iOS release, the build version is the `CFBundleVersion`. "createTime": "A String", # Output only. The time the release was created. "displayVersion": "A String", # Output only. Display version of the release. For an Android release, the display version is the `versionName`. For an iOS release, the display version is the `CFBundleShortVersionString`. "expireTime": "A String", # Output only. The time the release will expire. + "feedbackCount": 42, # Output only. Number of feedback reports left by testers. "firebaseConsoleUri": "A String", # Output only. A link to the Firebase console displaying a single release. + "installationCount": 42, # Output only. Number of testers who have downloaded this release. "name": "A String", # The name of the release resource. Format: `projects/{project_number}/apps/{app}/releases/{release}` - "releaseNotes": { # Notes that belong to a release. # Notes of the release. + "openInvitationCount": 42, # Output only. Number of testers who were invited (incl. expired invitations), but did not (yet) accept the invitation. + "releaseNotes": { # Notes that belong to a release. # Notes about the release. "text": "A String", # The text of the release notes. }, + "testState": "A String", # Output only. The overall state of tests run on this release "testingUri": "A String", # Output only. A link to the release in the tester web clip or Android app that lets testers (which were granted access to the app) view release notes and install the app onto their devices. "updateTime": "A String", # Output only. The time the release was last updated. } @@ -285,16 +307,23 @@

Method Details

An object of the form: { # A release of a Firebase app. + "acceptedInvitationCount": 42, # Output only. Number of testers with accepted invitations. + "androidPackageRegistrationState": "A String", # Output only. Registration state of the Android package (BinaryType.APK). "binaryDownloadUri": "A String", # Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file. + "binaryType": "A String", # Output only. Type of binary. "buildVersion": "A String", # Output only. Build version of the release. For an Android release, the build version is the `versionCode`. For an iOS release, the build version is the `CFBundleVersion`. "createTime": "A String", # Output only. The time the release was created. "displayVersion": "A String", # Output only. Display version of the release. For an Android release, the display version is the `versionName`. For an iOS release, the display version is the `CFBundleShortVersionString`. "expireTime": "A String", # Output only. The time the release will expire. + "feedbackCount": 42, # Output only. Number of feedback reports left by testers. "firebaseConsoleUri": "A String", # Output only. A link to the Firebase console displaying a single release. + "installationCount": 42, # Output only. Number of testers who have downloaded this release. "name": "A String", # The name of the release resource. Format: `projects/{project_number}/apps/{app}/releases/{release}` - "releaseNotes": { # Notes that belong to a release. # Notes of the release. + "openInvitationCount": 42, # Output only. Number of testers who were invited (incl. expired invitations), but did not (yet) accept the invitation. + "releaseNotes": { # Notes that belong to a release. # Notes about the release. "text": "A String", # The text of the release notes. }, + "testState": "A String", # Output only. The overall state of tests run on this release "testingUri": "A String", # Output only. A link to the release in the tester web clip or Android app that lets testers (which were granted access to the app) view release notes and install the app onto their devices. "updateTime": "A String", # Output only. The time the release was last updated. }
diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json index 5000770430..c0c3313e9a 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json @@ -273,12 +273,12 @@ ], "parameters": { "filter": { -"description": "Optional. The expression to filter releases listed in the response. To learn more about filtering, refer to [Google's AIP-160 standard](http://aip.dev/160). Supported fields: - `releaseNotes.text` supports `=` (can contain a wildcard character (`*`) at the beginning or end of the string) - `createTime` supports `<`, `<=`, `>` and `>=`, and expects an RFC-3339 formatted string Examples: - `createTime <= \"2021-09-08T00:00:00+04:00\"` - `releaseNotes.text=\"fixes\" AND createTime >= \"2021-09-08T00:00:00.0Z\"` - `releaseNotes.text=\"*v1.0.0-rc*\"`", +"description": "Optional. The expression to filter releases listed in the response. To learn more about filtering, refer to the [AIP-160 standard](http://aip.dev/160). Supported fields: - Time fields supporting `<`, `<=`, `>` and `>=`; expecting an RFC-3339 formatted string: - `create_time` (or `createTime`) - `update_time` (or `updateTime`) - `expire_time` (or `expireTime`) - Text fields supporting `=`. The compared text can contain a wildcard character (`*`) at the beginning and/or end of the string which also enables case-insensitive matching: - `release_notes.text` (or `releaseNotes.text`) - `display_version` (or `displayVersion`) - `build_version` (or `buildVersion`). Examples: - `createTime <= \"2021-09-08T00:00:00+04:00\"` - `expire_time > \"2021-09-08T00:00:00+04:00\"` - `releaseNotes.text=\"fixes\" AND createTime >= \"2021-09-08T00:00:00.0Z\"` - `releaseNotes.text=\"*v1.0.0-rc*\"` - `(display_version = \"v1.0.0-rc2\" AND `build_version = \"123\") OR release_notes = \"*v1.0.0-rc2 (123)*\"`", "location": "query", "type": "string" }, "orderBy": { -"description": "Optional. The fields used to order releases. Supported fields: - `createTime` To specify descending order for a field, append a \"desc\" suffix, for example, `createTime desc`. If this parameter is not set, releases are ordered by `createTime` in descending order.", +"description": "Optional. The fields used to order releases. Supported fields: - `create_time` (or `createTime`) - `update_time` (or `updateTime`) - `expire_time` (or `expireTime`) To specify descending order for a field, append a \"desc\" suffix, for example, `createTime desc`. If this parameter is not set, releases are ordered by `createTime` in descending order.", "location": "query", "type": "string" }, @@ -946,7 +946,7 @@ } } }, -"revision": "20260518", +"revision": "20260723", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -1695,6 +1695,11 @@ "$ref": "GoogleFirebaseAppdistroV1Release" }, "type": "array" +}, +"totalSize": { +"description": "The total number of releases.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -1721,11 +1726,51 @@ "description": "A release of a Firebase app.", "id": "GoogleFirebaseAppdistroV1Release", "properties": { +"acceptedInvitationCount": { +"description": "Output only. Number of testers with accepted invitations.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"androidPackageRegistrationState": { +"description": "Output only. Registration state of the Android package (BinaryType.APK).", +"enum": [ +"ANDROID_PACKAGE_REGISTRATION_STATE_UNSPECIFIED", +"REGISTERED", +"NOT_REGISTERED", +"REGISTERED_WITH_ANOTHER_CERTIFICATE_FINGERPRINT" +], +"enumDescriptions": [ +"Default value.", +"Package is registered with the release binary's certificate fingerprint.", +"Package is not registered with any public certificate.", +"Package is registered with another public certificate fingerprint." +], +"readOnly": true, +"type": "string" +}, "binaryDownloadUri": { "description": "Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file.", "readOnly": true, "type": "string" }, +"binaryType": { +"description": "Output only. Type of binary.", +"enum": [ +"BINARY_TYPE_UNSPECIFIED", +"IPA", +"APK", +"AAB" +], +"enumDescriptions": [ +"unspecified binary type", +"iOS App Store package", +"Android Application package", +"Android App Bundle" +], +"readOnly": true, +"type": "string" +}, "buildVersion": { "description": "Output only. Build version of the release. For an Android release, the build version is the `versionCode`. For an iOS release, the build version is the `CFBundleVersion`.", "readOnly": true, @@ -1748,18 +1793,57 @@ "readOnly": true, "type": "string" }, +"feedbackCount": { +"description": "Output only. Number of feedback reports left by testers.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "firebaseConsoleUri": { "description": "Output only. A link to the Firebase console displaying a single release.", "readOnly": true, "type": "string" }, +"installationCount": { +"description": "Output only. Number of testers who have downloaded this release.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "name": { "description": "The name of the release resource. Format: `projects/{project_number}/apps/{app}/releases/{release}`", "type": "string" }, +"openInvitationCount": { +"description": "Output only. Number of testers who were invited (incl. expired invitations), but did not (yet) accept the invitation.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "releaseNotes": { "$ref": "GoogleFirebaseAppdistroV1ReleaseNotes", -"description": "Notes of the release." +"description": "Notes about the release." +}, +"testState": { +"description": "Output only. The overall state of tests run on this release", +"enum": [ +"TEST_STATE_UNSPECIFIED", +"NO_TESTS_REQUESTED", +"IN_PROGRESS", +"PASSED", +"FAILED", +"INCONCLUSIVE" +], +"enumDescriptions": [ +"No test state specified", +"No tests have been requested for this release", +"One or more device executions are in progress", +"All device executions passed during the most recent test", +"Some device executions failed during the most recent test", +"Some device executions were inconclusive, but none failed, during the most recent test" +], +"readOnly": true, +"type": "string" }, "testingUri": { "description": "Output only. A link to the release in the tester web clip or Android app that lets testers (which were granted access to the app) view release notes and install the app onto their devices.", diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 44714abaad..c07a2a22b6 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -868,7 +868,7 @@ } } }, -"revision": "20260518", +"revision": "20260723", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -913,11 +913,51 @@ "description": "A release of a Firebase app.", "id": "GoogleFirebaseAppdistroV1Release", "properties": { +"acceptedInvitationCount": { +"description": "Output only. Number of testers with accepted invitations.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"androidPackageRegistrationState": { +"description": "Output only. Registration state of the Android package (BinaryType.APK).", +"enum": [ +"ANDROID_PACKAGE_REGISTRATION_STATE_UNSPECIFIED", +"REGISTERED", +"NOT_REGISTERED", +"REGISTERED_WITH_ANOTHER_CERTIFICATE_FINGERPRINT" +], +"enumDescriptions": [ +"Default value.", +"Package is registered with the release binary's certificate fingerprint.", +"Package is not registered with any public certificate.", +"Package is registered with another public certificate fingerprint." +], +"readOnly": true, +"type": "string" +}, "binaryDownloadUri": { "description": "Output only. A signed link (which expires in one hour) to directly download the app binary (IPA/APK/AAB) file.", "readOnly": true, "type": "string" }, +"binaryType": { +"description": "Output only. Type of binary.", +"enum": [ +"BINARY_TYPE_UNSPECIFIED", +"IPA", +"APK", +"AAB" +], +"enumDescriptions": [ +"unspecified binary type", +"iOS App Store package", +"Android Application package", +"Android App Bundle" +], +"readOnly": true, +"type": "string" +}, "buildVersion": { "description": "Output only. Build version of the release. For an Android release, the build version is the `versionCode`. For an iOS release, the build version is the `CFBundleVersion`.", "readOnly": true, @@ -940,18 +980,57 @@ "readOnly": true, "type": "string" }, +"feedbackCount": { +"description": "Output only. Number of feedback reports left by testers.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "firebaseConsoleUri": { "description": "Output only. A link to the Firebase console displaying a single release.", "readOnly": true, "type": "string" }, +"installationCount": { +"description": "Output only. Number of testers who have downloaded this release.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "name": { "description": "The name of the release resource. Format: `projects/{project_number}/apps/{app}/releases/{release}`", "type": "string" }, +"openInvitationCount": { +"description": "Output only. Number of testers who were invited (incl. expired invitations), but did not (yet) accept the invitation.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "releaseNotes": { "$ref": "GoogleFirebaseAppdistroV1ReleaseNotes", -"description": "Notes of the release." +"description": "Notes about the release." +}, +"testState": { +"description": "Output only. The overall state of tests run on this release", +"enum": [ +"TEST_STATE_UNSPECIFIED", +"NO_TESTS_REQUESTED", +"IN_PROGRESS", +"PASSED", +"FAILED", +"INCONCLUSIVE" +], +"enumDescriptions": [ +"No test state specified", +"No tests have been requested for this release", +"One or more device executions are in progress", +"All device executions passed during the most recent test", +"Some device executions failed during the most recent test", +"Some device executions were inconclusive, but none failed, during the most recent test" +], +"readOnly": true, +"type": "string" }, "testingUri": { "description": "Output only. A link to the release in the tester web clip or Android app that lets testers (which were granted access to the app) view release notes and install the app onto their devices.", From 6ea92583f436a21c4530f908f7b587a0eb7ea2da Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:05 +0000 Subject: [PATCH 51/84] feat(firebasedataconnect): update the api #### firebasedataconnect:v1 The following keys were added: - schemas.CloudSqlInstance.properties.edition (Total Keys: 2) - schemas.Service.properties.connectors (Total Keys: 3) - schemas.Service.properties.schemas (Total Keys: 3) - schemas.Service.properties.source.$ref (Total Keys: 1) #### firebasedataconnect:v1beta The following keys were added: - schemas.CloudSqlInstance.properties.edition (Total Keys: 2) - schemas.Service.properties.connectors (Total Keys: 3) - schemas.Service.properties.schemas (Total Keys: 3) - schemas.Service.properties.source.$ref (Total Keys: 1) --- ...onnect_v1.projects.locations.services.html | 329 ++++++++++++++++++ ...1.projects.locations.services.schemas.html | 4 + ...ct_v1beta.projects.locations.services.html | 329 ++++++++++++++++++ ...a.projects.locations.services.schemas.html | 4 + .../documents/firebasedataconnect.v1.json | 39 ++- .../documents/firebasedataconnect.v1beta.json | 39 ++- 6 files changed, 742 insertions(+), 2 deletions(-) diff --git a/docs/dyn/firebasedataconnect_v1.projects.locations.services.html b/docs/dyn/firebasedataconnect_v1.projects.locations.services.html index d8c768134c..795b5984bc 100644 --- a/docs/dyn/firebasedataconnect_v1.projects.locations.services.html +++ b/docs/dyn/firebasedataconnect_v1.projects.locations.services.html @@ -139,6 +139,35 @@

Method Details

"annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", }, + "connectors": [ # Output only. The list of connectors in this service. + { # Connector consists of a set of operations, i.e. queries and mutations. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "clientCache": { # Client caching settings of a connector. # Optional. The client cache settings of the connector. + "entityIdIncluded": True or False, # Optional. A field that, if true, means that responses served by this connector will include entityIds in GraphQL response extensions. This helps the client SDK cache responses in an improved way, known as "normalized caching", if caching is enabled on the client. Each entityId is a stable key based on primary key values. Therefore, this field should only be set to true if the primary keys of accessed tables do not contain sensitive information. + "strictValidationEnabled": True or False, # Optional. A field that, if true, enables stricter validation on the connector source code to make sure the operation response shapes are suitable for client-side caching. This can include additional errors and warnings. For example, using the same alias for different fields is disallowed, as it may cause conflicts or confusion with normalized caching. (This field is off by default for compatibility, but enabling it is highly recommended to catch common caching pitfalls.) + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ``` + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the connector. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the connector. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], "createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) @@ -147,6 +176,59 @@

Method Details

}, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. + "schemas": [ # Output only. The list of schemas in this service. + { # The application schema of a Firebase SQL Connect service. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "datasources": [ # Required. The data sources linked in the schema. + { # A data source that backs Firebase SQL Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, + "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. + "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. + "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` + }, + "database": "A String", # Required. Name of the PostgreSQL database. + "ephemeral": True or False, # Output only. Ephemeral is true if this SQL Connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the SQL Connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, SQL Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. + "schemaMigration": "A String", # Optional. Configure how to perform automatic PostgreSQL schema migration before deploying the FDC schema. This is an additive-only operation. + "schemaValidation": "A String", # Optional. Configure how much PostgreSQL schema validation to perform against the live database before deploying the FDC schema. + "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. + }, + }, + ], + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the schema, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ``` Right now, the only supported schema is "main". + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the schema. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the application schema. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], + "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "uid": "A String", # Output only. System-assigned, unique identifier. "updateTime": "A String", # Output only. [Output only] Update time stamp. } @@ -412,6 +494,7 @@

Method Details

}, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` }, "database": "A String", # Required. Name of the PostgreSQL database. @@ -525,6 +608,35 @@

Method Details

"annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", }, + "connectors": [ # Output only. The list of connectors in this service. + { # Connector consists of a set of operations, i.e. queries and mutations. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "clientCache": { # Client caching settings of a connector. # Optional. The client cache settings of the connector. + "entityIdIncluded": True or False, # Optional. A field that, if true, means that responses served by this connector will include entityIds in GraphQL response extensions. This helps the client SDK cache responses in an improved way, known as "normalized caching", if caching is enabled on the client. Each entityId is a stable key based on primary key values. Therefore, this field should only be set to true if the primary keys of accessed tables do not contain sensitive information. + "strictValidationEnabled": True or False, # Optional. A field that, if true, enables stricter validation on the connector source code to make sure the operation response shapes are suitable for client-side caching. This can include additional errors and warnings. For example, using the same alias for different fields is disallowed, as it may cause conflicts or confusion with normalized caching. (This field is off by default for compatibility, but enabling it is highly recommended to catch common caching pitfalls.) + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ``` + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the connector. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the connector. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], "createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) @@ -533,6 +645,59 @@

Method Details

}, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. + "schemas": [ # Output only. The list of schemas in this service. + { # The application schema of a Firebase SQL Connect service. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "datasources": [ # Required. The data sources linked in the schema. + { # A data source that backs Firebase SQL Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, + "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. + "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. + "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` + }, + "database": "A String", # Required. Name of the PostgreSQL database. + "ephemeral": True or False, # Output only. Ephemeral is true if this SQL Connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the SQL Connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, SQL Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. + "schemaMigration": "A String", # Optional. Configure how to perform automatic PostgreSQL schema migration before deploying the FDC schema. This is an additive-only operation. + "schemaValidation": "A String", # Optional. Configure how much PostgreSQL schema validation to perform against the live database before deploying the FDC schema. + "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. + }, + }, + ], + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the schema, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ``` Right now, the only supported schema is "main". + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the schema. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the application schema. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], + "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "uid": "A String", # Output only. System-assigned, unique identifier. "updateTime": "A String", # Output only. [Output only] Update time stamp. }
@@ -645,6 +810,35 @@

Method Details

"annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", }, + "connectors": [ # Output only. The list of connectors in this service. + { # Connector consists of a set of operations, i.e. queries and mutations. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "clientCache": { # Client caching settings of a connector. # Optional. The client cache settings of the connector. + "entityIdIncluded": True or False, # Optional. A field that, if true, means that responses served by this connector will include entityIds in GraphQL response extensions. This helps the client SDK cache responses in an improved way, known as "normalized caching", if caching is enabled on the client. Each entityId is a stable key based on primary key values. Therefore, this field should only be set to true if the primary keys of accessed tables do not contain sensitive information. + "strictValidationEnabled": True or False, # Optional. A field that, if true, enables stricter validation on the connector source code to make sure the operation response shapes are suitable for client-side caching. This can include additional errors and warnings. For example, using the same alias for different fields is disallowed, as it may cause conflicts or confusion with normalized caching. (This field is off by default for compatibility, but enabling it is highly recommended to catch common caching pitfalls.) + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ``` + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the connector. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the connector. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], "createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) @@ -653,6 +847,59 @@

Method Details

}, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. + "schemas": [ # Output only. The list of schemas in this service. + { # The application schema of a Firebase SQL Connect service. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "datasources": [ # Required. The data sources linked in the schema. + { # A data source that backs Firebase SQL Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, + "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. + "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. + "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` + }, + "database": "A String", # Required. Name of the PostgreSQL database. + "ephemeral": True or False, # Output only. Ephemeral is true if this SQL Connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the SQL Connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, SQL Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. + "schemaMigration": "A String", # Optional. Configure how to perform automatic PostgreSQL schema migration before deploying the FDC schema. This is an additive-only operation. + "schemaValidation": "A String", # Optional. Configure how much PostgreSQL schema validation to perform against the live database before deploying the FDC schema. + "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. + }, + }, + ], + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the schema, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ``` Right now, the only supported schema is "main". + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the schema. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the application schema. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], + "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "uid": "A String", # Output only. System-assigned, unique identifier. "updateTime": "A String", # Output only. [Output only] Update time stamp. }, @@ -690,6 +937,35 @@

Method Details

"annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", }, + "connectors": [ # Output only. The list of connectors in this service. + { # Connector consists of a set of operations, i.e. queries and mutations. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "clientCache": { # Client caching settings of a connector. # Optional. The client cache settings of the connector. + "entityIdIncluded": True or False, # Optional. A field that, if true, means that responses served by this connector will include entityIds in GraphQL response extensions. This helps the client SDK cache responses in an improved way, known as "normalized caching", if caching is enabled on the client. Each entityId is a stable key based on primary key values. Therefore, this field should only be set to true if the primary keys of accessed tables do not contain sensitive information. + "strictValidationEnabled": True or False, # Optional. A field that, if true, enables stricter validation on the connector source code to make sure the operation response shapes are suitable for client-side caching. This can include additional errors and warnings. For example, using the same alias for different fields is disallowed, as it may cause conflicts or confusion with normalized caching. (This field is off by default for compatibility, but enabling it is highly recommended to catch common caching pitfalls.) + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ``` + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the connector. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the connector. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], "createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) @@ -698,6 +974,59 @@

Method Details

}, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. + "schemas": [ # Output only. The list of schemas in this service. + { # The application schema of a Firebase SQL Connect service. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "datasources": [ # Required. The data sources linked in the schema. + { # A data source that backs Firebase SQL Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, + "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. + "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. + "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` + }, + "database": "A String", # Required. Name of the PostgreSQL database. + "ephemeral": True or False, # Output only. Ephemeral is true if this SQL Connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the SQL Connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, SQL Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. + "schemaMigration": "A String", # Optional. Configure how to perform automatic PostgreSQL schema migration before deploying the FDC schema. This is an additive-only operation. + "schemaValidation": "A String", # Optional. Configure how much PostgreSQL schema validation to perform against the live database before deploying the FDC schema. + "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. + }, + }, + ], + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the schema, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ``` Right now, the only supported schema is "main". + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the schema. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the application schema. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], + "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "uid": "A String", # Output only. System-assigned, unique identifier. "updateTime": "A String", # Output only. [Output only] Update time stamp. } diff --git a/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html b/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html index f432e520fd..077bf77d6a 100644 --- a/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html +++ b/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html @@ -123,6 +123,7 @@

Method Details

}, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` }, "database": "A String", # Required. Name of the PostgreSQL database. @@ -252,6 +253,7 @@

Method Details

}, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` }, "database": "A String", # Required. Name of the PostgreSQL database. @@ -317,6 +319,7 @@

Method Details

}, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` }, "database": "A String", # Required. Name of the PostgreSQL database. @@ -389,6 +392,7 @@

Method Details

}, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` }, "database": "A String", # Required. Name of the PostgreSQL database. diff --git a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.html b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.html index 6543f53f05..02229dadd5 100644 --- a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.html +++ b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.html @@ -139,6 +139,35 @@

Method Details

"annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", }, + "connectors": [ # Output only. The list of connectors in this service. + { # Connector consists of a set of operations, i.e. queries and mutations. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "clientCache": { # Client caching settings of a connector. # Optional. The client cache settings of the connector. + "entityIdIncluded": True or False, # Optional. A field that, if true, means that responses served by this connector will include entityIds in GraphQL response extensions. This helps the client SDK cache responses in an improved way, known as "normalized caching", if caching is enabled on the client. Each entityId is a stable key based on primary key values. Therefore, this field should only be set to true if the primary keys of accessed tables do not contain sensitive information. + "strictValidationEnabled": True or False, # Optional. A field that, if true, enables stricter validation on the connector source code to make sure the operation response shapes are suitable for client-side caching. This can include additional errors and warnings. For example, using the same alias for different fields is disallowed, as it may cause conflicts or confusion with normalized caching. (This field is off by default for compatibility, but enabling it is highly recommended to catch common caching pitfalls.) + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ``` + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the connector. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the connector. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], "createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) @@ -147,6 +176,59 @@

Method Details

}, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. + "schemas": [ # Output only. The list of schemas in this service. + { # The application schema of a Firebase SQL Connect service. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "datasources": [ # Required. The data sources linked in the schema. + { # A data source that backs Firebase SQL Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, + "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. + "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. + "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` + }, + "database": "A String", # Required. Name of the PostgreSQL database. + "ephemeral": True or False, # Output only. Ephemeral is true if this SQL Connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the SQL Connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, SQL Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. + "schemaMigration": "A String", # Optional. Configure how to perform automatic PostgreSQL schema migration before deploying the FDC schema. This is an additive-only operation. + "schemaValidation": "A String", # Optional. Configure how much PostgreSQL schema validation to perform against the live database before deploying the FDC schema. + "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. + }, + }, + ], + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the schema, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ``` Right now, the only supported schema is "main". + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the schema. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the application schema. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], + "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "uid": "A String", # Output only. System-assigned, unique identifier. "updateTime": "A String", # Output only. [Output only] Update time stamp. } @@ -412,6 +494,7 @@

Method Details

}, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` }, "database": "A String", # Required. Name of the PostgreSQL database. @@ -525,6 +608,35 @@

Method Details

"annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", }, + "connectors": [ # Output only. The list of connectors in this service. + { # Connector consists of a set of operations, i.e. queries and mutations. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "clientCache": { # Client caching settings of a connector. # Optional. The client cache settings of the connector. + "entityIdIncluded": True or False, # Optional. A field that, if true, means that responses served by this connector will include entityIds in GraphQL response extensions. This helps the client SDK cache responses in an improved way, known as "normalized caching", if caching is enabled on the client. Each entityId is a stable key based on primary key values. Therefore, this field should only be set to true if the primary keys of accessed tables do not contain sensitive information. + "strictValidationEnabled": True or False, # Optional. A field that, if true, enables stricter validation on the connector source code to make sure the operation response shapes are suitable for client-side caching. This can include additional errors and warnings. For example, using the same alias for different fields is disallowed, as it may cause conflicts or confusion with normalized caching. (This field is off by default for compatibility, but enabling it is highly recommended to catch common caching pitfalls.) + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ``` + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the connector. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the connector. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], "createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) @@ -533,6 +645,59 @@

Method Details

}, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. + "schemas": [ # Output only. The list of schemas in this service. + { # The application schema of a Firebase SQL Connect service. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "datasources": [ # Required. The data sources linked in the schema. + { # A data source that backs Firebase SQL Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, + "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. + "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. + "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` + }, + "database": "A String", # Required. Name of the PostgreSQL database. + "ephemeral": True or False, # Output only. Ephemeral is true if this SQL Connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the SQL Connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, SQL Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. + "schemaMigration": "A String", # Optional. Configure how to perform automatic PostgreSQL schema migration before deploying the FDC schema. This is an additive-only operation. + "schemaValidation": "A String", # Optional. Configure how much PostgreSQL schema validation to perform against the live database before deploying the FDC schema. + "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. + }, + }, + ], + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the schema, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ``` Right now, the only supported schema is "main". + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the schema. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the application schema. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], + "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "uid": "A String", # Output only. System-assigned, unique identifier. "updateTime": "A String", # Output only. [Output only] Update time stamp. }
@@ -645,6 +810,35 @@

Method Details

"annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", }, + "connectors": [ # Output only. The list of connectors in this service. + { # Connector consists of a set of operations, i.e. queries and mutations. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "clientCache": { # Client caching settings of a connector. # Optional. The client cache settings of the connector. + "entityIdIncluded": True or False, # Optional. A field that, if true, means that responses served by this connector will include entityIds in GraphQL response extensions. This helps the client SDK cache responses in an improved way, known as "normalized caching", if caching is enabled on the client. Each entityId is a stable key based on primary key values. Therefore, this field should only be set to true if the primary keys of accessed tables do not contain sensitive information. + "strictValidationEnabled": True or False, # Optional. A field that, if true, enables stricter validation on the connector source code to make sure the operation response shapes are suitable for client-side caching. This can include additional errors and warnings. For example, using the same alias for different fields is disallowed, as it may cause conflicts or confusion with normalized caching. (This field is off by default for compatibility, but enabling it is highly recommended to catch common caching pitfalls.) + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ``` + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the connector. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the connector. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], "createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) @@ -653,6 +847,59 @@

Method Details

}, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. + "schemas": [ # Output only. The list of schemas in this service. + { # The application schema of a Firebase SQL Connect service. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "datasources": [ # Required. The data sources linked in the schema. + { # A data source that backs Firebase SQL Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, + "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. + "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. + "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` + }, + "database": "A String", # Required. Name of the PostgreSQL database. + "ephemeral": True or False, # Output only. Ephemeral is true if this SQL Connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the SQL Connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, SQL Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. + "schemaMigration": "A String", # Optional. Configure how to perform automatic PostgreSQL schema migration before deploying the FDC schema. This is an additive-only operation. + "schemaValidation": "A String", # Optional. Configure how much PostgreSQL schema validation to perform against the live database before deploying the FDC schema. + "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. + }, + }, + ], + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the schema, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ``` Right now, the only supported schema is "main". + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the schema. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the application schema. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], + "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "uid": "A String", # Output only. System-assigned, unique identifier. "updateTime": "A String", # Output only. [Output only] Update time stamp. }, @@ -690,6 +937,35 @@

Method Details

"annotations": { # Optional. Stores small amounts of arbitrary data. "a_key": "A String", }, + "connectors": [ # Output only. The list of connectors in this service. + { # Connector consists of a set of operations, i.e. queries and mutations. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "clientCache": { # Client caching settings of a connector. # Optional. The client cache settings of the connector. + "entityIdIncluded": True or False, # Optional. A field that, if true, means that responses served by this connector will include entityIds in GraphQL response extensions. This helps the client SDK cache responses in an improved way, known as "normalized caching", if caching is enabled on the client. Each entityId is a stable key based on primary key values. Therefore, this field should only be set to true if the primary keys of accessed tables do not contain sensitive information. + "strictValidationEnabled": True or False, # Optional. A field that, if true, enables stricter validation on the connector source code to make sure the operation response shapes are suitable for client-side caching. This can include additional errors and warnings. For example, using the same alias for different fields is disallowed, as it may cause conflicts or confusion with normalized caching. (This field is off by default for compatibility, but enabling it is highly recommended to catch common caching pitfalls.) + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ``` + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the connector. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the connector. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], "createTime": "A String", # Output only. [Output only] Create time stamp. "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) @@ -698,6 +974,59 @@

Method Details

}, "name": "A String", # Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections. "reconciling": True or False, # Output only. A field that if true, indicates that the system is working update the service. + "schemas": [ # Output only. The list of schemas in this service. + { # The application schema of a Firebase SQL Connect service. + "annotations": { # Optional. Stores small amounts of arbitrary data. + "a_key": "A String", + }, + "createTime": "A String", # Output only. [Output only] Create time stamp. + "datasources": [ # Required. The data sources linked in the schema. + { # A data source that backs Firebase SQL Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, + "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. + "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. + "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` + }, + "database": "A String", # Required. Name of the PostgreSQL database. + "ephemeral": True or False, # Output only. Ephemeral is true if this SQL Connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the SQL Connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, SQL Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. + "schemaMigration": "A String", # Optional. Configure how to perform automatic PostgreSQL schema migration before deploying the FDC schema. This is an additive-only operation. + "schemaValidation": "A String", # Optional. Configure how much PostgreSQL schema validation to perform against the live database before deploying the FDC schema. + "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. + }, + }, + ], + "displayName": "A String", # Optional. Mutable human-readable name. 63 character limit. + "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154) + "labels": { # Optional. Labels as key value pairs. + "a_key": "A String", + }, + "name": "A String", # Identifier. The relative resource name of the schema, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ``` Right now, the only supported schema is "main". + "reconciling": True or False, # Output only. A field that if true, indicates that the system is working to compile and deploy the schema. + "source": { # Used to represent a set of source files. # Required. The source files that comprise the application schema. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, + "uid": "A String", # Output only. System-assigned, unique identifier. + "updateTime": "A String", # Output only. [Output only] Update time stamp. + }, + ], + "source": { # Used to represent a set of source files. # Optional. Input only. The source files for service, schemas, and connectors. + "files": [ # Required. The files that comprise the source set. + { # Individual files. + "content": "A String", # Required. The file's textual content. + "path": "A String", # Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql). + }, + ], + }, "uid": "A String", # Output only. System-assigned, unique identifier. "updateTime": "A String", # Output only. [Output only] Update time stamp. } diff --git a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html index 07038b6d83..b7a0f12ef2 100644 --- a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html +++ b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html @@ -123,6 +123,7 @@

Method Details

}, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` }, "database": "A String", # Required. Name of the PostgreSQL database. @@ -252,6 +253,7 @@

Method Details

}, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` }, "database": "A String", # Required. Name of the PostgreSQL database. @@ -317,6 +319,7 @@

Method Details

}, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` }, "database": "A String", # Required. Name of the PostgreSQL database. @@ -389,6 +392,7 @@

Method Details

}, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. + "edition": "A String", # Output only. [Output only] The Cloud SQL instance edition. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` }, "database": "A String", # Required. Name of the PostgreSQL database. diff --git a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json index d5429850fb..768700b136 100644 --- a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json @@ -1221,7 +1221,7 @@ } } }, -"revision": "20260531", +"revision": "20260726", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1249,6 +1249,23 @@ "description": "Settings for CloudSQL instance configuration.", "id": "CloudSqlInstance", "properties": { +"edition": { +"description": "Output only. [Output only] The Cloud SQL instance edition.", +"enum": [ +"EDITION_UNSPECIFIED", +"EDITION_ENTERPRISE", +"EDITION_ENTERPRISE_PLUS", +"EDITION_DEVELOPER" +], +"enumDescriptions": [ +"Unspecified edition.", +"Enterprise edition.", +"Enterprise Plus edition.", +"Developer edition (includes AI Developer edition)." +], +"readOnly": true, +"type": "string" +}, "instance": { "description": "Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ```", "type": "string" @@ -2211,6 +2228,14 @@ "description": "Optional. Stores small amounts of arbitrary data.", "type": "object" }, +"connectors": { +"description": "Output only. The list of connectors in this service.", +"items": { +"$ref": "Connector" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Output only. [Output only] Create time stamp.", "format": "google-datetime", @@ -2242,6 +2267,18 @@ "readOnly": true, "type": "boolean" }, +"schemas": { +"description": "Output only. The list of schemas in this service.", +"items": { +"$ref": "Schema" +}, +"readOnly": true, +"type": "array" +}, +"source": { +"$ref": "Source", +"description": "Optional. Input only. The source files for service, schemas, and connectors." +}, "uid": { "description": "Output only. System-assigned, unique identifier.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json index 8f8da7021c..4106dd58b0 100644 --- a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json @@ -1221,7 +1221,7 @@ } } }, -"revision": "20260531", +"revision": "20260726", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1249,6 +1249,23 @@ "description": "Settings for CloudSQL instance configuration.", "id": "CloudSqlInstance", "properties": { +"edition": { +"description": "Output only. [Output only] The Cloud SQL instance edition.", +"enum": [ +"EDITION_UNSPECIFIED", +"EDITION_ENTERPRISE", +"EDITION_ENTERPRISE_PLUS", +"EDITION_DEVELOPER" +], +"enumDescriptions": [ +"Unspecified edition.", +"Enterprise edition.", +"Enterprise Plus edition.", +"Developer edition (includes AI Developer edition)." +], +"readOnly": true, +"type": "string" +}, "instance": { "description": "Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ```", "type": "string" @@ -2211,6 +2228,14 @@ "description": "Optional. Stores small amounts of arbitrary data.", "type": "object" }, +"connectors": { +"description": "Output only. The list of connectors in this service.", +"items": { +"$ref": "Connector" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Output only. [Output only] Create time stamp.", "format": "google-datetime", @@ -2242,6 +2267,18 @@ "readOnly": true, "type": "boolean" }, +"schemas": { +"description": "Output only. The list of schemas in this service.", +"items": { +"$ref": "Schema" +}, +"readOnly": true, +"type": "array" +}, +"source": { +"$ref": "Source", +"description": "Optional. Input only. The source files for service, schemas, and connectors." +}, "uid": { "description": "Output only. System-assigned, unique identifier.", "readOnly": true, From 626d3cc940af50f4cfb5681964b43a0ef85da16b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:05 +0000 Subject: [PATCH 52/84] feat(firebaseml): update the api #### firebaseml:v2beta The following keys were added: - schemas.GoogleCloudAiplatformV1beta1AudioTranscription (Total Keys: 30) - schemas.GoogleCloudAiplatformV1beta1CodeExecutionResult.properties.id.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ExecutableCode.properties.id.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.audioTranscriptionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GoogleMaps.properties.groundingTypes.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1GoogleMapsPlaces (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1GoogleMapsRouting (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1Part.properties.audioTranscription.$ref (Total Keys: 1) --- ....projects.locations.publishers.models.html | 173 ++++++++++++++++++ .../documents/firebaseml.v2beta.json | 150 ++++++++++++++- 2 files changed, 322 insertions(+), 1 deletion(-) diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index fe6e0e2ed8..9eeab174b8 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -106,12 +106,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -182,6 +195,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -329,12 +359,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -514,6 +557,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -672,12 +721,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -748,6 +810,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -905,12 +984,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1106,6 +1198,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -1260,12 +1358,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1540,12 +1651,25 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1616,6 +1740,23 @@

Method Details

], "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Config for audio transcription (speech recognition). + "adaptationPhrases": [ # Optional. A list of phrases to bias the ASR model towards. + "A String", + ], + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", + ], + "diarization": True or False, # Optional. Configures speaker diarization. + "languageAuto": { # Indicates the language of the audio should be automatically detected. # Optional. The model will detect the language automatically. + }, + "languageHints": { # Provides hints to the model about possible languages present in the audio. # Optional. Specifies one or more languages in the audio. + "languageCodes": [ # Required. BCP-47 language codes. At least one must be specified. + "A String", + ], + }, + "wordTimestamp": True or False, # Optional. Configures word-level timestamp generation. + }, "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. @@ -1773,12 +1914,25 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. @@ -1974,6 +2128,12 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + }, + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + }, + }, }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. @@ -2128,12 +2288,25 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "audioTranscription": { # The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. # Optional. Audio (input or output) transcription. This is only set when this Part contains audio data. + "speakerLabel": "A String", # Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + "text": "A String", # Required. The transcription text of this audio segment. + "words": [ # Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + { # Information about a single recognized word. + "endOffset": "A String", # Optional. End offset in time of the word relative to the start of the audio. + "startOffset": "A String", # Optional. Start offset in time of the word relative to the start of the audio. + "word": "A String", # Required. Transcript of the word. + }, + ], + }, "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "id": "A String", # Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. + "id": "A String", # Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. "language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 224a9e7264..488bc84437 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20260628", +"revision": "20260726", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -310,6 +310,107 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1AudioTranscription": { +"description": "The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label.", +"id": "GoogleCloudAiplatformV1beta1AudioTranscription", +"properties": { +"speakerLabel": { +"description": "Optional. A label identifying the speaker of this audio segment (e.g. \"spk_1\", \"spk_2\"). Present when diarization is set.", +"type": "string" +}, +"text": { +"description": "Required. The transcription text of this audio segment.", +"type": "string" +}, +"words": { +"description": "Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AudioTranscriptionConfig": { +"description": "Configuration for speech recognition (transcription).", +"id": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfig", +"properties": { +"adaptationPhrases": { +"deprecated": true, +"description": "Optional. A list of phrases to bias the ASR model towards.", +"items": { +"type": "string" +}, +"type": "array" +}, +"customVocabulary": { +"description": "Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms.", +"items": { +"type": "string" +}, +"type": "array" +}, +"diarization": { +"description": "Optional. Configures speaker diarization.", +"type": "boolean" +}, +"languageAuto": { +"$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto", +"description": "Optional. The model will detect the language automatically." +}, +"languageHints": { +"$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints", +"description": "Optional. Specifies one or more languages in the audio." +}, +"wordTimestamp": { +"description": "Optional. Configures word-level timestamp generation.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto": { +"description": "Indicates the language of the audio should be automatically detected.", +"id": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto", +"properties": {}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints": { +"description": "Provides hints to the model about possible languages present in the audio.", +"id": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints", +"properties": { +"languageCodes": { +"description": "Required. BCP-47 language codes. At least one must be specified.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo": { +"description": "Information about a single recognized word.", +"id": "GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo", +"properties": { +"endOffset": { +"description": "Optional. End offset in time of the word relative to the start of the audio.", +"format": "google-duration", +"type": "string" +}, +"startOffset": { +"description": "Optional. Start offset in time of the word relative to the start of the audio.", +"format": "google-duration", +"type": "string" +}, +"word": { +"description": "Required. Transcript of the word.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1AuthConfig": { "description": "Auth configuration to run the extension.", "id": "GoogleCloudAiplatformV1beta1AuthConfig", @@ -628,6 +729,10 @@ "description": "Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used.", "id": "GoogleCloudAiplatformV1beta1CodeExecutionResult", "properties": { +"id": { +"description": "Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.", +"type": "string" +}, "outcome": { "description": "Required. Outcome of the code execution.", "enum": [ @@ -802,6 +907,10 @@ "description": "Required. The code to be executed.", "type": "string" }, +"id": { +"description": "Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.", +"type": "string" +}, "language": { "description": "Required. Programming language of the `code`.", "enum": [ @@ -1358,6 +1467,10 @@ "description": "Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.", "type": "boolean" }, +"audioTranscriptionConfig": { +"$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfig", +"description": "Optional. Config for audio transcription (speech recognition)." +}, "candidateCount": { "description": "Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.", "format": "int32", @@ -1616,10 +1729,41 @@ "deprecated": true, "description": "Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response.", "type": "boolean" +}, +"groundingTypes": { +"$ref": "GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes", +"description": "Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes": { +"description": "Defines the types of Google Maps grounding that can be enabled and their configurations.", +"id": "GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes", +"properties": { +"places": { +"$ref": "GoogleCloudAiplatformV1beta1GoogleMapsPlaces", +"description": "Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified." +}, +"routing": { +"$ref": "GoogleCloudAiplatformV1beta1GoogleMapsRouting", +"description": "Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute)." } }, "type": "object" }, +"GoogleCloudAiplatformV1beta1GoogleMapsPlaces": { +"description": "Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified.", +"id": "GoogleCloudAiplatformV1beta1GoogleMapsPlaces", +"properties": {}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1GoogleMapsRouting": { +"description": "Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute).", +"id": "GoogleCloudAiplatformV1beta1GoogleMapsRouting", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { "description": "Tool to retrieve public web data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", @@ -2200,6 +2344,10 @@ "description": "A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", "id": "GoogleCloudAiplatformV1beta1Part", "properties": { +"audioTranscription": { +"$ref": "GoogleCloudAiplatformV1beta1AudioTranscription", +"description": "Optional. Audio (input or output) transcription. This is only set when this Part contains audio data." +}, "codeExecutionResult": { "$ref": "GoogleCloudAiplatformV1beta1CodeExecutionResult", "description": "Optional. The result of executing the ExecutableCode." From f08abf737306f3bb5421179e03d580510250ba3d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:05 +0000 Subject: [PATCH 53/84] feat(firestore): update the api #### firestore:v1 The following keys were deleted: - resources.projects.resources.databases.resources.documents.methods.createDocument.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.delete.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.get.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.list.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.listDocuments.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.patch.parameters.requestOptions.requestTags (Total Keys: 3) - schemas.BatchGetDocumentsRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.BatchWriteRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.BeginTransactionRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.CommitRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.ExecutePipelineRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.ListCollectionIdsRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.ListenRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.PartitionQueryRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RequestOptions (Total Keys: 4) - schemas.RollbackRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RunAggregationQueryRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RunQueryRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.WriteRequest.properties.requestOptions.$ref (Total Keys: 1) #### firestore:v1beta1 The following keys were deleted: - resources.projects.resources.databases.resources.documents.methods.createDocument.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.delete.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.get.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.list.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.listDocuments.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.patch.parameters.requestOptions.requestTags (Total Keys: 3) - schemas.BatchGetDocumentsRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.BatchWriteRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.BeginTransactionRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.CommitRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.ExecutePipelineRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.ListCollectionIdsRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.ListenRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.PartitionQueryRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RequestOptions (Total Keys: 4) - schemas.RollbackRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RunAggregationQueryRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RunQueryRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.WriteRequest.properties.requestOptions.$ref (Total Keys: 1) --- ...store_v1.projects.databases.documents.html | 90 +++------------- ..._v1beta1.projects.databases.documents.html | 90 +++------------- .../documents/firestore.v1.json | 100 +----------------- .../documents/firestore.v1beta1.json | 100 +----------------- 4 files changed, 26 insertions(+), 354 deletions(-) diff --git a/docs/dyn/firestore_v1.projects.databases.documents.html b/docs/dyn/firestore_v1.projects.databases.documents.html index cc75153f12..97b9063037 100644 --- a/docs/dyn/firestore_v1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1.projects.databases.documents.html @@ -90,19 +90,19 @@

Instance Methods

commit(database, body=None, x__xgafv=None)

Commits a transaction, while optionally updating documents.

- createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, requestOptions_requestTags=None, x__xgafv=None)

+ createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, x__xgafv=None)

Creates a new document.

- delete(name, currentDocument_exists=None, currentDocument_updateTime=None, requestOptions_requestTags=None, x__xgafv=None)

+ delete(name, currentDocument_exists=None, currentDocument_updateTime=None, x__xgafv=None)

Deletes a document.

executePipeline(database, body=None, x__xgafv=None)

Executes a pipeline query.

- get(name, mask_fieldPaths=None, readTime=None, requestOptions_requestTags=None, transaction=None, x__xgafv=None)

+ get(name, mask_fieldPaths=None, readTime=None, transaction=None, x__xgafv=None)

Gets a single document.

- list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None)

+ list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, showMissing=None, transaction=None, x__xgafv=None)

Lists documents.

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

@@ -111,7 +111,7 @@

Instance Methods

listCollectionIds_next()

Retrieves the next page of results.

- listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None)

+ listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, showMissing=None, transaction=None, x__xgafv=None)

Lists documents.

listDocuments_next()

@@ -129,7 +129,7 @@

Instance Methods

partitionQuery_next()

Retrieves the next page of results.

- patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, requestOptions_requestTags=None, updateMask_fieldPaths=None, x__xgafv=None)

+ patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, updateMask_fieldPaths=None, x__xgafv=None)

Updates or inserts a document.

rollback(database, body=None, x__xgafv=None)

@@ -172,11 +172,6 @@

Method Details

}, }, "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "transaction": "A String", # Reads documents in a transaction. } @@ -263,11 +258,6 @@

Method Details

"labels": { # Labels associated with this batch write. "a_key": "A String", }, - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "writes": [ # The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request. { # A write on a document. "currentDocument": { # A precondition on a document, used for conditional operations. # An optional precondition on the document. The write will fail if this is set and not met by the target document. @@ -759,11 +749,6 @@

Method Details

"retryTransaction": "A String", # An optional transaction to retry. }, }, - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, } x__xgafv: string, V1 error format. @@ -794,11 +779,6 @@

Method Details

The object takes the form of: { # The request for Firestore.Commit. - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "transaction": "A String", # If set, applies all writes in this transaction, and commits it. "writes": [ # The writes to apply. Always executed atomically and in order. { # A write on a document. @@ -1263,7 +1243,7 @@

Method Details

- createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, requestOptions_requestTags=None, x__xgafv=None) + createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, x__xgafv=None)
Creates a new document.
 
 Args:
@@ -1330,7 +1310,6 @@ 

Method Details

documentId: string, The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service. mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) - requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1397,14 +1376,13 @@

Method Details

- delete(name, currentDocument_exists=None, currentDocument_updateTime=None, requestOptions_requestTags=None, x__xgafv=None) + delete(name, currentDocument_exists=None, currentDocument_updateTime=None, x__xgafv=None)
Deletes a document.
 
 Args:
   name: string, Required. The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. (required)
   currentDocument_exists: boolean, When set to `true`, the target document must exist. When set to `false`, the target document must not exist.
   currentDocument_updateTime: string, When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.
-  requestOptions_requestTags: string, Optional. The request tags for the request. (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1438,11 +1416,6 @@ 

Method Details

}, }, "readTime": "A String", # Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "structuredPipeline": { # A Firestore query represented as an ordered list of operations / stages. This is considered the top-level function which plans and executes a query. It is logically equivalent to `query(stages, options)`, but prevents the client from having to build a function wrapper. # A pipelined operation. "options": { # Optional. Optional query-level arguments. "a_key": { # A message that can hold any of the supported value types. @@ -1588,14 +1561,13 @@

Method Details

- get(name, mask_fieldPaths=None, readTime=None, requestOptions_requestTags=None, transaction=None, x__xgafv=None) + get(name, mask_fieldPaths=None, readTime=None, transaction=None, x__xgafv=None)
Gets a single document.
 
 Args:
   name: string, Required. The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. (required)
   mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated)
   readTime: string, Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
-  requestOptions_requestTags: string, Optional. The request tags for the request. (repeated)
   transaction: string, Reads the document in a transaction.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -1663,7 +1635,7 @@ 

Method Details

- list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None) + list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, showMissing=None, transaction=None, x__xgafv=None)
Lists documents.
 
 Args:
@@ -1675,7 +1647,6 @@ 

Method Details

pageToken: string, Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token. readTime: string, Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. recursive: boolean, Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. - requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) showMissing: boolean, If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. transaction: string, Perform the read as part of an already active transaction. x__xgafv: string, V1 error format. @@ -1761,11 +1732,6 @@

Method Details

"pageSize": 42, # The maximum number of results to return. "pageToken": "A String", # A page token. Must be a value from ListCollectionIdsResponse. "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, } x__xgafv: string, V1 error format. @@ -1799,7 +1765,7 @@

Method Details

- listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None) + listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, showMissing=None, transaction=None, x__xgafv=None)
Lists documents.
 
 Args:
@@ -1811,7 +1777,6 @@ 

Method Details

pageToken: string, Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token. readTime: string, Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. recursive: boolean, Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. - requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) showMissing: boolean, If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. transaction: string, Perform the read as part of an already active transaction. x__xgafv: string, V1 error format. @@ -2197,11 +2162,6 @@

Method Details

"a_key": "A String", }, "removeTarget": 42, # The ID of a target to remove from this stream. - "requestOptions": { # Options for a server request. # Optional. The request options for the request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, } x__xgafv: string, V1 error format. @@ -2335,11 +2295,6 @@

Method Details

"pageToken": "A String", # The `next_page_token` value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets. For example, two subsequent calls using a page_token may return: * cursor B, cursor M, cursor Q * cursor A, cursor U, cursor W To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W "partitionCount": "A String", # The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available. "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "requestOptions": { # Options for a server request. # Optional. The request options for the request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. @@ -2681,7 +2636,7 @@

Method Details

- patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, requestOptions_requestTags=None, updateMask_fieldPaths=None, x__xgafv=None) + patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, updateMask_fieldPaths=None, x__xgafv=None)
Updates or inserts a document.
 
 Args:
@@ -2748,7 +2703,6 @@ 

Method Details

currentDocument_exists: boolean, When set to `true`, the target document must exist. When set to `false`, the target document must not exist. currentDocument_updateTime: string, When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned. mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) - requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) updateMask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) x__xgafv: string, V1 error format. Allowed values @@ -2825,11 +2779,6 @@

Method Details

The object takes the form of: { # The request for Firestore.Rollback. - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "transaction": "A String", # Required. The transaction to roll back. } @@ -2868,11 +2817,6 @@

Method Details

}, }, "readTime": "A String", # Executes the query at the given timestamp. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "requestOptions": { # Options for a server request. # Optional. The request options for the request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "structuredAggregationQuery": { # Firestore query for running an aggregation over a StructuredQuery. # An aggregation query. "aggregations": [ # Optional. Series of aggregations to apply over the results of the `structured_query`. Requires: * A minimum of one and maximum of five aggregations per query. { # Defines an aggregation that produces a single result. @@ -3258,11 +3202,6 @@

Method Details

}, }, "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. @@ -3623,11 +3562,6 @@

Method Details

"labels": { # Labels associated with this write request. "a_key": "A String", }, - "requestOptions": { # Options for a server request. # Optional. The request options for the request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "streamId": "A String", # The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created. "streamToken": "A String", # A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the `stream_id` field. Leave this field unset when creating a new stream. "writes": [ # The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests. diff --git a/docs/dyn/firestore_v1beta1.projects.databases.documents.html b/docs/dyn/firestore_v1beta1.projects.databases.documents.html index 6c5f1174b2..851bdd8ffb 100644 --- a/docs/dyn/firestore_v1beta1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1beta1.projects.databases.documents.html @@ -90,19 +90,19 @@

Instance Methods

commit(database, body=None, x__xgafv=None)

Commits a transaction, while optionally updating documents.

- createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, requestOptions_requestTags=None, x__xgafv=None)

+ createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, x__xgafv=None)

Creates a new document.

- delete(name, currentDocument_exists=None, currentDocument_updateTime=None, requestOptions_requestTags=None, x__xgafv=None)

+ delete(name, currentDocument_exists=None, currentDocument_updateTime=None, x__xgafv=None)

Deletes a document.

executePipeline(database, body=None, x__xgafv=None)

Executes a pipeline query.

- get(name, mask_fieldPaths=None, readTime=None, requestOptions_requestTags=None, transaction=None, x__xgafv=None)

+ get(name, mask_fieldPaths=None, readTime=None, transaction=None, x__xgafv=None)

Gets a single document.

- list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None)

+ list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, showMissing=None, transaction=None, x__xgafv=None)

Lists documents.

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

@@ -111,7 +111,7 @@

Instance Methods

listCollectionIds_next()

Retrieves the next page of results.

- listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None)

+ listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, showMissing=None, transaction=None, x__xgafv=None)

Lists documents.

listDocuments_next()

@@ -129,7 +129,7 @@

Instance Methods

partitionQuery_next()

Retrieves the next page of results.

- patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, requestOptions_requestTags=None, updateMask_fieldPaths=None, x__xgafv=None)

+ patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, updateMask_fieldPaths=None, x__xgafv=None)

Updates or inserts a document.

rollback(database, body=None, x__xgafv=None)

@@ -172,11 +172,6 @@

Method Details

}, }, "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "transaction": "A String", # Reads documents in a transaction. } @@ -263,11 +258,6 @@

Method Details

"labels": { # Labels associated with this batch write. "a_key": "A String", }, - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "writes": [ # The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request. { # A write on a document. "currentDocument": { # A precondition on a document, used for conditional operations. # An optional precondition on the document. The write will fail if this is set and not met by the target document. @@ -759,11 +749,6 @@

Method Details

"retryTransaction": "A String", # An optional transaction to retry. }, }, - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, } x__xgafv: string, V1 error format. @@ -794,11 +779,6 @@

Method Details

The object takes the form of: { # The request for Firestore.Commit. - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "transaction": "A String", # If set, applies all writes in this transaction, and commits it. "writes": [ # The writes to apply. Always executed atomically and in order. { # A write on a document. @@ -1263,7 +1243,7 @@

Method Details

- createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, requestOptions_requestTags=None, x__xgafv=None) + createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, x__xgafv=None)
Creates a new document.
 
 Args:
@@ -1330,7 +1310,6 @@ 

Method Details

documentId: string, The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service. mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) - requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1397,14 +1376,13 @@

Method Details

- delete(name, currentDocument_exists=None, currentDocument_updateTime=None, requestOptions_requestTags=None, x__xgafv=None) + delete(name, currentDocument_exists=None, currentDocument_updateTime=None, x__xgafv=None)
Deletes a document.
 
 Args:
   name: string, Required. The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. (required)
   currentDocument_exists: boolean, When set to `true`, the target document must exist. When set to `false`, the target document must not exist.
   currentDocument_updateTime: string, When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.
-  requestOptions_requestTags: string, Optional. The request tags for the request. (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1438,11 +1416,6 @@ 

Method Details

}, }, "readTime": "A String", # Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "structuredPipeline": { # A Firestore query represented as an ordered list of operations / stages. This is considered the top-level function which plans and executes a query. It is logically equivalent to `query(stages, options)`, but prevents the client from having to build a function wrapper. # A pipelined operation. "options": { # Optional. Optional query-level arguments. "a_key": { # A message that can hold any of the supported value types. @@ -1588,14 +1561,13 @@

Method Details

- get(name, mask_fieldPaths=None, readTime=None, requestOptions_requestTags=None, transaction=None, x__xgafv=None) + get(name, mask_fieldPaths=None, readTime=None, transaction=None, x__xgafv=None)
Gets a single document.
 
 Args:
   name: string, Required. The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. (required)
   mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated)
   readTime: string, Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
-  requestOptions_requestTags: string, Optional. The request tags for the request. (repeated)
   transaction: string, Reads the document in a transaction.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -1663,7 +1635,7 @@ 

Method Details

- list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None) + list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, showMissing=None, transaction=None, x__xgafv=None)
Lists documents.
 
 Args:
@@ -1675,7 +1647,6 @@ 

Method Details

pageToken: string, Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token. readTime: string, Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. recursive: boolean, Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. - requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) showMissing: boolean, If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. transaction: string, Perform the read as part of an already active transaction. x__xgafv: string, V1 error format. @@ -1761,11 +1732,6 @@

Method Details

"pageSize": 42, # The maximum number of results to return. "pageToken": "A String", # A page token. Must be a value from ListCollectionIdsResponse. "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, } x__xgafv: string, V1 error format. @@ -1799,7 +1765,7 @@

Method Details

- listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None) + listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, showMissing=None, transaction=None, x__xgafv=None)
Lists documents.
 
 Args:
@@ -1811,7 +1777,6 @@ 

Method Details

pageToken: string, Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token. readTime: string, Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. recursive: boolean, Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. - requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) showMissing: boolean, If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. transaction: string, Perform the read as part of an already active transaction. x__xgafv: string, V1 error format. @@ -2197,11 +2162,6 @@

Method Details

"a_key": "A String", }, "removeTarget": 42, # The ID of a target to remove from this stream. - "requestOptions": { # Options for a server request. # Optional. The request options for the request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, } x__xgafv: string, V1 error format. @@ -2335,11 +2295,6 @@

Method Details

"pageToken": "A String", # The `next_page_token` value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets. For example, two subsequent calls using a page_token may return: * cursor B, cursor M, cursor Q * cursor A, cursor U, cursor W To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W "partitionCount": "A String", # The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available. "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "requestOptions": { # Options for a server request. # Optional. The request options for the request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. @@ -2681,7 +2636,7 @@

Method Details

- patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, requestOptions_requestTags=None, updateMask_fieldPaths=None, x__xgafv=None) + patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, updateMask_fieldPaths=None, x__xgafv=None)
Updates or inserts a document.
 
 Args:
@@ -2748,7 +2703,6 @@ 

Method Details

currentDocument_exists: boolean, When set to `true`, the target document must exist. When set to `false`, the target document must not exist. currentDocument_updateTime: string, When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned. mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) - requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) updateMask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) x__xgafv: string, V1 error format. Allowed values @@ -2825,11 +2779,6 @@

Method Details

The object takes the form of: { # The request for Firestore.Rollback. - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "transaction": "A String", # Required. The transaction to roll back. } @@ -2868,11 +2817,6 @@

Method Details

}, }, "readTime": "A String", # Executes the query at the given timestamp. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "requestOptions": { # Options for a server request. # Optional. The request options for the request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "structuredAggregationQuery": { # Firestore query for running an aggregation over a StructuredQuery. # An aggregation query. "aggregations": [ # Optional. Series of aggregations to apply over the results of the `structured_query`. Requires: * A minimum of one and maximum of five aggregations per query. { # Defines an aggregation that produces a single result. @@ -3258,11 +3202,6 @@

Method Details

}, }, "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. - "requestOptions": { # Options for a server request. # Optional. The request options for this request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. @@ -3623,11 +3562,6 @@

Method Details

"labels": { # Labels associated with this write request. "a_key": "A String", }, - "requestOptions": { # Options for a server request. # Optional. The request options for the request. - "requestTags": [ # Optional. The request tags for the request. - "A String", - ], - }, "streamId": "A String", # The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created. "streamToken": "A String", # A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the `stream_id` field. Leave this field unset when creating a new stream. "writes": [ # The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests. diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index 0ae336bc9e..b7c2fc92e3 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -1403,12 +1403,6 @@ "pattern": "^projects/[^/]+/databases/[^/]+/documents/.*$", "required": true, "type": "string" -}, -"requestOptions.requestTags": { -"description": "Optional. The request tags for the request.", -"location": "query", -"repeated": true, -"type": "string" } }, "path": "v1/{+parent}/{collectionId}", @@ -1449,12 +1443,6 @@ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$", "required": true, "type": "string" -}, -"requestOptions.requestTags": { -"description": "Optional. The request tags for the request.", -"location": "query", -"repeated": true, -"type": "string" } }, "path": "v1/{+name}", @@ -1523,12 +1511,6 @@ "location": "query", "type": "string" }, -"requestOptions.requestTags": { -"description": "Optional. The request tags for the request.", -"location": "query", -"repeated": true, -"type": "string" -}, "transaction": { "description": "Reads the document in a transaction.", "format": "byte", @@ -1601,12 +1583,6 @@ "location": "query", "type": "boolean" }, -"requestOptions.requestTags": { -"description": "Optional. The request tags for the request.", -"location": "query", -"repeated": true, -"type": "string" -}, "showMissing": { "description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.", "location": "query", @@ -1713,12 +1689,6 @@ "location": "query", "type": "boolean" }, -"requestOptions.requestTags": { -"description": "Optional. The request tags for the request.", -"location": "query", -"repeated": true, -"type": "string" -}, "showMissing": { "description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.", "location": "query", @@ -1831,12 +1801,6 @@ "required": true, "type": "string" }, -"requestOptions.requestTags": { -"description": "Optional. The request tags for the request.", -"location": "query", -"repeated": true, -"type": "string" -}, "updateMask.fieldPaths": { "description": "The list of field paths in the mask. See Document.fields for a field path syntax reference.", "location": "query", @@ -2481,7 +2445,7 @@ } } }, -"revision": "20260702", +"revision": "20260706", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2570,10 +2534,6 @@ "format": "google-datetime", "type": "string" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." -}, "transaction": { "description": "Reads documents in a transaction.", "format": "byte", @@ -2618,10 +2578,6 @@ "description": "Labels associated with this batch write.", "type": "object" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." -}, "writes": { "description": "The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.", "items": { @@ -2660,10 +2616,6 @@ "options": { "$ref": "TransactionOptions", "description": "The options for the transaction. Defaults to a read-write transaction." -}, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." } }, "type": "object" @@ -2732,10 +2684,6 @@ "description": "The request for Firestore.Commit.", "id": "CommitRequest", "properties": { -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." -}, "transaction": { "description": "If set, applies all writes in this transaction, and commits it.", "format": "byte", @@ -3000,10 +2948,6 @@ "format": "google-datetime", "type": "string" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." -}, "structuredPipeline": { "$ref": "StructuredPipeline", "description": "A pipelined operation." @@ -5069,10 +5013,6 @@ "description": "Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.", "format": "google-datetime", "type": "string" -}, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." } }, "type": "object" @@ -5150,10 +5090,6 @@ "description": "The ID of a target to remove from this stream.", "format": "int32", "type": "integer" -}, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for the request." } }, "type": "object" @@ -5281,10 +5217,6 @@ "format": "google-datetime", "type": "string" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for the request." -}, "structuredQuery": { "$ref": "StructuredQuery", "description": "A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported." @@ -5425,28 +5357,10 @@ }, "type": "object" }, -"RequestOptions": { -"description": "Options for a server request.", -"id": "RequestOptions", -"properties": { -"requestTags": { -"description": "Optional. The request tags for the request.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "RollbackRequest": { "description": "The request for Firestore.Rollback.", "id": "RollbackRequest", "properties": { -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." -}, "transaction": { "description": "Required. The transaction to roll back.", "format": "byte", @@ -5472,10 +5386,6 @@ "format": "google-datetime", "type": "string" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for the request." -}, "structuredAggregationQuery": { "$ref": "StructuredAggregationQuery", "description": "An aggregation query." @@ -5530,10 +5440,6 @@ "format": "google-datetime", "type": "string" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." -}, "structuredQuery": { "$ref": "StructuredQuery", "description": "A structured query." @@ -5982,10 +5888,6 @@ "description": "Labels associated with this write request.", "type": "object" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for the request." -}, "streamId": { "description": "The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json index afcae1d346..2c8ec7e4af 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json @@ -775,12 +775,6 @@ "pattern": "^projects/[^/]+/databases/[^/]+/documents/.*$", "required": true, "type": "string" -}, -"requestOptions.requestTags": { -"description": "Optional. The request tags for the request.", -"location": "query", -"repeated": true, -"type": "string" } }, "path": "v1beta1/{+parent}/{collectionId}", @@ -821,12 +815,6 @@ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$", "required": true, "type": "string" -}, -"requestOptions.requestTags": { -"description": "Optional. The request tags for the request.", -"location": "query", -"repeated": true, -"type": "string" } }, "path": "v1beta1/{+name}", @@ -895,12 +883,6 @@ "location": "query", "type": "string" }, -"requestOptions.requestTags": { -"description": "Optional. The request tags for the request.", -"location": "query", -"repeated": true, -"type": "string" -}, "transaction": { "description": "Reads the document in a transaction.", "format": "byte", @@ -973,12 +955,6 @@ "location": "query", "type": "boolean" }, -"requestOptions.requestTags": { -"description": "Optional. The request tags for the request.", -"location": "query", -"repeated": true, -"type": "string" -}, "showMissing": { "description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.", "location": "query", @@ -1085,12 +1061,6 @@ "location": "query", "type": "boolean" }, -"requestOptions.requestTags": { -"description": "Optional. The request tags for the request.", -"location": "query", -"repeated": true, -"type": "string" -}, "showMissing": { "description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.", "location": "query", @@ -1203,12 +1173,6 @@ "required": true, "type": "string" }, -"requestOptions.requestTags": { -"description": "Optional. The request tags for the request.", -"location": "query", -"repeated": true, -"type": "string" -}, "updateMask.fieldPaths": { "description": "The list of field paths in the mask. See Document.fields for a field path syntax reference.", "location": "query", @@ -1477,7 +1441,7 @@ } } }, -"revision": "20260702", +"revision": "20260706", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -1566,10 +1530,6 @@ "format": "google-datetime", "type": "string" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." -}, "transaction": { "description": "Reads documents in a transaction.", "format": "byte", @@ -1614,10 +1574,6 @@ "description": "Labels associated with this batch write.", "type": "object" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." -}, "writes": { "description": "The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.", "items": { @@ -1656,10 +1612,6 @@ "options": { "$ref": "TransactionOptions", "description": "The options for the transaction. Defaults to a read-write transaction." -}, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." } }, "type": "object" @@ -1728,10 +1680,6 @@ "description": "The request for Firestore.Commit.", "id": "CommitRequest", "properties": { -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." -}, "transaction": { "description": "If set, applies all writes in this transaction, and commits it.", "format": "byte", @@ -1996,10 +1944,6 @@ "format": "google-datetime", "type": "string" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." -}, "structuredPipeline": { "$ref": "StructuredPipeline", "description": "A pipelined operation." @@ -2934,10 +2878,6 @@ "description": "Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.", "format": "google-datetime", "type": "string" -}, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." } }, "type": "object" @@ -2997,10 +2937,6 @@ "description": "The ID of a target to remove from this stream.", "format": "int32", "type": "integer" -}, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for the request." } }, "type": "object" @@ -3094,10 +3030,6 @@ "format": "google-datetime", "type": "string" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for the request." -}, "structuredQuery": { "$ref": "StructuredQuery", "description": "A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported." @@ -3238,28 +3170,10 @@ }, "type": "object" }, -"RequestOptions": { -"description": "Options for a server request.", -"id": "RequestOptions", -"properties": { -"requestTags": { -"description": "Optional. The request tags for the request.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "RollbackRequest": { "description": "The request for Firestore.Rollback.", "id": "RollbackRequest", "properties": { -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." -}, "transaction": { "description": "Required. The transaction to roll back.", "format": "byte", @@ -3285,10 +3199,6 @@ "format": "google-datetime", "type": "string" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for the request." -}, "structuredAggregationQuery": { "$ref": "StructuredAggregationQuery", "description": "An aggregation query." @@ -3343,10 +3253,6 @@ "format": "google-datetime", "type": "string" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for this request." -}, "structuredQuery": { "$ref": "StructuredQuery", "description": "A structured query." @@ -3795,10 +3701,6 @@ "description": "Labels associated with this write request.", "type": "object" }, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Optional. The request options for the request." -}, "streamId": { "description": "The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.", "type": "string" From f90bc834fa7ec7f2a1e8ff47ded9f84d91780fc1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:05 +0000 Subject: [PATCH 54/84] feat(gkebackup): update the api #### gkebackup:v1 The following keys were added: - schemas.BackupRuleDetail.properties.storageTier.type (Total Keys: 1) --- googleapiclient/discovery_cache/documents/gkebackup.v1.json | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/gkebackup.v1.json b/googleapiclient/discovery_cache/documents/gkebackup.v1.json index e12ef2d03b..59597a4628 100644 --- a/googleapiclient/discovery_cache/documents/gkebackup.v1.json +++ b/googleapiclient/discovery_cache/documents/gkebackup.v1.json @@ -2560,7 +2560,7 @@ } } }, -"revision": "20260624", +"revision": "20260715", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -3410,6 +3410,10 @@ "ruleName": { "description": "Backup Rule Name.", "type": "string" +}, +"storageTier": { +"description": "The storage tier of the BackupRule.", +"type": "string" } }, "type": "object" From 8cb939b49fa67ae9e676cdbc4a9668520245f343 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:05 +0000 Subject: [PATCH 55/84] feat(gkehub): update the api #### gkehub:v1 The following keys were added: - schemas.ServiceMeshFeatureSpec.properties.modernizationStrategy.type (Total Keys: 1) #### gkehub:v1alpha The following keys were added: - schemas.ServiceMeshFeatureSpec.properties.modernizationStrategy.type (Total Keys: 1) #### gkehub:v1beta The following keys were added: - schemas.ServiceMeshFeatureSpec.properties.modernizationStrategy.type (Total Keys: 1) --- ...gkehub_v1.projects.locations.features.html | 28 +++++++++++-------- ...b_v1alpha.projects.locations.features.html | 28 +++++++++++-------- ...ub_v1beta.projects.locations.features.html | 28 +++++++++++-------- ...ojects.locations.memberships.features.html | 16 +++++------ ...ojects.locations.memberships.features.html | 16 +++++------ ...ojects.locations.memberships.features.html | 16 +++++------ .../discovery_cache/documents/gkehub.v1.json | 20 +++++++++++-- .../documents/gkehub.v1alpha.json | 22 +++++++++++++-- .../documents/gkehub.v1beta.json | 20 +++++++++++-- .../discovery_cache/documents/gkehub.v2.json | 6 ++-- .../documents/gkehub.v2alpha.json | 6 ++-- .../documents/gkehub.v2beta.json | 6 ++-- 12 files changed, 140 insertions(+), 72 deletions(-) diff --git a/docs/dyn/gkehub_v1.projects.locations.features.html b/docs/dyn/gkehub_v1.projects.locations.features.html index 4a06eb939a..bdc358e7ee 100644 --- a/docs/dyn/gkehub_v1.projects.locations.features.html +++ b/docs/dyn/gkehub_v1.projects.locations.features.html @@ -169,7 +169,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -384,7 +384,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -700,7 +700,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -957,6 +957,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for the fleet for the servicemesh feature # Servicemesh feature spec. "modernizationCompatibility": "A String", # Optional. Specifies modernization compatibility for the fleet. + "modernizationStrategy": "A String", # Optional. Declares your intended modernization strategy for the fleet. }, "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` @@ -1213,7 +1214,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1428,7 +1429,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1744,7 +1745,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2001,6 +2002,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for the fleet for the servicemesh feature # Servicemesh feature spec. "modernizationCompatibility": "A String", # Optional. Specifies modernization compatibility for the fleet. + "modernizationStrategy": "A String", # Optional. Declares your intended modernization strategy for the fleet. }, "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` @@ -2245,7 +2247,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2460,7 +2462,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2776,7 +2778,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -3033,6 +3035,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for the fleet for the servicemesh feature # Servicemesh feature spec. "modernizationCompatibility": "A String", # Optional. Specifies modernization compatibility for the fleet. + "modernizationStrategy": "A String", # Optional. Declares your intended modernization strategy for the fleet. }, "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` @@ -3232,7 +3235,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -3447,7 +3450,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -3763,7 +3766,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -4020,6 +4023,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for the fleet for the servicemesh feature # Servicemesh feature spec. "modernizationCompatibility": "A String", # Optional. Specifies modernization compatibility for the fleet. + "modernizationStrategy": "A String", # Optional. Declares your intended modernization strategy for the fleet. }, "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.features.html b/docs/dyn/gkehub_v1alpha.projects.locations.features.html index 5bad6ea678..8d16aeadac 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.features.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.features.html @@ -172,7 +172,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -395,7 +395,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -729,7 +729,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1074,6 +1074,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for the fleet for the servicemesh feature # Servicemesh feature spec. "modernizationCompatibility": "A String", # Optional. Specifies modernization compatibility for the fleet. + "modernizationStrategy": "A String", # Optional. Declares your intended modernization strategy for the fleet. }, "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. "billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure. @@ -1374,7 +1375,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1597,7 +1598,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1931,7 +1932,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2276,6 +2277,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for the fleet for the servicemesh feature # Servicemesh feature spec. "modernizationCompatibility": "A String", # Optional. Specifies modernization compatibility for the fleet. + "modernizationStrategy": "A String", # Optional. Declares your intended modernization strategy for the fleet. }, "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. "billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure. @@ -2564,7 +2566,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2787,7 +2789,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -3121,7 +3123,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -3466,6 +3468,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for the fleet for the servicemesh feature # Servicemesh feature spec. "modernizationCompatibility": "A String", # Optional. Specifies modernization compatibility for the fleet. + "modernizationStrategy": "A String", # Optional. Declares your intended modernization strategy for the fleet. }, "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. "billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure. @@ -3709,7 +3712,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -3932,7 +3935,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -4266,7 +4269,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -4611,6 +4614,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for the fleet for the servicemesh feature # Servicemesh feature spec. "modernizationCompatibility": "A String", # Optional. Specifies modernization compatibility for the fleet. + "modernizationStrategy": "A String", # Optional. Declares your intended modernization strategy for the fleet. }, "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. "billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.features.html b/docs/dyn/gkehub_v1beta.projects.locations.features.html index b742f44b0e..462fcb1a17 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.features.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.features.html @@ -172,7 +172,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -394,7 +394,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -719,7 +719,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -980,6 +980,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for the fleet for the servicemesh feature # Servicemesh feature spec. "modernizationCompatibility": "A String", # Optional. Specifies modernization compatibility for the fleet. + "modernizationStrategy": "A String", # Optional. Declares your intended modernization strategy for the fleet. }, "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. "billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure. @@ -1240,7 +1241,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1462,7 +1463,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1787,7 +1788,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2048,6 +2049,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for the fleet for the servicemesh feature # Servicemesh feature spec. "modernizationCompatibility": "A String", # Optional. Specifies modernization compatibility for the fleet. + "modernizationStrategy": "A String", # Optional. Declares your intended modernization strategy for the fleet. }, "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. "billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure. @@ -2296,7 +2298,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2518,7 +2520,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2843,7 +2845,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -3104,6 +3106,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for the fleet for the servicemesh feature # Servicemesh feature spec. "modernizationCompatibility": "A String", # Optional. Specifies modernization compatibility for the fleet. + "modernizationStrategy": "A String", # Optional. Declares your intended modernization strategy for the fleet. }, "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. "billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure. @@ -3307,7 +3310,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -3529,7 +3532,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -3854,7 +3857,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -4115,6 +4118,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for the fleet for the servicemesh feature # Servicemesh feature spec. "modernizationCompatibility": "A String", # Optional. Specifies modernization compatibility for the fleet. + "modernizationStrategy": "A String", # Optional. Declares your intended modernization strategy for the fleet. }, "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. "billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure. diff --git a/docs/dyn/gkehub_v2.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2.projects.locations.memberships.features.html index 938b572f35..bbac5fcaa6 100644 --- a/docs/dyn/gkehub_v2.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2.projects.locations.memberships.features.html @@ -174,7 +174,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -501,7 +501,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -882,7 +882,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1209,7 +1209,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1530,7 +1530,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1857,7 +1857,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2187,7 +2187,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2514,7 +2514,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. diff --git a/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html index 4ea11eee4d..93b61f619d 100644 --- a/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html @@ -174,7 +174,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -501,7 +501,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -882,7 +882,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1209,7 +1209,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1530,7 +1530,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1857,7 +1857,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2187,7 +2187,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2514,7 +2514,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. diff --git a/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html index c011cefceb..fa09b020ce 100644 --- a/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html @@ -174,7 +174,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -501,7 +501,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -882,7 +882,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1209,7 +1209,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1530,7 +1530,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -1857,7 +1857,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2187,7 +2187,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. @@ -2514,7 +2514,7 @@

Method Details

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. }, - "management": "A String", # Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades. + "management": "A String", # Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields. "policyController": { # Configuration for Policy Controller # Optional. Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index a41483bb7f..b96bd49603 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -2596,7 +2596,7 @@ } } }, -"revision": "20260706", +"revision": "20260719", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -3873,7 +3873,7 @@ }, "management": { "deprecated": true, -"description": "Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades.", +"description": "Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", @@ -7466,6 +7466,7 @@ false "MODERNIZATION_MODERNIZED_SOAKING", "MODERNIZATION_FINALIZED", "MODERNIZATION_ROLLING_BACK_FLEET", +"MODERNIZATION_MODERNIZED", "MODERNIZATION_COMPATIBLE", "MODERNIZATION_INCOMPATIBLE", "MODERNIZATION_INCOMPATIBLE_FLEET_SCALE", @@ -7532,6 +7533,7 @@ false "Modernization of all the fleet's clusters is complete. Soaking before finalizing the modernization.", "Modernization is finalized for all clusters in a fleet. Rollback is no longer allowed.", "Rollback is in progress for modernization of all clusters in a fleet.", +"Modernization of all the fleet's clusters is complete. Soaking before finalizing the modernization.", "Fleet is compatible for modernization.", "Fleet is not yet compatible for modernization.", "Fleet exceeds service mesh fleet-level scalability limits.", @@ -7680,6 +7682,20 @@ false "Google should not report modernization eligibility gaps." ], "type": "string" +}, +"modernizationStrategy": { +"description": "Optional. Declares your intended modernization strategy for the fleet.", +"enum": [ +"MODERNIZATION_STRATEGY_UNSPECIFIED", +"AUTOMATIC", +"DEFERRED" +], +"enumDescriptions": [ +"Default unspecified.", +"The infrastructure is automatically modernized. Setting this strategy initiates the modernization process. The system schedules the modernization subject to configured maintenance windows and maintenance exclusions.", +"The infrastructure is pinned to the legacy implementation. This fleet will not be selected for Google-driven modernization. If the resource is actively modernizing, or if the modernization has completed but is not yet finalized (e.g., during the soak time), setting this strategy triggers a rollback to the legacy state. If the modernization process has already been marked as finalized, setting this strategy has no effect." +], +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index dcc44ea47d..439885a675 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2740,7 +2740,7 @@ } } }, -"revision": "20260706", +"revision": "20260719", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -4204,7 +4204,7 @@ }, "management": { "deprecated": true, -"description": "Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades.", +"description": "Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", @@ -8053,6 +8053,7 @@ false "MODERNIZATION_MODERNIZED_SOAKING", "MODERNIZATION_FINALIZED", "MODERNIZATION_ROLLING_BACK_FLEET", +"MODERNIZATION_MODERNIZED", "MODERNIZATION_COMPATIBLE", "MODERNIZATION_INCOMPATIBLE", "MODERNIZATION_INCOMPATIBLE_FLEET_SCALE", @@ -8119,6 +8120,7 @@ false "Modernization of all the fleet's clusters is complete. Soaking before finalizing the modernization.", "Modernization is finalized for all clusters in a fleet. Rollback is no longer allowed.", "Rollback is in progress for modernization of all clusters in a fleet.", +"Modernization of all the fleet's clusters is complete. Soaking before finalizing the modernization.", "Fleet is compatible for modernization.", "Fleet is not yet compatible for modernization.", "Fleet exceeds service mesh fleet-level scalability limits.", @@ -8317,6 +8319,7 @@ false "MODERNIZATION_MODERNIZED_SOAKING", "MODERNIZATION_FINALIZED", "MODERNIZATION_ROLLING_BACK_FLEET", +"MODERNIZATION_MODERNIZED", "MODERNIZATION_COMPATIBLE", "MODERNIZATION_INCOMPATIBLE", "MODERNIZATION_INCOMPATIBLE_FLEET_SCALE", @@ -8383,6 +8386,7 @@ false "Modernization of all the fleet's clusters is complete. Soaking before finalizing the modernization.", "Modernization is finalized for all clusters in a fleet. Rollback is no longer allowed.", "Rollback is in progress for modernization of all clusters in a fleet.", +"Modernization of all clusters in the fleet is complete. Soaking before finalizing the modernization.", "Fleet is compatible for modernization.", "Fleet is not yet compatible for modernization.", "Fleet exceeds service mesh fleet-level scalability limits.", @@ -8434,6 +8438,20 @@ false "Google should not report modernization eligibility gaps." ], "type": "string" +}, +"modernizationStrategy": { +"description": "Optional. Declares your intended modernization strategy for the fleet.", +"enum": [ +"MODERNIZATION_STRATEGY_UNSPECIFIED", +"AUTOMATIC", +"DEFERRED" +], +"enumDescriptions": [ +"Default unspecified.", +"The infrastructure is automatically modernized. Setting this strategy initiates the modernization process. The system schedules the modernization subject to configured maintenance windows and maintenance exclusions.", +"The infrastructure is pinned to the legacy implementation. This fleet will not be selected for Google-driven modernization. If the resource is actively modernizing, or if the modernization has completed but is not yet finalized (e.g., during the soak time), setting this strategy triggers a rollback to the legacy state. If the modernization process has already been marked as finalized, setting this strategy has no effect." +], +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index c81ca8c19b..8d998a34cf 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2596,7 +2596,7 @@ } } }, -"revision": "20260706", +"revision": "20260719", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -3929,7 +3929,7 @@ }, "management": { "deprecated": true, -"description": "Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades.", +"description": "Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", @@ -7592,6 +7592,7 @@ false "MODERNIZATION_MODERNIZED_SOAKING", "MODERNIZATION_FINALIZED", "MODERNIZATION_ROLLING_BACK_FLEET", +"MODERNIZATION_MODERNIZED", "MODERNIZATION_COMPATIBLE", "MODERNIZATION_INCOMPATIBLE", "MODERNIZATION_INCOMPATIBLE_FLEET_SCALE", @@ -7658,6 +7659,7 @@ false "Modernization of all the fleet's clusters is complete. Soaking before finalizing the modernization.", "Modernization is finalized for all clusters in a fleet. Rollback is no longer allowed.", "Rollback is in progress for modernization of all clusters in a fleet.", +"Modernization of all the fleet's clusters is complete. Soaking before finalizing the modernization.", "Fleet is compatible for modernization.", "Fleet is not yet compatible for modernization.", "Fleet exceeds service mesh fleet-level scalability limits.", @@ -7806,6 +7808,20 @@ false "Google should not report modernization eligibility gaps." ], "type": "string" +}, +"modernizationStrategy": { +"description": "Optional. Declares your intended modernization strategy for the fleet.", +"enum": [ +"MODERNIZATION_STRATEGY_UNSPECIFIED", +"AUTOMATIC", +"DEFERRED" +], +"enumDescriptions": [ +"Default unspecified.", +"The infrastructure is automatically modernized. Setting this strategy initiates the modernization process. The system schedules the modernization subject to configured maintenance windows and maintenance exclusions.", +"The infrastructure is pinned to the legacy implementation. This fleet will not be selected for Google-driven modernization. If the resource is actively modernizing, or if the modernization has completed but is not yet finalized (e.g., during the soak time), setting this strategy triggers a rollback to the legacy state. If the modernization process has already been marked as finalized, setting this strategy has no effect." +], +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2.json b/googleapiclient/discovery_cache/documents/gkehub.v2.json index 93b5b838c6..051710b49c 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2.json @@ -554,7 +554,7 @@ } } }, -"revision": "20260623", +"revision": "20260719", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -1667,7 +1667,7 @@ }, "management": { "deprecated": true, -"description": "Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades.", +"description": "Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", @@ -3176,6 +3176,7 @@ "MODERNIZATION_MODERNIZED_SOAKING", "MODERNIZATION_FINALIZED", "MODERNIZATION_ROLLING_BACK_FLEET", +"MODERNIZATION_MODERNIZED", "MODERNIZATION_COMPATIBLE", "MODERNIZATION_INCOMPATIBLE", "MODERNIZATION_INCOMPATIBLE_FLEET_SCALE", @@ -3242,6 +3243,7 @@ "Modernization of all the fleet's clusters is complete. Soaking before finalizing the modernization.", "Modernization is finalized for all clusters in a fleet. Rollback is no longer allowed.", "Rollback is in progress for modernization of all clusters in a fleet.", +"Modernization of all the fleet's clusters is complete. Soaking before finalizing the modernization.", "Fleet is compatible for modernization.", "Fleet is not yet compatible for modernization.", "Fleet exceeds service mesh fleet-level scalability limits.", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json index f7b963de79..330f46814e 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json @@ -554,7 +554,7 @@ } } }, -"revision": "20260623", +"revision": "20260719", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -1667,7 +1667,7 @@ }, "management": { "deprecated": true, -"description": "Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades.", +"description": "Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", @@ -3176,6 +3176,7 @@ "MODERNIZATION_MODERNIZED_SOAKING", "MODERNIZATION_FINALIZED", "MODERNIZATION_ROLLING_BACK_FLEET", +"MODERNIZATION_MODERNIZED", "MODERNIZATION_COMPATIBLE", "MODERNIZATION_INCOMPATIBLE", "MODERNIZATION_INCOMPATIBLE_FLEET_SCALE", @@ -3242,6 +3243,7 @@ "Modernization of all the fleet's clusters is complete. Soaking before finalizing the modernization.", "Modernization is finalized for all clusters in a fleet. Rollback is no longer allowed.", "Rollback is in progress for modernization of all clusters in a fleet.", +"Modernization of all the fleet's clusters is complete. Soaking before finalizing the modernization.", "Fleet is compatible for modernization.", "Fleet is not yet compatible for modernization.", "Fleet exceeds service mesh fleet-level scalability limits.", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json index 1bb0975a8b..b6a37ad8b8 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json @@ -554,7 +554,7 @@ } } }, -"revision": "20260623", +"revision": "20260719", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -1667,7 +1667,7 @@ }, "management": { "deprecated": true, -"description": "Optional. Deprecated: From version 1.21.0, automatic Feature management is unavailable, and Config Sync only supports manual upgrades.", +"description": "Optional. Deprecated: Automatic Feature management is in Preview and is unavailable in version 1.21.0 and later, after which Config Sync only supports manual upgrades. If set to manual upgrades, clear this field instead, which is behaviorally equivalent but helps prevent compatibility issues with newer fields.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", @@ -3176,6 +3176,7 @@ "MODERNIZATION_MODERNIZED_SOAKING", "MODERNIZATION_FINALIZED", "MODERNIZATION_ROLLING_BACK_FLEET", +"MODERNIZATION_MODERNIZED", "MODERNIZATION_COMPATIBLE", "MODERNIZATION_INCOMPATIBLE", "MODERNIZATION_INCOMPATIBLE_FLEET_SCALE", @@ -3242,6 +3243,7 @@ "Modernization of all the fleet's clusters is complete. Soaking before finalizing the modernization.", "Modernization is finalized for all clusters in a fleet. Rollback is no longer allowed.", "Rollback is in progress for modernization of all clusters in a fleet.", +"Modernization of all the fleet's clusters is complete. Soaking before finalizing the modernization.", "Fleet is compatible for modernization.", "Fleet is not yet compatible for modernization.", "Fleet exceeds service mesh fleet-level scalability limits.", From 0d3ebbae3d20d7010ef4ce0a498e1ede434a637f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:06 +0000 Subject: [PATCH 56/84] feat(gmail): update the api #### gmail:v1 The following keys were added: - resources.users.resources.settings.resources.cse.resources.keypairs.methods.create.parameters.chainValidation (Total Keys: 3) --- .../gmail_v1.users.settings.cse.keypairs.html | 8 ++++++-- .../discovery_cache/documents/gmail.v1.json | 16 +++++++++++++++- 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/dyn/gmail_v1.users.settings.cse.keypairs.html b/docs/dyn/gmail_v1.users.settings.cse.keypairs.html index c272b1f71a..efe981c81a 100644 --- a/docs/dyn/gmail_v1.users.settings.cse.keypairs.html +++ b/docs/dyn/gmail_v1.users.settings.cse.keypairs.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(userId, body=None, x__xgafv=None)

+ create(userId, body=None, chainValidation=None, x__xgafv=None)

Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.

disable(userId, keyPairId, body=None, x__xgafv=None)

@@ -105,7 +105,7 @@

Method Details

- create(userId, body=None, x__xgafv=None) + create(userId, body=None, chainValidation=None, x__xgafv=None)
Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.
 
 Args:
@@ -136,6 +136,10 @@ 

Method Details

], } + chainValidation: string, The type of certificate chain validation to perform at creation. The request will be rejected if the uploaded chain fails to satisfy the requested validation checks. When unspecified, this parameter defaults to `all`. + Allowed values + all - Enable all certificate chain validation and certificate revocation checks. Recommended for normal use. + none - Disable all certificate chain validation and certificate revocation checks. This may be useful when deliberately creating key pairs with invalid, out-of-use certificate chains to be used only for decryption of historical S/MIME messages. Key pairs created with invalid or revoked certificates cannot be used in a CseIdentity object. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/googleapiclient/discovery_cache/documents/gmail.v1.json b/googleapiclient/discovery_cache/documents/gmail.v1.json index b41f86cb74..a072d28993 100644 --- a/googleapiclient/discovery_cache/documents/gmail.v1.json +++ b/googleapiclient/discovery_cache/documents/gmail.v1.json @@ -1822,6 +1822,20 @@ "userId" ], "parameters": { +"chainValidation": { +"default": "all", +"description": "The type of certificate chain validation to perform at creation. The request will be rejected if the uploaded chain fails to satisfy the requested validation checks. When unspecified, this parameter defaults to `all`.", +"enum": [ +"all", +"none" +], +"enumDescriptions": [ +"Enable all certificate chain validation and certificate revocation checks. Recommended for normal use.", +"Disable all certificate chain validation and certificate revocation checks. This may be useful when deliberately creating key pairs with invalid, out-of-use certificate chains to be used only for decryption of historical S/MIME messages. Key pairs created with invalid or revoked certificates cannot be used in a CseIdentity object." +], +"location": "query", +"type": "string" +}, "userId": { "default": "me", "description": "The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.", @@ -3077,7 +3091,7 @@ } } }, -"revision": "20260525", +"revision": "20260727", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { From e58cf326f76466e9c9bc0b4b16f75ef508d4abe5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:06 +0000 Subject: [PATCH 57/84] feat(health): update the api #### health:v4 The following keys were added: - schemas.DataPoint.properties.menstrualPeriod.$ref (Total Keys: 1) - schemas.DataPoint.properties.moods.$ref (Total Keys: 1) - schemas.DataPoint.properties.ovulationTest.$ref (Total Keys: 1) - schemas.DataPoint.properties.symptoms.$ref (Total Keys: 1) - schemas.MenstrualPeriod (Total Keys: 4) - schemas.Moods (Total Keys: 7) - schemas.OvulationTest (Total Keys: 4) - schemas.SleepMetadata.properties.mainSleep (Total Keys: 2) - schemas.Symptoms (Total Keys: 5) The following keys were changed: - resources.users.resources.dataTypes.resources.dataPoints.methods.batchDelete.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.create.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.patch.scopes (Total Keys: 1) --- .../health_v4.users.dataTypes.dataPoints.html | 437 +++++++++++++++++- .../discovery_cache/documents/health.v4.json | 330 ++++++++++++- 2 files changed, 751 insertions(+), 16 deletions(-) diff --git a/docs/dyn/health_v4.users.dataTypes.dataPoints.html b/docs/dyn/health_v4.users.dataTypes.dataPoints.html index 642c1b65e1..a658e7990d 100644 --- a/docs/dyn/health_v4.users.dataTypes.dataPoints.html +++ b/docs/dyn/health_v4.users.dataTypes.dataPoints.html @@ -636,7 +636,7 @@

Method Details

"exercise": { # An exercise that stores information about a physical activity. # Optional. Data for points in the `exercise` session data type collection. "activeDuration": "A String", # Optional. Duration excluding pauses. "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise. - "displayName": "A String", # Required. Exercise display name. + "displayName": "A String", # Required. The localized, human-readable name of the exercise. For all exercise types other than `OTHER`, the system ignores client input and overrides this field with a generated name based on `exercise_type` (e.g., "Walking" for `WALKING`). If `exercise_type` is `OTHER`, this field can contain the user's custom, free-form display name. "exerciseEvents": [ # Optional. Exercise events that happen during an exercise, such as pause & restarts. { # Represents instantaneous events that happen during an exercise, such as start, stop, pause, split. "eventTime": "A String", # Required. Exercise event time @@ -1074,6 +1074,66 @@

Method Details

"serviceVersion": "A String", # Output only. The service version used by the feature. }, }, + "menstrualPeriod": { # Menstrual period record. # Optional. Data for points in the `menstrual-period` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "notes": "A String", # Optional. Standard free-form notes captured at manual logging. + }, + "moods": { # Moods record. # Optional. Data for points in the `moods` sample data type collection. + "moods": [ # Required. The moods logged. + "A String", + ], + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which moods were measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "valences": [ # Optional. The valences. + "A String", + ], + }, "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. "nutritionLog": { # Holds information about food logged by a user. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not editable. # Optional. Data for points in the `nutrition-log` session data type collection. "energy": { # Represents the energy quantity. # Optional. The total energy of the food, measured in kilocalories (`kcal`). @@ -1142,6 +1202,26 @@

Method Details

"userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, + "ovulationTest": { # Ovulation test record. # Optional. Data for points in the `ovulation-test` sample data type collection. + "result": "A String", # Required. The result of the ovulation test. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which ovulation test was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured. @@ -1289,8 +1369,9 @@

Method Details

"startTime": "A String", # Required. The start time of the observed session. "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, - "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: processing, main, manually edited, stages status. + "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: `processed`, `main_sleep`, `manually_edited`, and `stages_status`. "externalId": "A String", # Optional. Sleep identifier relevant in the context of the data source. + "mainSleep": True or False, # Output only. `main_sleep`: the longest sleep session with stages within one day. If no sleep session has stages, then the longest sleep is the `main_sleep`. If there are multiple days of sleep in the response, there is one `main_sleep` per day. "manuallyEdited": True or False, # Output only. Some sleeps autodetected by algorithms can be manually edited by users. "nap": True or False, # Output only. Naps are sleeps without stages and relatively short durations. "processed": True or False, # Output only. Sleep and sleep stages algorithms finished processing. A `true` value indicates whether all data processing for the session is complete. A `false` value means sleep period is detected but sleep stages is still processing. @@ -1403,6 +1484,28 @@

Method Details

"strokeCount": "A String", # Required. Number of strokes in the lap. "swimStrokeType": "A String", # Required. Swim stroke type. }, + "symptoms": { # Symptoms logged by the user. # Optional. Data for points in the `symptoms` sample data type collection. + "sampleTime": { # Represents a sample time of an observed data point. # Required. Time when the symptoms were logged. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "symptoms": [ # Required. List of symptoms experienced. + "A String", + ], + }, "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection. "heartRateZoneType": "A String", # Required. Heart rate zone type. "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. @@ -1712,7 +1815,7 @@

Method Details

}, ], }, - "totalCalories": { # Represents the result of the rollup of the user's total calories. # Returned by default when rolling up data points from the `total-calories` data type, or when requested explicitly using the `total-calories` rollup type identifier. + "totalCalories": { # Represents the result of the rollup of the user's total calories. Note: Queries for the `total-calories` data type must include a time interval filter (such as `total_calories.interval.start_time` or `total_calories.interval.civil_start_time`). The maximum range is 14 days. Example filter query: `total_calories.interval.start_time >= "2026-04-20T00:00:00Z" AND total_calories.interval.start_time < "2026-04-21T00:00:00Z"` # Returned by default when rolling up data points from the `total-calories` data type, or when requested explicitly using the `total-calories` rollup type identifier. "kcalSum": 3.14, # Sum of the total calories in kilocalories. }, "weight": { # Represents the result of the rollup of the weight data type. # Returned by default when rolling up data points from the `weight` data type, or when requested explicitly using the `weight` rollup type identifier. @@ -2236,7 +2339,7 @@

Method Details

"exercise": { # An exercise that stores information about a physical activity. # Optional. Data for points in the `exercise` session data type collection. "activeDuration": "A String", # Optional. Duration excluding pauses. "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise. - "displayName": "A String", # Required. Exercise display name. + "displayName": "A String", # Required. The localized, human-readable name of the exercise. For all exercise types other than `OTHER`, the system ignores client input and overrides this field with a generated name based on `exercise_type` (e.g., "Walking" for `WALKING`). If `exercise_type` is `OTHER`, this field can contain the user's custom, free-form display name. "exerciseEvents": [ # Optional. Exercise events that happen during an exercise, such as pause & restarts. { # Represents instantaneous events that happen during an exercise, such as start, stop, pause, split. "eventTime": "A String", # Required. Exercise event time @@ -2674,6 +2777,66 @@

Method Details

"serviceVersion": "A String", # Output only. The service version used by the feature. }, }, + "menstrualPeriod": { # Menstrual period record. # Optional. Data for points in the `menstrual-period` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "notes": "A String", # Optional. Standard free-form notes captured at manual logging. + }, + "moods": { # Moods record. # Optional. Data for points in the `moods` sample data type collection. + "moods": [ # Required. The moods logged. + "A String", + ], + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which moods were measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "valences": [ # Optional. The valences. + "A String", + ], + }, "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. "nutritionLog": { # Holds information about food logged by a user. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not editable. # Optional. Data for points in the `nutrition-log` session data type collection. "energy": { # Represents the energy quantity. # Optional. The total energy of the food, measured in kilocalories (`kcal`). @@ -2742,6 +2905,26 @@

Method Details

"userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, + "ovulationTest": { # Ovulation test record. # Optional. Data for points in the `ovulation-test` sample data type collection. + "result": "A String", # Required. The result of the ovulation test. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which ovulation test was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured. @@ -2889,8 +3072,9 @@

Method Details

"startTime": "A String", # Required. The start time of the observed session. "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, - "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: processing, main, manually edited, stages status. + "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: `processed`, `main_sleep`, `manually_edited`, and `stages_status`. "externalId": "A String", # Optional. Sleep identifier relevant in the context of the data source. + "mainSleep": True or False, # Output only. `main_sleep`: the longest sleep session with stages within one day. If no sleep session has stages, then the longest sleep is the `main_sleep`. If there are multiple days of sleep in the response, there is one `main_sleep` per day. "manuallyEdited": True or False, # Output only. Some sleeps autodetected by algorithms can be manually edited by users. "nap": True or False, # Output only. Naps are sleeps without stages and relatively short durations. "processed": True or False, # Output only. Sleep and sleep stages algorithms finished processing. A `true` value indicates whether all data processing for the session is complete. A `false` value means sleep period is detected but sleep stages is still processing. @@ -3003,6 +3187,28 @@

Method Details

"strokeCount": "A String", # Required. Number of strokes in the lap. "swimStrokeType": "A String", # Required. Swim stroke type. }, + "symptoms": { # Symptoms logged by the user. # Optional. Data for points in the `symptoms` sample data type collection. + "sampleTime": { # Represents a sample time of an observed data point. # Required. Time when the symptoms were logged. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "symptoms": [ # Required. List of symptoms experienced. + "A String", + ], + }, "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection. "heartRateZoneType": "A String", # Required. Heart rate zone type. "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. @@ -3563,7 +3769,7 @@

Method Details

"exercise": { # An exercise that stores information about a physical activity. # Optional. Data for points in the `exercise` session data type collection. "activeDuration": "A String", # Optional. Duration excluding pauses. "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise. - "displayName": "A String", # Required. Exercise display name. + "displayName": "A String", # Required. The localized, human-readable name of the exercise. For all exercise types other than `OTHER`, the system ignores client input and overrides this field with a generated name based on `exercise_type` (e.g., "Walking" for `WALKING`). If `exercise_type` is `OTHER`, this field can contain the user's custom, free-form display name. "exerciseEvents": [ # Optional. Exercise events that happen during an exercise, such as pause & restarts. { # Represents instantaneous events that happen during an exercise, such as start, stop, pause, split. "eventTime": "A String", # Required. Exercise event time @@ -4001,6 +4207,66 @@

Method Details

"serviceVersion": "A String", # Output only. The service version used by the feature. }, }, + "menstrualPeriod": { # Menstrual period record. # Optional. Data for points in the `menstrual-period` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "notes": "A String", # Optional. Standard free-form notes captured at manual logging. + }, + "moods": { # Moods record. # Optional. Data for points in the `moods` sample data type collection. + "moods": [ # Required. The moods logged. + "A String", + ], + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which moods were measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "valences": [ # Optional. The valences. + "A String", + ], + }, "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. "nutritionLog": { # Holds information about food logged by a user. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not editable. # Optional. Data for points in the `nutrition-log` session data type collection. "energy": { # Represents the energy quantity. # Optional. The total energy of the food, measured in kilocalories (`kcal`). @@ -4069,6 +4335,26 @@

Method Details

"userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, + "ovulationTest": { # Ovulation test record. # Optional. Data for points in the `ovulation-test` sample data type collection. + "result": "A String", # Required. The result of the ovulation test. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which ovulation test was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured. @@ -4216,8 +4502,9 @@

Method Details

"startTime": "A String", # Required. The start time of the observed session. "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, - "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: processing, main, manually edited, stages status. + "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: `processed`, `main_sleep`, `manually_edited`, and `stages_status`. "externalId": "A String", # Optional. Sleep identifier relevant in the context of the data source. + "mainSleep": True or False, # Output only. `main_sleep`: the longest sleep session with stages within one day. If no sleep session has stages, then the longest sleep is the `main_sleep`. If there are multiple days of sleep in the response, there is one `main_sleep` per day. "manuallyEdited": True or False, # Output only. Some sleeps autodetected by algorithms can be manually edited by users. "nap": True or False, # Output only. Naps are sleeps without stages and relatively short durations. "processed": True or False, # Output only. Sleep and sleep stages algorithms finished processing. A `true` value indicates whether all data processing for the session is complete. A `false` value means sleep period is detected but sleep stages is still processing. @@ -4330,6 +4617,28 @@

Method Details

"strokeCount": "A String", # Required. Number of strokes in the lap. "swimStrokeType": "A String", # Required. Swim stroke type. }, + "symptoms": { # Symptoms logged by the user. # Optional. Data for points in the `symptoms` sample data type collection. + "sampleTime": { # Represents a sample time of an observed data point. # Required. Time when the symptoms were logged. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "symptoms": [ # Required. List of symptoms experienced. + "A String", + ], + }, "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection. "heartRateZoneType": "A String", # Required. Heart rate zone type. "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. @@ -4897,7 +5206,7 @@

Method Details

"exercise": { # An exercise that stores information about a physical activity. # Optional. Data for points in the `exercise` session data type collection. "activeDuration": "A String", # Optional. Duration excluding pauses. "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise. - "displayName": "A String", # Required. Exercise display name. + "displayName": "A String", # Required. The localized, human-readable name of the exercise. For all exercise types other than `OTHER`, the system ignores client input and overrides this field with a generated name based on `exercise_type` (e.g., "Walking" for `WALKING`). If `exercise_type` is `OTHER`, this field can contain the user's custom, free-form display name. "exerciseEvents": [ # Optional. Exercise events that happen during an exercise, such as pause & restarts. { # Represents instantaneous events that happen during an exercise, such as start, stop, pause, split. "eventTime": "A String", # Required. Exercise event time @@ -5335,6 +5644,66 @@

Method Details

"serviceVersion": "A String", # Output only. The service version used by the feature. }, }, + "menstrualPeriod": { # Menstrual period record. # Optional. Data for points in the `menstrual-period` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "notes": "A String", # Optional. Standard free-form notes captured at manual logging. + }, + "moods": { # Moods record. # Optional. Data for points in the `moods` sample data type collection. + "moods": [ # Required. The moods logged. + "A String", + ], + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which moods were measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "valences": [ # Optional. The valences. + "A String", + ], + }, "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. "nutritionLog": { # Holds information about food logged by a user. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not editable. # Optional. Data for points in the `nutrition-log` session data type collection. "energy": { # Represents the energy quantity. # Optional. The total energy of the food, measured in kilocalories (`kcal`). @@ -5403,6 +5772,26 @@

Method Details

"userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, + "ovulationTest": { # Ovulation test record. # Optional. Data for points in the `ovulation-test` sample data type collection. + "result": "A String", # Required. The result of the ovulation test. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which ovulation test was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured. @@ -5550,8 +5939,9 @@

Method Details

"startTime": "A String", # Required. The start time of the observed session. "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, - "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: processing, main, manually edited, stages status. + "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: `processed`, `main_sleep`, `manually_edited`, and `stages_status`. "externalId": "A String", # Optional. Sleep identifier relevant in the context of the data source. + "mainSleep": True or False, # Output only. `main_sleep`: the longest sleep session with stages within one day. If no sleep session has stages, then the longest sleep is the `main_sleep`. If there are multiple days of sleep in the response, there is one `main_sleep` per day. "manuallyEdited": True or False, # Output only. Some sleeps autodetected by algorithms can be manually edited by users. "nap": True or False, # Output only. Naps are sleeps without stages and relatively short durations. "processed": True or False, # Output only. Sleep and sleep stages algorithms finished processing. A `true` value indicates whether all data processing for the session is complete. A `false` value means sleep period is detected but sleep stages is still processing. @@ -5664,6 +6054,28 @@

Method Details

"strokeCount": "A String", # Required. Number of strokes in the lap. "swimStrokeType": "A String", # Required. Swim stroke type. }, + "symptoms": { # Symptoms logged by the user. # Optional. Data for points in the `symptoms` sample data type collection. + "sampleTime": { # Represents a sample time of an observed data point. # Required. Time when the symptoms were logged. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "symptoms": [ # Required. List of symptoms experienced. + "A String", + ], + }, "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection. "heartRateZoneType": "A String", # Required. Heart rate zone type. "interval": { # Represents a time interval of an observed data point. # Required. Observed interval. @@ -6191,7 +6603,7 @@

Method Details

"exercise": { # An exercise that stores information about a physical activity. # Data for points in the `exercise` session data type collection. "activeDuration": "A String", # Optional. Duration excluding pauses. "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise. - "displayName": "A String", # Required. Exercise display name. + "displayName": "A String", # Required. The localized, human-readable name of the exercise. For all exercise types other than `OTHER`, the system ignores client input and overrides this field with a generated name based on `exercise_type` (e.g., "Walking" for `WALKING`). If `exercise_type` is `OTHER`, this field can contain the user's custom, free-form display name. "exerciseEvents": [ # Optional. Exercise events that happen during an exercise, such as pause & restarts. { # Represents instantaneous events that happen during an exercise, such as start, stop, pause, split. "eventTime": "A String", # Required. Exercise event time @@ -6686,8 +7098,9 @@

Method Details

"startTime": "A String", # Required. The start time of the observed session. "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, - "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: processing, main, manually edited, stages status. + "metadata": { # Additional information about how the sleep was processed. # Optional. Sleep metadata: `processed`, `main_sleep`, `manually_edited`, and `stages_status`. "externalId": "A String", # Optional. Sleep identifier relevant in the context of the data source. + "mainSleep": True or False, # Output only. `main_sleep`: the longest sleep session with stages within one day. If no sleep session has stages, then the longest sleep is the `main_sleep`. If there are multiple days of sleep in the response, there is one `main_sleep` per day. "manuallyEdited": True or False, # Output only. Some sleeps autodetected by algorithms can be manually edited by users. "nap": True or False, # Output only. Naps are sleeps without stages and relatively short durations. "processed": True or False, # Output only. Sleep and sleep stages algorithms finished processing. A `true` value indicates whether all data processing for the session is complete. A `false` value means sleep period is detected but sleep stages is still processing. @@ -7043,7 +7456,7 @@

Method Details

}, ], }, - "totalCalories": { # Represents the result of the rollup of the user's total calories. # Returned by default when rolling up data points from the `total-calories` data type, or when requested explicitly using the `total-calories` rollup type identifier. + "totalCalories": { # Represents the result of the rollup of the user's total calories. Note: Queries for the `total-calories` data type must include a time interval filter (such as `total_calories.interval.start_time` or `total_calories.interval.civil_start_time`). The maximum range is 14 days. Example filter query: `total_calories.interval.start_time >= "2026-04-20T00:00:00Z" AND total_calories.interval.start_time < "2026-04-21T00:00:00Z"` # Returned by default when rolling up data points from the `total-calories` data type, or when requested explicitly using the `total-calories` rollup type identifier. "kcalSum": 3.14, # Sum of the total calories in kilocalories. }, "weight": { # Represents the result of the rollup of the weight data type. # Returned by default when rolling up data points from the `weight` data type, or when requested explicitly using the `weight` rollup type identifier. diff --git a/googleapiclient/discovery_cache/documents/health.v4.json b/googleapiclient/discovery_cache/documents/health.v4.json index 3f725202d7..66b8360e9a 100644 --- a/googleapiclient/discovery_cache/documents/health.v4.json +++ b/googleapiclient/discovery_cache/documents/health.v4.json @@ -29,6 +29,12 @@ "https://www.googleapis.com/auth/googlehealth.location.writeonly": { "description": "Add exercise GPS location data to Google Health, and edit or delete the data it adds." }, +"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.writeonly": { +"description": "Add mindfulness data to Google Health, and edit or delete the data it adds" +}, "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly": { "description": "Add nutrition data to Google Health, and edit or delete the data it adds." }, @@ -38,6 +44,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.writeonly": { +"description": "Add reproductive health data to Google Health, and edit or delete the data it adds" +}, "https://www.googleapis.com/auth/googlehealth.settings.readonly": { "description": "See your Google Health settings" }, @@ -704,7 +713,10 @@ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.writeonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" ] }, @@ -736,7 +748,10 @@ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.writeonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" ] }, @@ -904,7 +919,10 @@ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.writeonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" ] }, @@ -1060,7 +1078,7 @@ } } }, -"revision": "20260709", +"revision": "20260731", "rootUrl": "https://health.googleapis.com/", "schemas": { "ActiveEnergyBurned": { @@ -2249,6 +2267,14 @@ "$ref": "IrregularRhythmNotification", "description": "Optional. Data for points in the `irregular-rhythm-notification` session data type collection." }, +"menstrualPeriod": { +"$ref": "MenstrualPeriod", +"description": "Optional. Data for points in the `menstrual-period` interval data type collection." +}, +"moods": { +"$ref": "Moods", +"description": "Optional. Data for points in the `moods` sample data type collection." +}, "name": { "description": "Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens.", "type": "string" @@ -2257,6 +2283,10 @@ "$ref": "NutritionLog", "description": "Optional. Data for points in the `nutrition-log` session data type collection." }, +"ovulationTest": { +"$ref": "OvulationTest", +"description": "Optional. Data for points in the `ovulation-test` sample data type collection." +}, "oxygenSaturation": { "$ref": "OxygenSaturation", "description": "Optional. Data for points in the `oxygen-saturation` sample data type collection." @@ -2285,6 +2315,10 @@ "$ref": "SwimLengthsData", "description": "Optional. Data for points in the `swim-lengths-data` interval data type collection." }, +"symptoms": { +"$ref": "Symptoms", +"description": "Optional. Data for points in the `symptoms` sample data type collection." +}, "timeInHeartRateZone": { "$ref": "TimeInHeartRateZone", "description": "Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection." @@ -2677,7 +2711,7 @@ "type": "string" }, "displayName": { -"description": "Required. Exercise display name.", +"description": "Required. The localized, human-readable name of the exercise. For all exercise types other than `OTHER`, the system ignores client input and overrides this field with a generated name based on `exercise_type` (e.g., \"Walking\" for `WALKING`). If `exercise_type` is `OTHER`, this field can contain the user's custom, free-form display name.", "type": "string" }, "exerciseEvents": { @@ -3890,6 +3924,21 @@ }, "type": "object" }, +"MenstrualPeriod": { +"description": "Menstrual period record.", +"id": "MenstrualPeriod", +"properties": { +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +}, +"notes": { +"description": "Optional. Standard free-form notes captured at manual logging.", +"type": "string" +} +}, +"type": "object" +}, "MetricsSummary": { "description": "Summary metrics for an exercise.", "id": "MetricsSummary", @@ -3987,6 +4036,161 @@ }, "type": "object" }, +"Moods": { +"description": "Moods record.", +"id": "Moods", +"properties": { +"moods": { +"description": "Required. The moods logged.", +"items": { +"enum": [ +"MOOD_UNSPECIFIED", +"AMAZED", +"AMUSED", +"ANGRY", +"ANNOYED", +"ANXIOUS", +"HAPPY", +"CONTENT", +"SAD", +"WORRIED", +"FRUSTRATED", +"EXCITED", +"CALM", +"STRESSED", +"ASHAMED", +"BRAVE", +"CONFIDENT", +"DISAPPOINTED", +"DISCOURAGED", +"DISGUSTED", +"DRAINED", +"EMBARRASSED", +"GRATEFUL", +"GUILTY", +"HOPEFUL", +"HOPELESS", +"INDIFFERENT", +"IRRITATED", +"JEALOUS", +"JOYFUL", +"LONELY", +"OVERWHELMED", +"PASSIONATE", +"PEACEFUL", +"PROUD", +"RELIEVED", +"SATISFIED", +"SCARED", +"SURPRISED", +"ENERGIZED", +"FATIGUED", +"VERY_CALM", +"VERY_STRESSED", +"NEUTRAL", +"AFRAID", +"HURTING", +"BORED", +"BITTER", +"ENVIOUS", +"CONFUSED", +"CURIOUS", +"AWESTRUCK", +"INSPIRED", +"LONGING", +"ACCOMPLISHED", +"LOVING", +"COMPASSIONATE" +], +"enumDescriptions": [ +"Unspecified mood.", +"Amazed.", +"Amused.", +"Angry.", +"Annoyed.", +"Anxious.", +"Happy.", +"Content.", +"Sad.", +"Worried.", +"Frustrated.", +"Excited.", +"Calm.", +"Stressed.", +"Ashamed.", +"Brave.", +"Confident.", +"Disappointed.", +"Discouraged.", +"Disgusted.", +"Drained.", +"Embarrassed.", +"Grateful.", +"Guilty.", +"Hopeful.", +"Hopeless.", +"Indifferent.", +"Irritated.", +"Jealous.", +"Joyful.", +"Lonely.", +"Overwhelmed.", +"Passionate.", +"Peaceful.", +"Proud.", +"Relieved.", +"Satisfied.", +"Scared.", +"Surprised.", +"Energized.", +"Fatigued.", +"Very calm.", +"Very stressed.", +"Neutral.", +"Afraid.", +"Hurting.", +"Bored.", +"Bitter.", +"Envious.", +"Confused.", +"Curious.", +"Awestruck.", +"Inspired.", +"Longing.", +"Accomplished.", +"Loving.", +"Compassionate." +], +"type": "string" +}, +"type": "array" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which moods were measured." +}, +"valences": { +"description": "Optional. The valences.", +"items": { +"enum": [ +"VALENCE_UNSPECIFIED", +"UNPLEASANT", +"BASELINE", +"PLEASANT" +], +"enumDescriptions": [ +"Unspecified valence.", +"Unpleasant.", +"Baseline.", +"Pleasant." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "NutrientQuantity": { "description": "Represents the quantity of a nutrient.", "id": "NutrientQuantity", @@ -4410,6 +4614,37 @@ }, "type": "object" }, +"OvulationTest": { +"description": "Ovulation test record.", +"id": "OvulationTest", +"properties": { +"result": { +"description": "Required. The result of the ovulation test.", +"enum": [ +"OVULATION_TEST_RESULT_UNSPECIFIED", +"NEGATIVE", +"LUTEINIZING_HORMONE_SURGE", +"ESTROGEN_SURGE", +"POSITIVE", +"INDETERMINATE" +], +"enumDescriptions": [ +"Unspecified result.", +"Negative result.", +"Luteinizing hormone surge.", +"Estrogen surge.", +"Positive result.", +"Indeterminate result." +], +"type": "string" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which ovulation test was measured." +} +}, +"type": "object" +}, "OxygenSaturation": { "description": "Captures the user's instantaneous oxygen saturation percentage (SpO2).", "id": "OxygenSaturation", @@ -5211,7 +5446,7 @@ }, "metadata": { "$ref": "SleepMetadata", -"description": "Optional. Sleep metadata: processing, main, manually edited, stages status." +"description": "Optional. Sleep metadata: `processed`, `main_sleep`, `manually_edited`, and `stages_status`." }, "outOfBedSegments": { "description": "Optional. \u201cOut of bed\u201d segments that can overlap with sleep stages.", @@ -5263,6 +5498,11 @@ "description": "Optional. Sleep identifier relevant in the context of the data source.", "type": "string" }, +"mainSleep": { +"description": "Output only. `main_sleep`: the longest sleep session with stages within one day. If no sleep session has stages, then the longest sleep is the `main_sleep`. If there are multiple days of sleep in the response, there is one `main_sleep` per day.", +"readOnly": true, +"type": "boolean" +}, "manuallyEdited": { "description": "Output only. Some sleeps autodetected by algorithms can be manually edited by users.", "readOnly": true, @@ -5719,6 +5959,88 @@ }, "type": "object" }, +"Symptoms": { +"description": "Symptoms logged by the user.", +"id": "Symptoms", +"properties": { +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. Time when the symptoms were logged." +}, +"symptoms": { +"description": "Required. List of symptoms experienced.", +"items": { +"enum": [ +"SYMPTOM_VALUE_UNSPECIFIED", +"CRAMPS", +"HEADACHE", +"TENDER_BREASTS", +"ACNE", +"SICK", +"BLOATED", +"HOT_FLASHES", +"PMS", +"COUGH", +"FEVER", +"DIFFICULTY_BREATHING", +"BACK_PAIN", +"SHAKINESS", +"HUNGER", +"SWEATING", +"ANXIETY", +"THIRST", +"FREQUENT_URINATION", +"BLURRED_VISION", +"OTHER", +"SEX_DRIVE_HIGH", +"SEX_DRIVE_MEDIUM", +"SEX_DRIVE_LOW", +"HEART_PALPITATIONS", +"FAINTING", +"CHEST_PAIN", +"FATIGUE", +"CONFUSION", +"DIZZINESS" +], +"enumDescriptions": [ +"Unspecified symptom value.", +"Abdominal cramps.", +"Headache.", +"Tender breasts.", +"Acne.", +"Feeling sick or unwell.", +"Bloating or abdominal swelling.", +"Hot flashes.", +"Premenstrual syndrome symptoms.", +"Coughing.", +"Fever or elevated body temperature.", +"Difficulty breathing or shortness of breath.", +"Back pain.", +"Shakiness or tremors.", +"Excessive hunger.", +"Excessive sweating.", +"Anxiety or nervousness.", +"Excessive thirst.", +"Frequent urination.", +"Blurred vision.", +"Other symptoms.", +"High sex drive.", +"Medium sex drive.", +"Low sex drive.", +"Heart palpitations or racing heart.", +"Fainting or loss of consciousness.", +"Chest pain or discomfort.", +"Fatigue or extreme tiredness.", +"Confusion or mental fogginess.", +"Dizziness or lightheadedness." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "TimeInHeartRateZone": { "description": "Time in heart rate zone record. It's an interval spent in specific heart rate zone.", "id": "TimeInHeartRateZone", @@ -5862,7 +6184,7 @@ "type": "object" }, "TotalCaloriesRollupValue": { -"description": "Represents the result of the rollup of the user's total calories.", +"description": "Represents the result of the rollup of the user's total calories. Note: Queries for the `total-calories` data type must include a time interval filter (such as `total_calories.interval.start_time` or `total_calories.interval.civil_start_time`). The maximum range is 14 days. Example filter query: `total_calories.interval.start_time >= \"2026-04-20T00:00:00Z\" AND total_calories.interval.start_time < \"2026-04-21T00:00:00Z\"`", "id": "TotalCaloriesRollupValue", "properties": { "kcalSum": { From bee34b1ff0f12cddf0f09fb078e73d04a67397e8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:06 +0000 Subject: [PATCH 58/84] feat(homegraph): update the api #### homegraph:v1 The following keys were added: - schemas.ReportStateAndNotificationResponse.properties.deviceResults (Total Keys: 2) - schemas.Result (Total Keys: 4) - schemas.TraitData.properties.providerVersionTime (Total Keys: 2) --- docs/dyn/homegraph_v1.devices.html | 7 +++++ .../documents/homegraph.v1.json | 26 ++++++++++++++++++- 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/docs/dyn/homegraph_v1.devices.html b/docs/dyn/homegraph_v1.devices.html index 2cd55914d8..f71fa721ac 100644 --- a/docs/dyn/homegraph_v1.devices.html +++ b/docs/dyn/homegraph_v1.devices.html @@ -156,6 +156,7 @@

Method Details

"traitData": [ # Required. List of trait data associated with the component. { # Contains the trait payload for a single trait. "commitTime": "A String", # Other metadata for the trait. The time the client update was committed in the server. + "providerVersionTime": "A String", # Optional in write requests (e.g. ReportStateAndNotification). If set, represents the provider version timestamp of the existing trait in the database. The server will perform optimistic locking validation if this field is present and the experiment is enabled. It will not be persisted to the database. "trait": { # The Provider Home API trait payload. "a_key": "", # Properties of the object. Contains field @type with type URL. }, @@ -210,6 +211,7 @@

Method Details

"traitData": [ # Required. The updated trait data for the component. { # Contains the trait payload for a single trait. "commitTime": "A String", # Other metadata for the trait. The time the client update was committed in the server. + "providerVersionTime": "A String", # Optional in write requests (e.g. ReportStateAndNotification). If set, represents the provider version timestamp of the existing trait in the database. The server will perform optimistic locking validation if this field is present and the experiment is enabled. It will not be persisted to the database. "trait": { # The Provider Home API trait payload. "a_key": "", # Properties of the object. Contains field @type with type URL. }, @@ -240,6 +242,11 @@

Method Details

An object of the form: { # Response type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call. + "deviceResults": { # Map from agent device ID to the result of reporting state and notifications. This is only populated for UDDM updates for now. + "a_key": { # Result of reporting state and notifications for a single device. + "homeTraitCommitTime": "A String", # The trait commit timestamp of the state update in Home Graph. + }, + }, "requestId": "A String", # Request ID copied from ReportStateAndNotificationRequest. }
diff --git a/googleapiclient/discovery_cache/documents/homegraph.v1.json b/googleapiclient/discovery_cache/documents/homegraph.v1.json index 60c3972852..9c7ac1efbe 100644 --- a/googleapiclient/discovery_cache/documents/homegraph.v1.json +++ b/googleapiclient/discovery_cache/documents/homegraph.v1.json @@ -216,7 +216,7 @@ } } }, -"revision": "20260619", +"revision": "20260724", "rootUrl": "https://homegraph.googleapis.com/", "schemas": { "AgentDeviceId": { @@ -705,6 +705,13 @@ "description": "Response type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call.", "id": "ReportStateAndNotificationResponse", "properties": { +"deviceResults": { +"additionalProperties": { +"$ref": "Result" +}, +"description": "Map from agent device ID to the result of reporting state and notifications. This is only populated for UDDM updates for now.", +"type": "object" +}, "requestId": { "description": "Request ID copied from ReportStateAndNotificationRequest.", "type": "string" @@ -733,6 +740,18 @@ "properties": {}, "type": "object" }, +"Result": { +"description": "Result of reporting state and notifications for a single device.", +"id": "Result", +"properties": { +"homeTraitCommitTime": { +"description": "The trait commit timestamp of the state update in Home Graph.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "StateAndNotificationPayload": { "description": "Payload containing the state and notification information for devices.", "id": "StateAndNotificationPayload", @@ -801,6 +820,11 @@ "format": "google-datetime", "type": "string" }, +"providerVersionTime": { +"description": "Optional in write requests (e.g. ReportStateAndNotification). If set, represents the provider version timestamp of the existing trait in the database. The server will perform optimistic locking validation if this field is present and the experiment is enabled. It will not be persisted to the database.", +"format": "google-datetime", +"type": "string" +}, "trait": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", From 9f6ab4de35389bb36ecfc3e915d7dd4bce407e53 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:06 +0000 Subject: [PATCH 59/84] feat(iam): update the api #### iam:v1 The following keys were deleted: - schemas.DisableServiceAccountKeyRequest.properties.extendedStatusMessage.type (Total Keys: 1) - schemas.DisableServiceAccountKeyRequest.properties.serviceAccountKeyDisableReason.type (Total Keys: 1) --- .../iam_v1.projects.serviceAccounts.keys.html | 2 -- .../discovery_cache/documents/iam.v1.json | 25 ++----------------- 2 files changed, 2 insertions(+), 25 deletions(-) diff --git a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html index 612721a2b1..b34ceabe6a 100644 --- a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html +++ b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html @@ -175,8 +175,6 @@

Method Details

The object takes the form of: { # The service account key disable request. - "extendedStatusMessage": "A String", # Optional. Usable by internal google services only. An extended_status_message can be used to include additional information about the key, such as its private key data being exposed on a public repository like GitHub. - "serviceAccountKeyDisableReason": "A String", # Optional. Describes the reason this key is being disabled. If unspecified, the default value of SERVICE_ACCOUNT_KEY_DISABLE_REASON_USER_INITIATED will be used. } x__xgafv: string, V1 error format. diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index 2954a15900..541c6867b5 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -4257,7 +4257,7 @@ } } }, -"revision": "20260702", +"revision": "20260724", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -4515,28 +4515,7 @@ "DisableServiceAccountKeyRequest": { "description": "The service account key disable request.", "id": "DisableServiceAccountKeyRequest", -"properties": { -"extendedStatusMessage": { -"description": "Optional. Usable by internal google services only. An extended_status_message can be used to include additional information about the key, such as its private key data being exposed on a public repository like GitHub.", -"type": "string" -}, -"serviceAccountKeyDisableReason": { -"description": "Optional. Describes the reason this key is being disabled. If unspecified, the default value of SERVICE_ACCOUNT_KEY_DISABLE_REASON_USER_INITIATED will be used.", -"enum": [ -"SERVICE_ACCOUNT_KEY_DISABLE_REASON_UNSPECIFIED", -"SERVICE_ACCOUNT_KEY_DISABLE_REASON_USER_INITIATED", -"SERVICE_ACCOUNT_KEY_DISABLE_REASON_EXPOSED", -"SERVICE_ACCOUNT_KEY_DISABLE_REASON_COMPROMISE_DETECTED" -], -"enumDescriptions": [ -"Unspecified disable reason", -"Disabled by the user", -"Google detected this Service Account external key's private key data as exposed, typically in a public repository on GitHub or similar.", -"This service account external key was detected as compromised and used by an attacker." -], -"type": "string" -} -}, +"properties": {}, "type": "object" }, "DisableServiceAccountRequest": { From 7f315f9734e1987e772f9f05ab6411a5a3d9c5fb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:06 +0000 Subject: [PATCH 60/84] feat(merchantapi): update the api #### merchantapi:accounts_v1 The following keys were added: - schemas.AccountService.properties.ucpCheckoutManagement.$ref (Total Keys: 1) - schemas.UcpCheckoutManagement (Total Keys: 2) #### merchantapi:accounts_v1beta The following keys were added: - schemas.AccountService.properties.ucpCheckoutManagement.$ref (Total Keys: 1) - schemas.UcpCheckoutManagement (Total Keys: 2) #### merchantapi:datasources_v1 The following keys were added: - schemas.DataSourceReference.properties.primaryDataSourceName.deprecated (Total Keys: 1) #### merchantapi:datasources_v1beta The following keys were added: - schemas.DataSourceReference.properties.primaryDataSourceName.deprecated (Total Keys: 1) #### merchantapi:inventories_v1 The following keys were added: - schemas.CustomAttribute (Total Keys: 6) - schemas.LocalInventoryAttributes.properties.customAttributes (Total Keys: 2) #### merchantapi:products_v1 The following keys were added: - schemas.LeaseTerm (Total Keys: 6) - schemas.ProductAttributes.properties.leaseTerm.$ref (Total Keys: 1) - schemas.ProductAttributes.properties.returns (Total Keys: 2) - schemas.Returns (Total Keys: 18) --- ...hantapi_accounts_v1.accounts.services.html | 10 + ...api_accounts_v1beta.accounts.services.html | 10 + ...i_datasources_v1.accounts.dataSources.html | 24 +-- ...tasources_v1beta.accounts.dataSources.html | 24 +-- ...v1.accounts.products.localInventories.html | 27 +++ ...pi_issueresolution_v1.issueresolution.html | 4 +- ...ssueresolution_v1beta.issueresolution.html | 4 +- ...v1.accounts.notificationsubscriptions.html | 18 +- ...ta.accounts.notificationsubscriptions.html | 18 +- ...pi_products_v1.accounts.productInputs.html | 136 +++++++++++++ ...hantapi_products_v1.accounts.products.html | 68 +++++++ .../merchantapi_quota_v1.accounts.quotas.html | 2 +- ...chantapi_quota_v1beta.accounts.quotas.html | 2 +- ...rchantapi_reports_v1.accounts.reports.html | 8 +- ...ntapi_reports_v1beta.accounts.reports.html | 8 +- .../documents/merchantapi.accounts_v1.json | 12 +- .../merchantapi.accounts_v1beta.json | 12 +- .../documents/merchantapi.datasources_v1.json | 5 +- .../merchantapi.datasources_v1beta.json | 5 +- .../documents/merchantapi.inventories_v1.json | 31 ++- .../merchantapi.issueresolution_v1.json | 4 +- .../merchantapi.issueresolution_v1beta.json | 4 +- .../merchantapi.notifications_v1.json | 14 +- .../merchantapi.notifications_v1beta.json | 14 +- .../documents/merchantapi.products_v1.json | 178 +++++++++++++++++- .../documents/merchantapi.quota_v1.json | 4 +- .../documents/merchantapi.quota_v1beta.json | 4 +- .../documents/merchantapi.reports_v1.json | 10 +- .../documents/merchantapi.reports_v1beta.json | 10 +- 29 files changed, 576 insertions(+), 94 deletions(-) diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.services.html b/docs/dyn/merchantapi_accounts_v1.accounts.services.html index 9acb4e2df2..ae0a2b515d 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.services.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.services.html @@ -138,6 +138,8 @@

Method Details

}, "provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). "providerDisplayName": "A String", # Output only. The human-readable display name of the provider account. + "ucpCheckoutManagement": { # `UcpCheckoutManagement` payload. # Service type for UCP Checkout Management. The provider is managing the UCP Checkout capability integration for the merchant. + }, }
@@ -182,6 +184,8 @@

Method Details

}, "provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). "providerDisplayName": "A String", # Output only. The human-readable display name of the provider account. + "ucpCheckoutManagement": { # `UcpCheckoutManagement` payload. # Service type for UCP Checkout Management. The provider is managing the UCP Checkout capability integration for the merchant. + }, }
@@ -225,6 +229,8 @@

Method Details

}, "provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). "providerDisplayName": "A String", # Output only. The human-readable display name of the provider account. + "ucpCheckoutManagement": { # `UcpCheckoutManagement` payload. # Service type for UCP Checkout Management. The provider is managing the UCP Checkout capability integration for the merchant. + }, }, ], "nextPageToken": "A String", # A page token. You can send the `page_token` to get the next page. Only included in the `list` response if there are more pages. @@ -277,6 +283,8 @@

Method Details

}, "provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). "providerDisplayName": "A String", # Output only. The human-readable display name of the provider account. + "ucpCheckoutManagement": { # `UcpCheckoutManagement` payload. # Service type for UCP Checkout Management. The provider is managing the UCP Checkout capability integration for the merchant. + }, }, "provider": "A String", # Required. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). } @@ -311,6 +319,8 @@

Method Details

}, "provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). "providerDisplayName": "A String", # Output only. The human-readable display name of the provider account. + "ucpCheckoutManagement": { # `UcpCheckoutManagement` payload. # Service type for UCP Checkout Management. The provider is managing the UCP Checkout capability integration for the merchant. + }, }
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.services.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.services.html index 88c7376132..85d90b69ed 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.services.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.services.html @@ -138,6 +138,8 @@

Method Details

}, "provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). "providerDisplayName": "A String", # Output only. The human-readable display name of the provider account. + "ucpCheckoutManagement": { # `UcpCheckoutManagement` payload. # Service type for UCP Checkout Management. The provider is managing the UCP Checkout capability integration for the merchant. + }, }
@@ -182,6 +184,8 @@

Method Details

}, "provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). "providerDisplayName": "A String", # Output only. The human-readable display name of the provider account. + "ucpCheckoutManagement": { # `UcpCheckoutManagement` payload. # Service type for UCP Checkout Management. The provider is managing the UCP Checkout capability integration for the merchant. + }, }
@@ -225,6 +229,8 @@

Method Details

}, "provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). "providerDisplayName": "A String", # Output only. The human-readable display name of the provider account. + "ucpCheckoutManagement": { # `UcpCheckoutManagement` payload. # Service type for UCP Checkout Management. The provider is managing the UCP Checkout capability integration for the merchant. + }, }, ], "nextPageToken": "A String", # A page token. You can send the `page_token` to get the next page. Only included in the `list` response if there are more pages. @@ -277,6 +283,8 @@

Method Details

}, "provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). "providerDisplayName": "A String", # Output only. The human-readable display name of the provider account. + "ucpCheckoutManagement": { # `UcpCheckoutManagement` payload. # Service type for UCP Checkout Management. The provider is managing the UCP Checkout capability integration for the merchant. + }, }, "provider": "A String", # Required. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). } @@ -311,6 +319,8 @@

Method Details

}, "provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). "providerDisplayName": "A String", # Output only. The human-readable display name of the provider account. + "ucpCheckoutManagement": { # `UcpCheckoutManagement` payload. # Service type for UCP Checkout Management. The provider is managing the UCP Checkout capability integration for the merchant. + }, }
diff --git a/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.html b/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.html index 89cb8059a8..3f465241d5 100644 --- a/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.html +++ b/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.html @@ -157,7 +157,7 @@

Method Details

"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. "takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -187,7 +187,7 @@

Method Details

"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -242,7 +242,7 @@

Method Details

"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. "takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -272,7 +272,7 @@

Method Details

"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -376,7 +376,7 @@

Method Details

"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. "takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -406,7 +406,7 @@

Method Details

"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -472,7 +472,7 @@

Method Details

"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. "takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -502,7 +502,7 @@

Method Details

"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -576,7 +576,7 @@

Method Details

"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. "takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -606,7 +606,7 @@

Method Details

"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -662,7 +662,7 @@

Method Details

"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. "takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -692,7 +692,7 @@

Method Details

"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, diff --git a/docs/dyn/merchantapi_datasources_v1beta.accounts.dataSources.html b/docs/dyn/merchantapi_datasources_v1beta.accounts.dataSources.html index bd47ce4ce2..b8086c3637 100644 --- a/docs/dyn/merchantapi_datasources_v1beta.accounts.dataSources.html +++ b/docs/dyn/merchantapi_datasources_v1beta.accounts.dataSources.html @@ -158,7 +158,7 @@

Method Details

"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. "takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -187,7 +187,7 @@

Method Details

"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -243,7 +243,7 @@

Method Details

"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. "takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -272,7 +272,7 @@

Method Details

"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -377,7 +377,7 @@

Method Details

"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. "takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -406,7 +406,7 @@

Method Details

"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -473,7 +473,7 @@

Method Details

"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. "takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -502,7 +502,7 @@

Method Details

"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -577,7 +577,7 @@

Method Details

"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. "takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -606,7 +606,7 @@

Method Details

"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -663,7 +663,7 @@

Method Details

"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. "takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`. Warning: The update (patch) and create call replaces the entire default rule setup. It doesn't work as an addition or append. If `self` is missing from the list of `take_from_data_sources`, the API will ignore attributes from the primary data source itself. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, @@ -692,7 +692,7 @@

Method Details

"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. - "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` + "primaryDataSourceName": "A String", # Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` "self": True or False, # Self should be used to reference the primary data source itself. "supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}` }, diff --git a/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html b/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html index bbd729bdef..717056f599 100644 --- a/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html +++ b/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html @@ -127,6 +127,15 @@

Method Details

"base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get). "localInventoryAttributes": { # Local inventory attributes. # Optional. A list of local inventory attributes. "availability": "A String", # [Availability](https://support.google.com/merchants/answer/3061342) of the product at this store. + "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. + { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. + "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. + # Object with schema name: CustomAttribute + ], + "name": "A String", # The name of the attribute. + "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. + }, + ], "instoreProductLocation": "A String", # Optional. Location of the product inside the store. Maximum length is 20 bytes. "localShippingLabel": "A String", # Optional. Specifies a label associated with the shipping for the `LocalInventory` resource. Can be used to group local shipping services to this particular inventory item. For accepted field format, see the [Local delivery](https://support.google.com/merchants/answer/14819809#localdelivery) "loyaltyPrograms": [ # Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store. This field is used to show store-specific member prices on Local Inventory Ads (LIA). To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. For local inventory specific details, see the [Local inventory data specification](https://support.google.com/merchants/answer/3061342). @@ -182,6 +191,15 @@

Method Details

"base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get). "localInventoryAttributes": { # Local inventory attributes. # Optional. A list of local inventory attributes. "availability": "A String", # [Availability](https://support.google.com/merchants/answer/3061342) of the product at this store. + "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. + { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. + "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. + # Object with schema name: CustomAttribute + ], + "name": "A String", # The name of the attribute. + "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. + }, + ], "instoreProductLocation": "A String", # Optional. Location of the product inside the store. Maximum length is 20 bytes. "localShippingLabel": "A String", # Optional. Specifies a label associated with the shipping for the `LocalInventory` resource. Can be used to group local shipping services to this particular inventory item. For accepted field format, see the [Local delivery](https://support.google.com/merchants/answer/14819809#localdelivery) "loyaltyPrograms": [ # Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store. This field is used to show store-specific member prices on Local Inventory Ads (LIA). To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. For local inventory specific details, see the [Local inventory data specification](https://support.google.com/merchants/answer/3061342). @@ -248,6 +266,15 @@

Method Details

"base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get). "localInventoryAttributes": { # Local inventory attributes. # Optional. A list of local inventory attributes. "availability": "A String", # [Availability](https://support.google.com/merchants/answer/3061342) of the product at this store. + "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. + { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. + "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. + # Object with schema name: CustomAttribute + ], + "name": "A String", # The name of the attribute. + "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. + }, + ], "instoreProductLocation": "A String", # Optional. Location of the product inside the store. Maximum length is 20 bytes. "localShippingLabel": "A String", # Optional. Specifies a label associated with the shipping for the `LocalInventory` resource. Can be used to group local shipping services to this particular inventory item. For accepted field format, see the [Local delivery](https://support.google.com/merchants/answer/14819809#localdelivery) "loyaltyPrograms": [ # Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store. This field is used to show store-specific member prices on Local Inventory Ads (LIA). To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. For local inventory specific details, see the [Local inventory data specification](https://support.google.com/merchants/answer/3061342). diff --git a/docs/dyn/merchantapi_issueresolution_v1.issueresolution.html b/docs/dyn/merchantapi_issueresolution_v1.issueresolution.html index e9fafdd459..34db7f7baa 100644 --- a/docs/dyn/merchantapi_issueresolution_v1.issueresolution.html +++ b/docs/dyn/merchantapi_issueresolution_v1.issueresolution.html @@ -223,7 +223,7 @@

Method Details

"message": "A String", # Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the business. For example: "Disapproves 90k offers in 25 countries" "severity": "A String", # The severity of the issue. }, - "prerenderedContent": "A String", # Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. + "prerenderedContent": "A String", # Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `asset-value` - marks the paragraph that contains the asset information. * `asset-label` - marks the section of the text that contains the label of the asset. * `asset-link` - marks the section of the text that contains a link to the asset. * `asset-provided-value` - marks the section of the text that contains the value of the asset. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. "prerenderedOutOfCourtDisputeSettlement": "A String", # Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that the business may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for the user to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. "title": "A String", # Title of the issue. }, @@ -362,7 +362,7 @@

Method Details

"message": "A String", # Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the business. For example: "Disapproves 90k offers in 25 countries" "severity": "A String", # The severity of the issue. }, - "prerenderedContent": "A String", # Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. + "prerenderedContent": "A String", # Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `asset-value` - marks the paragraph that contains the asset information. * `asset-label` - marks the section of the text that contains the label of the asset. * `asset-link` - marks the section of the text that contains a link to the asset. * `asset-provided-value` - marks the section of the text that contains the value of the asset. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. "prerenderedOutOfCourtDisputeSettlement": "A String", # Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that the business may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for the user to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. "title": "A String", # Title of the issue. }, diff --git a/docs/dyn/merchantapi_issueresolution_v1beta.issueresolution.html b/docs/dyn/merchantapi_issueresolution_v1beta.issueresolution.html index d22951ecdd..b95a531dcc 100644 --- a/docs/dyn/merchantapi_issueresolution_v1beta.issueresolution.html +++ b/docs/dyn/merchantapi_issueresolution_v1beta.issueresolution.html @@ -223,7 +223,7 @@

Method Details

"message": "A String", # Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the business. For example: "Disapproves 90k offers in 25 countries" "severity": "A String", # The severity of the issue. }, - "prerenderedContent": "A String", # Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. + "prerenderedContent": "A String", # Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `asset-value` - marks the paragraph that contains the asset information. * `asset-label` - marks the section of the text that contains the label of the asset. * `asset-link` - marks the section of the text that contains a link to the asset. * `asset-provided-value` - marks the section of the text that contains the value of the asset. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. "prerenderedOutOfCourtDisputeSettlement": "A String", # Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that the business may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for the user to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. "title": "A String", # Title of the issue. }, @@ -362,7 +362,7 @@

Method Details

"message": "A String", # Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the business. For example: "Disapproves 90k offers in 25 countries" "severity": "A String", # The severity of the issue. }, - "prerenderedContent": "A String", # Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. + "prerenderedContent": "A String", # Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `asset-value` - marks the paragraph that contains the asset information. * `asset-label` - marks the section of the text that contains the label of the asset. * `asset-link` - marks the section of the text that contains a link to the asset. * `asset-provided-value` - marks the section of the text that contains the value of the asset. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. "prerenderedOutOfCourtDisputeSettlement": "A String", # Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that the business may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for the user to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. "title": "A String", # Title of the issue. }, diff --git a/docs/dyn/merchantapi_notifications_v1.accounts.notificationsubscriptions.html b/docs/dyn/merchantapi_notifications_v1.accounts.notificationsubscriptions.html index c6d66e8a35..a09f4e4f4a 100644 --- a/docs/dyn/merchantapi_notifications_v1.accounts.notificationsubscriptions.html +++ b/docs/dyn/merchantapi_notifications_v1.accounts.notificationsubscriptions.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a notification subscription for a business. For standalone or subaccounts accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.

+

Creates a notification subscription for a business. For standalone or sub-accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.

delete(name, x__xgafv=None)

Deletes a notification subscription for a merchant.

@@ -103,7 +103,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a notification subscription for a business. For standalone or subaccounts accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.
+  
Creates a notification subscription for a business. For standalone or sub-accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.
 
 Args:
   parent: string, Required. The merchant account that owns the new notification subscription. Format: `accounts/{account}` (required)
@@ -113,7 +113,7 @@ 

Method Details

{ # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. - "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` + "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` "registeredEvent": "A String", # The event that the merchant wants to be notified about. "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}` } @@ -129,7 +129,7 @@

Method Details

{ # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. - "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` + "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` "registeredEvent": "A String", # The event that the merchant wants to be notified about. "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}` }
@@ -170,7 +170,7 @@

Method Details

{ # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. - "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` + "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` "registeredEvent": "A String", # The event that the merchant wants to be notified about. "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}` }
@@ -198,7 +198,7 @@

Method Details

{ # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. - "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` + "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` "registeredEvent": "A String", # The event that the merchant wants to be notified about. "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}` }, @@ -225,14 +225,14 @@

Method Details

Updates an existing notification subscription for a merchant.
 
 Args:
-  name: string, Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` (required)
+  name: string, Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents.
   "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis.
   "callBackUri": "A String", # URL to be used to push the notification to the merchant.
-  "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}`
+  "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}`
   "registeredEvent": "A String", # The event that the merchant wants to be notified about.
   "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}`
 }
@@ -249,7 +249,7 @@ 

Method Details

{ # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. - "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` + "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` "registeredEvent": "A String", # The event that the merchant wants to be notified about. "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}` }
diff --git a/docs/dyn/merchantapi_notifications_v1beta.accounts.notificationsubscriptions.html b/docs/dyn/merchantapi_notifications_v1beta.accounts.notificationsubscriptions.html index 96714d74ea..a985c3c79d 100644 --- a/docs/dyn/merchantapi_notifications_v1beta.accounts.notificationsubscriptions.html +++ b/docs/dyn/merchantapi_notifications_v1beta.accounts.notificationsubscriptions.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a notification subscription for a business. For standalone or subaccounts accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.

+

Creates a notification subscription for a business. For standalone or sub-accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.

delete(name, x__xgafv=None)

Deletes a notification subscription for a merchant.

@@ -103,7 +103,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a notification subscription for a business. For standalone or subaccounts accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.
+  
Creates a notification subscription for a business. For standalone or sub-accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.
 
 Args:
   parent: string, Required. The merchant account that owns the new notification subscription. Format: `accounts/{account}` (required)
@@ -113,7 +113,7 @@ 

Method Details

{ # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. - "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` + "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` "registeredEvent": "A String", # The event that the merchant wants to be notified about. "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}` } @@ -129,7 +129,7 @@

Method Details

{ # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. - "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` + "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` "registeredEvent": "A String", # The event that the merchant wants to be notified about. "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}` }
@@ -170,7 +170,7 @@

Method Details

{ # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. - "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` + "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` "registeredEvent": "A String", # The event that the merchant wants to be notified about. "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}` }
@@ -198,7 +198,7 @@

Method Details

{ # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. - "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` + "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` "registeredEvent": "A String", # The event that the merchant wants to be notified about. "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}` }, @@ -225,14 +225,14 @@

Method Details

Updates an existing notification subscription for a merchant.
 
 Args:
-  name: string, Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` (required)
+  name: string, Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents.
   "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis.
   "callBackUri": "A String", # URL to be used to push the notification to the merchant.
-  "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}`
+  "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}`
   "registeredEvent": "A String", # The event that the merchant wants to be notified about.
   "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}`
 }
@@ -249,7 +249,7 @@ 

Method Details

{ # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. - "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` + "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` "registeredEvent": "A String", # The event that the merchant wants to be notified about. "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}` }
diff --git a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html index 3f755644c7..b007567d06 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html @@ -318,6 +318,11 @@

Method Details

"itemGroupId": "A String", # Shared identifier for all variants of the same product. "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently. "latitude": 3.14, # The latitude of the property. The value must be between -90 (inclusive) and 90 (inclusive), up to 6 decimal places. + "leaseTerm": { # The lease term of the property. # The lease term of the property. + "durationUnit": "A String", # The duration unit of the lease term. + "durationValue": "A String", # The duration value of the lease term. + "type": "A String", # The type of lease term. + }, "lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information. "A String", ], @@ -464,6 +469,35 @@

Method Details

}, ], "returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425). + "returns": [ # Optional. [Return rules](https://support.google.com/merchants/answer/17081382) for the product. + { # The returns of the product. + "countries": [ # The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries to which an item can be returned. + "A String", + ], + "itemConditions": [ # The condition the item must be in to be accepted. + "A String", + ], + "methods": [ # The physical methods by which the item can be returned. + "A String", + ], + "outcomes": [ # The financial outcomes available for a return. + "A String", + ], + "policyUrl": "A String", # The URL of the return policy. + "restockingFee": { # The price represented as a number and currency. # A flat restocking fee penalty. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "restockingPercentageFee": 3.14, # A percentage restocking fee penalty. + "shippingFee": { # The price represented as a number and currency. # The fixed cost out-of-pocket for a customer to return an item. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "shippingFeeType": "A String", # The type of return shipping fee. + "windowDays": "A String", # The duration of the return window in days. + "windowType": "A String", # Special return window behavior. + }, + ], "salePrice": { # The price represented as a number and currency. # Advertised sale price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -822,6 +856,11 @@

Method Details

"itemGroupId": "A String", # Shared identifier for all variants of the same product. "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently. "latitude": 3.14, # The latitude of the property. The value must be between -90 (inclusive) and 90 (inclusive), up to 6 decimal places. + "leaseTerm": { # The lease term of the property. # The lease term of the property. + "durationUnit": "A String", # The duration unit of the lease term. + "durationValue": "A String", # The duration value of the lease term. + "type": "A String", # The type of lease term. + }, "lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information. "A String", ], @@ -968,6 +1007,35 @@

Method Details

}, ], "returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425). + "returns": [ # Optional. [Return rules](https://support.google.com/merchants/answer/17081382) for the product. + { # The returns of the product. + "countries": [ # The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries to which an item can be returned. + "A String", + ], + "itemConditions": [ # The condition the item must be in to be accepted. + "A String", + ], + "methods": [ # The physical methods by which the item can be returned. + "A String", + ], + "outcomes": [ # The financial outcomes available for a return. + "A String", + ], + "policyUrl": "A String", # The URL of the return policy. + "restockingFee": { # The price represented as a number and currency. # A flat restocking fee penalty. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "restockingPercentageFee": 3.14, # A percentage restocking fee penalty. + "shippingFee": { # The price represented as a number and currency. # The fixed cost out-of-pocket for a customer to return an item. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "shippingFeeType": "A String", # The type of return shipping fee. + "windowDays": "A String", # The duration of the return window in days. + "windowType": "A String", # Special return window behavior. + }, + ], "salePrice": { # The price represented as a number and currency. # Advertised sale price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -1327,6 +1395,11 @@

Method Details

"itemGroupId": "A String", # Shared identifier for all variants of the same product. "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently. "latitude": 3.14, # The latitude of the property. The value must be between -90 (inclusive) and 90 (inclusive), up to 6 decimal places. + "leaseTerm": { # The lease term of the property. # The lease term of the property. + "durationUnit": "A String", # The duration unit of the lease term. + "durationValue": "A String", # The duration value of the lease term. + "type": "A String", # The type of lease term. + }, "lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information. "A String", ], @@ -1473,6 +1546,35 @@

Method Details

}, ], "returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425). + "returns": [ # Optional. [Return rules](https://support.google.com/merchants/answer/17081382) for the product. + { # The returns of the product. + "countries": [ # The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries to which an item can be returned. + "A String", + ], + "itemConditions": [ # The condition the item must be in to be accepted. + "A String", + ], + "methods": [ # The physical methods by which the item can be returned. + "A String", + ], + "outcomes": [ # The financial outcomes available for a return. + "A String", + ], + "policyUrl": "A String", # The URL of the return policy. + "restockingFee": { # The price represented as a number and currency. # A flat restocking fee penalty. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "restockingPercentageFee": 3.14, # A percentage restocking fee penalty. + "shippingFee": { # The price represented as a number and currency. # The fixed cost out-of-pocket for a customer to return an item. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "shippingFeeType": "A String", # The type of return shipping fee. + "windowDays": "A String", # The duration of the return window in days. + "windowType": "A String", # Special return window behavior. + }, + ], "salePrice": { # The price represented as a number and currency. # Advertised sale price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -1832,6 +1934,11 @@

Method Details

"itemGroupId": "A String", # Shared identifier for all variants of the same product. "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently. "latitude": 3.14, # The latitude of the property. The value must be between -90 (inclusive) and 90 (inclusive), up to 6 decimal places. + "leaseTerm": { # The lease term of the property. # The lease term of the property. + "durationUnit": "A String", # The duration unit of the lease term. + "durationValue": "A String", # The duration value of the lease term. + "type": "A String", # The type of lease term. + }, "lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information. "A String", ], @@ -1978,6 +2085,35 @@

Method Details

}, ], "returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425). + "returns": [ # Optional. [Return rules](https://support.google.com/merchants/answer/17081382) for the product. + { # The returns of the product. + "countries": [ # The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries to which an item can be returned. + "A String", + ], + "itemConditions": [ # The condition the item must be in to be accepted. + "A String", + ], + "methods": [ # The physical methods by which the item can be returned. + "A String", + ], + "outcomes": [ # The financial outcomes available for a return. + "A String", + ], + "policyUrl": "A String", # The URL of the return policy. + "restockingFee": { # The price represented as a number and currency. # A flat restocking fee penalty. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "restockingPercentageFee": 3.14, # A percentage restocking fee penalty. + "shippingFee": { # The price represented as a number and currency. # The fixed cost out-of-pocket for a customer to return an item. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "shippingFeeType": "A String", # The type of return shipping fee. + "windowDays": "A String", # The duration of the return window in days. + "windowType": "A String", # Special return window behavior. + }, + ], "salePrice": { # The price represented as a number and currency. # Advertised sale price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/docs/dyn/merchantapi_products_v1.accounts.products.html b/docs/dyn/merchantapi_products_v1.accounts.products.html index f3d7274e2c..dd1e5c7ed7 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1.accounts.products.html @@ -318,6 +318,11 @@

Method Details

"itemGroupId": "A String", # Shared identifier for all variants of the same product. "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently. "latitude": 3.14, # The latitude of the property. The value must be between -90 (inclusive) and 90 (inclusive), up to 6 decimal places. + "leaseTerm": { # The lease term of the property. # The lease term of the property. + "durationUnit": "A String", # The duration unit of the lease term. + "durationValue": "A String", # The duration value of the lease term. + "type": "A String", # The type of lease term. + }, "lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information. "A String", ], @@ -464,6 +469,35 @@

Method Details

}, ], "returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425). + "returns": [ # Optional. [Return rules](https://support.google.com/merchants/answer/17081382) for the product. + { # The returns of the product. + "countries": [ # The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries to which an item can be returned. + "A String", + ], + "itemConditions": [ # The condition the item must be in to be accepted. + "A String", + ], + "methods": [ # The physical methods by which the item can be returned. + "A String", + ], + "outcomes": [ # The financial outcomes available for a return. + "A String", + ], + "policyUrl": "A String", # The URL of the return policy. + "restockingFee": { # The price represented as a number and currency. # A flat restocking fee penalty. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "restockingPercentageFee": 3.14, # A percentage restocking fee penalty. + "shippingFee": { # The price represented as a number and currency. # The fixed cost out-of-pocket for a customer to return an item. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "shippingFeeType": "A String", # The type of return shipping fee. + "windowDays": "A String", # The duration of the return window in days. + "windowType": "A String", # Special return window behavior. + }, + ], "salePrice": { # The price represented as a number and currency. # Advertised sale price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -881,6 +915,11 @@

Method Details

"itemGroupId": "A String", # Shared identifier for all variants of the same product. "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently. "latitude": 3.14, # The latitude of the property. The value must be between -90 (inclusive) and 90 (inclusive), up to 6 decimal places. + "leaseTerm": { # The lease term of the property. # The lease term of the property. + "durationUnit": "A String", # The duration unit of the lease term. + "durationValue": "A String", # The duration value of the lease term. + "type": "A String", # The type of lease term. + }, "lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information. "A String", ], @@ -1027,6 +1066,35 @@

Method Details

}, ], "returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425). + "returns": [ # Optional. [Return rules](https://support.google.com/merchants/answer/17081382) for the product. + { # The returns of the product. + "countries": [ # The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries to which an item can be returned. + "A String", + ], + "itemConditions": [ # The condition the item must be in to be accepted. + "A String", + ], + "methods": [ # The physical methods by which the item can be returned. + "A String", + ], + "outcomes": [ # The financial outcomes available for a return. + "A String", + ], + "policyUrl": "A String", # The URL of the return policy. + "restockingFee": { # The price represented as a number and currency. # A flat restocking fee penalty. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "restockingPercentageFee": 3.14, # A percentage restocking fee penalty. + "shippingFee": { # The price represented as a number and currency. # The fixed cost out-of-pocket for a customer to return an item. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "shippingFeeType": "A String", # The type of return shipping fee. + "windowDays": "A String", # The duration of the return window in days. + "windowType": "A String", # Special return window behavior. + }, + ], "salePrice": { # The price represented as a number and currency. # Advertised sale price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/docs/dyn/merchantapi_quota_v1.accounts.quotas.html b/docs/dyn/merchantapi_quota_v1.accounts.quotas.html index c44e40cebf..c696b23d98 100644 --- a/docs/dyn/merchantapi_quota_v1.accounts.quotas.html +++ b/docs/dyn/merchantapi_quota_v1.accounts.quotas.html @@ -120,7 +120,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the quota group. Format: accounts/{account}/quotas/{group} Note: There is no guarantee on the format of {group} "quotaLimit": "A String", # Output only. The maximum number of calls allowed per day for the group. "quotaMinuteLimit": "A String", # Output only. The maximum number of calls allowed per minute for the group. - "quotaUsage": "A String", # Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at at 12:00 PM midday UTC. + "quotaUsage": "A String", # Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at 12:00 PM midday UTC. }, ], }
diff --git a/docs/dyn/merchantapi_quota_v1beta.accounts.quotas.html b/docs/dyn/merchantapi_quota_v1beta.accounts.quotas.html index 9172a09149..9cbe722090 100644 --- a/docs/dyn/merchantapi_quota_v1beta.accounts.quotas.html +++ b/docs/dyn/merchantapi_quota_v1beta.accounts.quotas.html @@ -120,7 +120,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the quota group. Format: accounts/{account}/quotas/{group} Note: There is no guarantee on the format of {group} "quotaLimit": "A String", # Output only. The maximum number of calls allowed per day for the group. "quotaMinuteLimit": "A String", # Output only. The maximum number of calls allowed per minute for the group. - "quotaUsage": "A String", # Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at at 12:00 PM midday UTC. + "quotaUsage": "A String", # Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at 12:00 PM midday UTC. }, ], }
diff --git a/docs/dyn/merchantapi_reports_v1.accounts.reports.html b/docs/dyn/merchantapi_reports_v1.accounts.reports.html index b99a575fe7..9b43ffc7b5 100644 --- a/docs/dyn/merchantapi_reports_v1.accounts.reports.html +++ b/docs/dyn/merchantapi_reports_v1.accounts.reports.html @@ -207,13 +207,13 @@

Method Details

"nonProductPerformanceView": { # Fields available for query in `non_product_performance_view` table. Performance data on images and online store links leading to your non-product pages. This includes performance metrics (for example, `clicks`) and dimensions according to which performance metrics are segmented (for example, `date`). Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `non_product_performance_view` table. "clickThroughRate": 3.14, # Click-through rate - the number of clicks (`clicks`) divided by the number of impressions (`impressions`) of images and online store links leading to your non-product pages. Metric. "clicks": "A String", # Number of clicks on images and online store links leading to your non-product pages. Metric. - "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date in the merchant timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date in the Merchant Center account timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "impressions": "A String", # Number of times images and online store links leading to your non-product pages were shown. Metric. - "week": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # First day of the week (Monday) of the metrics date in the merchant timezone. Segment. + "week": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # First day of the week (Monday) of the metrics date in the Merchant Center account timezone. Segment. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. @@ -293,7 +293,7 @@

Method Details

"customLabel3": "A String", # Custom label 3 for custom grouping of products. Segment. "customLabel4": "A String", # Custom label 4 for custom grouping of products. Segment. "customerCountryCode": "A String", # Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. Segment. If the customer country cannot be determined, a special 'ZZ' code is returned. - "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date in the merchant timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date in the Merchant Center account timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. @@ -308,7 +308,7 @@

Method Details

"productTypeL5": "A String", # [Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment. "storeType": "A String", # Store type to which metrics apply. Can be `ONLINE_STORE` or `LOCAL_STORES`. Segment. For `LOCAL_STORES` store type, further segmentation by a specific store is not available. "title": "A String", # Title of the product. Segment. - "week": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # First day of the week (Monday) of the metrics date in the merchant timezone. Segment. + "week": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # First day of the week (Monday) of the metrics date in the Merchant Center account timezone. Segment. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. diff --git a/docs/dyn/merchantapi_reports_v1beta.accounts.reports.html b/docs/dyn/merchantapi_reports_v1beta.accounts.reports.html index b7e458ca44..fb79cf0403 100644 --- a/docs/dyn/merchantapi_reports_v1beta.accounts.reports.html +++ b/docs/dyn/merchantapi_reports_v1beta.accounts.reports.html @@ -207,13 +207,13 @@

Method Details

"nonProductPerformanceView": { # Fields available for query in `non_product_performance_view` table. Performance data on images and online store links leading to your non-product pages. This includes performance metrics (for example, `clicks`) and dimensions according to which performance metrics are segmented (for example, `date`). Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `non_product_performance_view` table. "clickThroughRate": 3.14, # Click-through rate - the number of clicks (`clicks`) divided by the number of impressions (`impressions`) of images and online store links leading to your non-product pages. Metric. "clicks": "A String", # Number of clicks on images and online store links leading to your non-product pages. Metric. - "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date in the merchant timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date in the Merchant Center account timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "impressions": "A String", # Number of times images and online store links leading to your non-product pages were shown. Metric. - "week": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # First day of the week (Monday) of the metrics date in the merchant timezone. Segment. + "week": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # First day of the week (Monday) of the metrics date in the Merchant Center account timezone. Segment. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. @@ -293,7 +293,7 @@

Method Details

"customLabel3": "A String", # Custom label 3 for custom grouping of products. Segment. "customLabel4": "A String", # Custom label 4 for custom grouping of products. Segment. "customerCountryCode": "A String", # Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. Segment. If the customer country cannot be determined, a special 'ZZ' code is returned. - "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date in the merchant timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date in the Merchant Center account timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. @@ -308,7 +308,7 @@

Method Details

"productTypeL5": "A String", # [Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment. "storeType": "A String", # Store type to which metrics apply. Can be `ONLINE_STORE` or `LOCAL_STORES`. Segment. For `LOCAL_STORES` store type, further segmentation by a specific store is not available. "title": "A String", # Title of the product. Segment. - "week": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # First day of the week (Monday) of the metrics date in the merchant timezone. Segment. + "week": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # First day of the week (Monday) of the metrics date in the Merchant Center account timezone. Segment. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json index d4067d3e43..9c5d249125 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json @@ -2438,7 +2438,7 @@ } } }, -"revision": "20260527", +"revision": "20260722", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -2686,6 +2686,10 @@ "description": "Output only. The human-readable display name of the provider account.", "readOnly": true, "type": "string" +}, +"ucpCheckoutManagement": { +"$ref": "UcpCheckoutManagement", +"description": "Service type for UCP Checkout Management. The provider is managing the UCP Checkout capability integration for the merchant." } }, "type": "object" @@ -5594,6 +5598,12 @@ false }, "type": "object" }, +"UcpCheckoutManagement": { +"description": "`UcpCheckoutManagement` payload.", +"id": "UcpCheckoutManagement", +"properties": {}, +"type": "object" +}, "UnclaimHomepageRequest": { "description": "Request message for the `UnclaimHomepage` method.", "id": "UnclaimHomepageRequest", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index 243b2965fc..18af4f02fa 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -2388,7 +2388,7 @@ } } }, -"revision": "20260527", +"revision": "20260722", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -2636,6 +2636,10 @@ "description": "Output only. The human-readable display name of the provider account.", "readOnly": true, "type": "string" +}, +"ucpCheckoutManagement": { +"$ref": "UcpCheckoutManagement", +"description": "Service type for UCP Checkout Management. The provider is managing the UCP Checkout capability integration for the merchant." } }, "type": "object" @@ -5471,6 +5475,12 @@ false }, "type": "object" }, +"UcpCheckoutManagement": { +"description": "`UcpCheckoutManagement` payload.", +"id": "UcpCheckoutManagement", +"properties": {}, +"type": "object" +}, "UnclaimHomepageRequest": { "description": "Request message for the `UnclaimHomepage` method.", "id": "UnclaimHomepageRequest", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json index 23a6961464..d4964e4c88 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json @@ -321,7 +321,7 @@ } } }, -"revision": "20260615", +"revision": "20260719", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -401,7 +401,8 @@ "id": "DataSourceReference", "properties": { "primaryDataSourceName": { -"description": "Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`", +"deprecated": true, +"description": "Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`", "type": "string" }, "self": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json index 3b074a5d49..2203e40a02 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json @@ -321,7 +321,7 @@ } } }, -"revision": "20260615", +"revision": "20260719", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -401,7 +401,8 @@ "id": "DataSourceReference", "properties": { "primaryDataSourceName": { -"description": "Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`", +"deprecated": true, +"description": "Optional. Deprecated: Use `self` instead to reference the primary data source. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`", "type": "string" }, "self": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json index 06779ecc34..0c07edd03f 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json @@ -300,9 +300,31 @@ } } }, -"revision": "20260624", +"revision": "20260713", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { +"CustomAttribute": { +"description": "A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.", +"id": "CustomAttribute", +"properties": { +"groupValues": { +"description": "Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.", +"items": { +"$ref": "CustomAttribute" +}, +"type": "array" +}, +"name": { +"description": "The name of the attribute.", +"type": "string" +}, +"value": { +"description": "The value of the attribute. If `value` is not empty, `group_values` must be empty.", +"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", @@ -451,6 +473,13 @@ ], "type": "string" }, +"customAttributes": { +"description": "Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.", +"items": { +"$ref": "CustomAttribute" +}, +"type": "array" +}, "instoreProductLocation": { "description": "Optional. Location of the product inside the store. Maximum length is 20 bytes.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json index 3dd849abae..751e68e5c8 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json @@ -268,7 +268,7 @@ } } }, -"revision": "20260707", +"revision": "20260713", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Action": { @@ -1110,7 +1110,7 @@ false "description": "Clarifies the severity of the issue. The summarizing message, if present, should be shown right under the title for each issue. It helps business to quickly understand the impact of the issue. The detailed breakdown helps the business to fully understand the impact of the issue. It can be rendered as dialog that opens when the business mouse over the summarized impact statement. Issues with different severity can be styled differently. They may use a different color or icon to signal the difference between `ERROR`, `WARNING` and `INFO`." }, "prerenderedContent": { -"description": "Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.", +"description": "Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `asset-value` - marks the paragraph that contains the asset information. * `asset-label` - marks the section of the text that contains the label of the asset. * `asset-link` - marks the section of the text that contains a link to the asset. * `asset-provided-value` - marks the section of the text that contains the value of the asset. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.", "type": "string" }, "prerenderedOutOfCourtDisputeSettlement": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json index 8fa83b5985..15432703fa 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json @@ -268,7 +268,7 @@ } } }, -"revision": "20260707", +"revision": "20260713", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Action": { @@ -1110,7 +1110,7 @@ false "description": "Clarifies the severity of the issue. The summarizing message, if present, should be shown right under the title for each issue. It helps business to quickly understand the impact of the issue. The detailed breakdown helps the business to fully understand the impact of the issue. It can be rendered as dialog that opens when the business mouse over the summarized impact statement. Issues with different severity can be styled differently. They may use a different color or icon to signal the difference between `ERROR`, `WARNING` and `INFO`." }, "prerenderedContent": { -"description": "Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.", +"description": "Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `asset-value` - marks the paragraph that contains the asset information. * `asset-label` - marks the section of the text that contains the label of the asset. * `asset-link` - marks the section of the text that contains a link to the asset. * `asset-provided-value` - marks the section of the text that contains the value of the asset. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.", "type": "string" }, "prerenderedOutOfCourtDisputeSettlement": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json index 63845af53a..6b992781ba 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json @@ -110,7 +110,7 @@ "notificationsubscriptions": { "methods": { "create": { -"description": "Creates a notification subscription for a business. For standalone or subaccounts accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple \"partial\" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple \"all managed accounts\" subscriptions. 3. \"All managed accounts\" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.", +"description": "Creates a notification subscription for a business. For standalone or sub-accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple \"partial\" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple \"all managed accounts\" subscriptions. 3. \"All managed accounts\" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.", "flatPath": "notifications/v1/accounts/{accountsId}/notificationsubscriptions", "httpMethod": "POST", "id": "merchantapi.accounts.notificationsubscriptions.create", @@ -233,7 +233,7 @@ ], "parameters": { "name": { -"description": "Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}`", +"description": "Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}`", "location": "path", "pattern": "^accounts/[^/]+/notificationsubscriptions/[^/]+$", "required": true, @@ -262,7 +262,7 @@ } } }, -"revision": "20260615", +"revision": "20260722", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -302,7 +302,7 @@ "type": "string" }, "name": { -"description": "Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}`", +"description": "Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}`", "readOnly": true, "type": "string" }, @@ -310,11 +310,13 @@ "description": "The event that the merchant wants to be notified about.", "enum": [ "NOTIFICATION_EVENT_TYPE_UNSPECIFIED", -"PRODUCT_STATUS_CHANGE" +"PRODUCT_STATUS_CHANGE", +"ACCOUNT_SERVICE_CHANGE" ], "enumDescriptions": [ "Notifications event type is unspecified.", -"Notification of product status changes, for example when product becomes disapproved." +"Notification of product status changes, for example when product becomes disapproved.", +"Notification of account service changes." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json index c801e38729..b5e71c4698 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json @@ -110,7 +110,7 @@ "notificationsubscriptions": { "methods": { "create": { -"description": "Creates a notification subscription for a business. For standalone or subaccounts accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple \"partial\" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple \"all managed accounts\" subscriptions. 3. \"All managed accounts\" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.", +"description": "Creates a notification subscription for a business. For standalone or sub-accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple \"partial\" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple \"all managed accounts\" subscriptions. 3. \"All managed accounts\" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.", "flatPath": "notifications/v1beta/accounts/{accountsId}/notificationsubscriptions", "httpMethod": "POST", "id": "merchantapi.accounts.notificationsubscriptions.create", @@ -233,7 +233,7 @@ ], "parameters": { "name": { -"description": "Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}`", +"description": "Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}`", "location": "path", "pattern": "^accounts/[^/]+/notificationsubscriptions/[^/]+$", "required": true, @@ -262,7 +262,7 @@ } } }, -"revision": "20260615", +"revision": "20260722", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -302,7 +302,7 @@ "type": "string" }, "name": { -"description": "Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}`", +"description": "Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}`", "readOnly": true, "type": "string" }, @@ -310,11 +310,13 @@ "description": "The event that the merchant wants to be notified about.", "enum": [ "NOTIFICATION_EVENT_TYPE_UNSPECIFIED", -"PRODUCT_STATUS_CHANGE" +"PRODUCT_STATUS_CHANGE", +"ACCOUNT_SERVICE_CHANGE" ], "enumDescriptions": [ "Notifications event type is unspecified.", -"Notification of product status changes, for example when product becomes disapproved." +"Notification of product status changes, for example when product becomes disapproved.", +"Notification of account service changes." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json index 4ccb523214..6545e131b5 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json @@ -281,7 +281,7 @@ } } }, -"revision": "20260611", +"revision": "20260729", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AutomatedDiscounts": { @@ -1037,6 +1037,44 @@ false }, "type": "object" }, +"LeaseTerm": { +"description": "The lease term of the property.", +"id": "LeaseTerm", +"properties": { +"durationUnit": { +"description": "The duration unit of the lease term.", +"enum": [ +"DURATION_UNIT_UNSPECIFIED", +"MONTHS", +"WEEKS" +], +"enumDescriptions": [ +"Unspecified duration unit.", +"Month.", +"Week." +], +"type": "string" +}, +"durationValue": { +"description": "The duration value of the lease term.", +"format": "int64", +"type": "string" +}, +"type": { +"description": "The type of lease term.", +"enum": [ +"LEASE_TERM_TYPE_UNSPECIFIED", +"FIXED_TERM" +], +"enumDescriptions": [ +"Unspecified lease term type.", +"Fixed term." +], +"type": "string" +} +}, +"type": "object" +}, "ListProductsResponse": { "description": "Response message for the ListProducts method.", "id": "ListProductsResponse", @@ -1896,6 +1934,10 @@ false "format": "double", "type": "number" }, +"leaseTerm": { +"$ref": "LeaseTerm", +"description": "The lease term of the property." +}, "lifestyleImageLinks": { "description": "Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information.", "items": { @@ -2236,6 +2278,13 @@ false "description": "The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425).", "type": "string" }, +"returns": { +"description": "Optional. [Return rules](https://support.google.com/merchants/answer/17081382) for the product.", +"items": { +"$ref": "Returns" +}, +"type": "array" +}, "salePrice": { "$ref": "Price", "description": "Advertised sale price of the item." @@ -3072,6 +3121,133 @@ false }, "type": "object" }, +"Returns": { +"description": "The returns of the product.", +"id": "Returns", +"properties": { +"countries": { +"description": "The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries to which an item can be returned.", +"items": { +"type": "string" +}, +"type": "array" +}, +"itemConditions": { +"description": "The condition the item must be in to be accepted.", +"items": { +"enum": [ +"ITEM_CONDITION_UNSPECIFIED", +"NEW", +"LIKE_NEW", +"USED", +"DEFECTIVE_ONLY" +], +"enumDescriptions": [ +"The item condition is unspecified.", +"New condition.", +"Like new condition.", +"Used condition.", +"Only defective items are accepted." +], +"type": "string" +}, +"type": "array" +}, +"methods": { +"description": "The physical methods by which the item can be returned.", +"items": { +"enum": [ +"RETURN_METHOD_UNSPECIFIED", +"BY_MAIL", +"IN_STORE", +"AT_A_KIOSK", +"DROP_OFF_LOCATION" +], +"enumDescriptions": [ +"The return method is unspecified.", +"Customer returns the item by mail.", +"Customer returns the item in a store.", +"Customer drops off the item at a kiosk.", +"Customer drops off the item at a 3rd party partner location." +], +"type": "string" +}, +"type": "array" +}, +"outcomes": { +"description": "The financial outcomes available for a return.", +"items": { +"enum": [ +"RETURN_OUTCOME_UNSPECIFIED", +"REFUND", +"EXCHANGE", +"STORE_CREDIT" +], +"enumDescriptions": [ +"The return outcome is unspecified.", +"Customer receives a refund.", +"Customer receives an exchange.", +"Customer receives store credit." +], +"type": "string" +}, +"type": "array" +}, +"policyUrl": { +"description": "The URL of the return policy.", +"type": "string" +}, +"restockingFee": { +"$ref": "Price", +"description": "A flat restocking fee penalty." +}, +"restockingPercentageFee": { +"description": "A percentage restocking fee penalty.", +"format": "double", +"type": "number" +}, +"shippingFee": { +"$ref": "Price", +"description": "The fixed cost out-of-pocket for a customer to return an item." +}, +"shippingFeeType": { +"description": "The type of return shipping fee.", +"enum": [ +"RETURN_SHIPPING_FEE_TYPE_UNSPECIFIED", +"CUSTOMER_RESPONSIBILITY", +"DEDUCTED_FROM_REFUND" +], +"enumDescriptions": [ +"The return shipping fee type is unspecified.", +"The customer is responsible for shipping costs.", +"The shipping cost is deducted from the refund." +], +"type": "string" +}, +"windowDays": { +"description": "The duration of the return window in days.", +"format": "int64", +"type": "string" +}, +"windowType": { +"description": "Special return window behavior.", +"enum": [ +"RETURN_WINDOW_TYPE_UNSPECIFIED", +"FINITE_RETURN_WINDOW", +"NO_RETURNS", +"LIFETIME" +], +"enumDescriptions": [ +"The return window type is unspecified.", +"Window with a fixed number of days. If this is set, the `window_days` field must be set.", +"No returns accepted.", +"Lifetime returns accepted." +], +"type": "string" +} +}, +"type": "object" +}, "Shipping": { "description": "The Shipping of the product.", "id": "Shipping", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json index c17ac9810e..48a50b5d31 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json @@ -220,7 +220,7 @@ } } }, -"revision": "20260527", +"revision": "20260713", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AccountLimit": { @@ -511,7 +511,7 @@ false "type": "string" }, "quotaUsage": { -"description": "Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at at 12:00 PM midday UTC.", +"description": "Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at 12:00 PM midday UTC.", "format": "int64", "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json index 6845057904..9046cacced 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json @@ -150,7 +150,7 @@ } } }, -"revision": "20260527", +"revision": "20260713", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "ListQuotaGroupsResponse": { @@ -382,7 +382,7 @@ false "type": "string" }, "quotaUsage": { -"description": "Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at at 12:00 PM midday UTC.", +"description": "Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at 12:00 PM midday UTC.", "format": "int64", "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json index 1ff054d4f7..f69333f349 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json @@ -142,7 +142,7 @@ } } }, -"revision": "20260615", +"revision": "20260715", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "BestSellersBrandView": { @@ -798,7 +798,7 @@ false }, "date": { "$ref": "Date", -"description": "Date in the merchant timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause." +"description": "Date in the Merchant Center account timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause." }, "impressions": { "description": "Number of times images and online store links leading to your non-product pages were shown. Metric.", @@ -807,7 +807,7 @@ false }, "week": { "$ref": "Date", -"description": "First day of the week (Monday) of the metrics date in the merchant timezone. Segment." +"description": "First day of the week (Monday) of the metrics date in the Merchant Center account timezone. Segment." } }, "type": "object" @@ -1172,7 +1172,7 @@ false }, "date": { "$ref": "Date", -"description": "Date in the merchant timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause." +"description": "Date in the Merchant Center account timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause." }, "impressions": { "description": "Number of times merchant's products are shown. Metric.", @@ -1237,7 +1237,7 @@ false }, "week": { "$ref": "Date", -"description": "First day of the week (Monday) of the metrics date in the merchant timezone. Segment." +"description": "First day of the week (Monday) of the metrics date in the Merchant Center account timezone. Segment." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json index f76a7a0e17..849b934d09 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json @@ -142,7 +142,7 @@ } } }, -"revision": "20260615", +"revision": "20260715", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "BestSellersBrandView": { @@ -798,7 +798,7 @@ false }, "date": { "$ref": "Date", -"description": "Date in the merchant timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause." +"description": "Date in the Merchant Center account timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause." }, "impressions": { "description": "Number of times images and online store links leading to your non-product pages were shown. Metric.", @@ -807,7 +807,7 @@ false }, "week": { "$ref": "Date", -"description": "First day of the week (Monday) of the metrics date in the merchant timezone. Segment." +"description": "First day of the week (Monday) of the metrics date in the Merchant Center account timezone. Segment." } }, "type": "object" @@ -1172,7 +1172,7 @@ false }, "date": { "$ref": "Date", -"description": "Date in the merchant timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause." +"description": "Date in the Merchant Center account timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause." }, "impressions": { "description": "Number of times merchant's products are shown. Metric.", @@ -1237,7 +1237,7 @@ false }, "week": { "$ref": "Date", -"description": "First day of the week (Monday) of the metrics date in the merchant timezone. Segment." +"description": "First day of the week (Monday) of the metrics date in the Merchant Center account timezone. Segment." } }, "type": "object" From 14bd875500c49c368d22774cb80d7578add26686 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:06 +0000 Subject: [PATCH 61/84] feat(metastore): update the api #### metastore:v1alpha The following keys were added: - schemas.BackfillStatus (Total Keys: 8) - schemas.BigLakeMetastoreMigrationConfig (Total Keys: 10) - schemas.CatalogSummary (Total Keys: 9) - schemas.DatabaseSummary (Total Keys: 10) - schemas.HiveConfig (Total Keys: 5) - schemas.IcebergConfig (Total Keys: 5) - schemas.MigrationExecution.properties.biglakeMetastoreMigrationConfig.$ref (Total Keys: 1) - schemas.MigrationSummary (Total Keys: 12) - schemas.TableSummary (Total Keys: 19) #### metastore:v1beta The following keys were added: - schemas.BackfillStatus (Total Keys: 8) - schemas.BigLakeMetastoreMigrationConfig (Total Keys: 10) - schemas.CatalogSummary (Total Keys: 9) - schemas.DatabaseSummary (Total Keys: 10) - schemas.HiveConfig (Total Keys: 5) - schemas.IcebergConfig (Total Keys: 5) - schemas.MigrationExecution.properties.biglakeMetastoreMigrationConfig.$ref (Total Keys: 1) - schemas.MigrationSummary (Total Keys: 12) - schemas.TableSummary (Total Keys: 19) --- ...e_v1alpha.projects.locations.services.html | 51 +++ ...ocations.services.migrationExecutions.html | 102 ++++++ ...re_v1beta.projects.locations.services.html | 51 +++ ...ocations.services.migrationExecutions.html | 102 ++++++ .../documents/metastore.v1.json | 14 +- .../documents/metastore.v1alpha.json | 308 +++++++++++++++++- .../documents/metastore.v1beta.json | 308 +++++++++++++++++- 7 files changed, 921 insertions(+), 15 deletions(-) diff --git a/docs/dyn/metastore_v1alpha.projects.locations.services.html b/docs/dyn/metastore_v1alpha.projects.locations.services.html index 30c016921b..7821488733 100644 --- a/docs/dyn/metastore_v1alpha.projects.locations.services.html +++ b/docs/dyn/metastore_v1alpha.projects.locations.services.html @@ -1460,6 +1460,57 @@

Method Details

{ # Request message for DataprocMetastore.StartMigration. "migrationExecution": { # The details of a migration execution resource. # Required. The configuration details for the migration. + "biglakeMetastoreMigrationConfig": { # Defines the configuration required to migrate metadata from a Dataproc Metastore service to BigLake Metastore. # Configuration information specific to migrating from Dataproc Metastore to BigLake Metastore. + "backfillStatus": { # Backfill status for the migration execution. # Output only. + "migrationSummary": { # Summary of the migration results. # Output only. Summary of the migration results. This is populated after the backfill or dry run is finished. + "catalogSummaries": [ # Output only. Summary of results for each catalog involved in the migration. + { # Summary of results for a specific destination catalog. + "catalog": "A String", # Output only. The catalog resource name (format: projects/*/catalogs/*). + "catalogType": "A String", # Output only. The type of the catalog. + "databaseSummaries": [ # Output only. Summary of results for each database in the catalog. + { # Summary of results for a specific database in a catalog. + "database": "A String", # Output only. The name of the database. + "planAction": "A String", # Output only. The migration plan action for the database. + "resultStatus": "A String", # Output only. The migration result status for the database. This is only set if the migration is not a dry run. + "tableSummary": { # Aggregated summary of results for all tables in a database. # Output only. Aggregated summary of results for all tables in the database. + "partitionDiscoveredCount": "A String", # Output only. Partition migration summary across all Hive tables in the database.The total number of partitions discovered at the source. + "partitionFailedCount": "A String", # Output only. The total number of partitions that failed to migrate at the target. + "partitionSuccessCount": "A String", # Output only. The total number of partitions successfully migrated at the target. + "planCounts": { # Output only. Number of tables with a specific migration plan action. The key is the action name (e.g. CREATE, UPDATE, SKIP, etc.). + "a_key": "A String", + }, + "resultCounts": { # Output only. Number of tables with a specific migration result status. The key is the status name (e.g. SUCCEEDED, FAILED, SKIPPED, etc.). This is only set if the migration is not a dry run. + "a_key": "A String", + }, + }, + }, + ], + }, + ], + "createTime": "A String", # Output only. The UTC time when this report was finalized. + "dryRun": True or False, # Output only. Whether the migration was a dry run. + "service": "A String", # Output only. The Dataproc Metastore service name (format: projects/*/locations/*/services/*) on which the migration was executed. + }, + "reportPath": "A String", # Output only. The Cloud Storage path where the backfill or dry run report is written. Format: "gs://path-to-report". + "state": "A String", # Output only. The current state of the backfill (or dry run). + }, + "conflictPolicy": "A String", # Optional. The policy to handle conflicts when migrating resources, defaults to SKIP if not specified. + "dryRun": True or False, # Optional. If true, performs discovery of requested resources and analysis against the target catalog to come up with a plan for each resource (e.g. Create, Update, Skip, etc.). No metadata is actually migrated. + "hiveConfig": { # Configuration for migrating Hive metadata. # Optional. At least one of hive_config or iceberg_config must be provided, otherwise, a validation error will be thrown. If only one is provided, the service only migrates tables of that specific type. If both are provided, both Hive and Iceberg tables will be migrated.Configuration for migrating Hive tables to a BigLake Hive catalog. + "catalog": "A String", # Required. The target catalog for migrated databases and tables. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" + "databases": [ # Required. The list of databases to migrate to the Hive catalog. Use "*" to migrate all databases. Note: If Iceberg tables exist in these databases, they will only be migrated if iceberg_config is also specified. + "A String", + ], + }, + "icebergConfig": { # Configuration for migrating Iceberg metadata. # Optional. Configuration for migrating Iceberg tables to a BigLake Iceberg REST catalog. + "catalog": "A String", # Required. The target catalog for migrated Iceberg metadata. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" + "namespaces": [ # Required. The list of namespaces to migrate to the Iceberg REST catalog. Use "*" to migrate all namespaces. Note: If Hive tables exist in these namespaces, they will only be migrated if hive_config is also specified. + "A String", + ], + }, + "mode": "A String", # Required. Defines the behavior of the migration execution. + "reportPath": "A String", # Optional. The Cloud Storage path where the backfill / dry run report should be written. If not provided, the report will be generated in the service's artifacts bucket. Format: "gs://path/to/folder" + }, "cloudSqlMigrationConfig": { # Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information for migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. # Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information specific to migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. "cdcConfig": { # Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. # Required. Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. Dataproc Metastore switches to using its backend database after the cutover phase of migration. "bucket": "A String", # Optional. The bucket to write the intermediate stream event data in. The bucket name must be without any prefix like "gs://". See the bucket naming requirements (https://cloud.google.com/storage/docs/buckets#naming). This field is optional. If not set, the Artifacts Cloud Storage bucket will be used. diff --git a/docs/dyn/metastore_v1alpha.projects.locations.services.migrationExecutions.html b/docs/dyn/metastore_v1alpha.projects.locations.services.migrationExecutions.html index 5fb32e7777..0f6d61383f 100644 --- a/docs/dyn/metastore_v1alpha.projects.locations.services.migrationExecutions.html +++ b/docs/dyn/metastore_v1alpha.projects.locations.services.migrationExecutions.html @@ -146,6 +146,57 @@

Method Details

An object of the form: { # The details of a migration execution resource. + "biglakeMetastoreMigrationConfig": { # Defines the configuration required to migrate metadata from a Dataproc Metastore service to BigLake Metastore. # Configuration information specific to migrating from Dataproc Metastore to BigLake Metastore. + "backfillStatus": { # Backfill status for the migration execution. # Output only. + "migrationSummary": { # Summary of the migration results. # Output only. Summary of the migration results. This is populated after the backfill or dry run is finished. + "catalogSummaries": [ # Output only. Summary of results for each catalog involved in the migration. + { # Summary of results for a specific destination catalog. + "catalog": "A String", # Output only. The catalog resource name (format: projects/*/catalogs/*). + "catalogType": "A String", # Output only. The type of the catalog. + "databaseSummaries": [ # Output only. Summary of results for each database in the catalog. + { # Summary of results for a specific database in a catalog. + "database": "A String", # Output only. The name of the database. + "planAction": "A String", # Output only. The migration plan action for the database. + "resultStatus": "A String", # Output only. The migration result status for the database. This is only set if the migration is not a dry run. + "tableSummary": { # Aggregated summary of results for all tables in a database. # Output only. Aggregated summary of results for all tables in the database. + "partitionDiscoveredCount": "A String", # Output only. Partition migration summary across all Hive tables in the database.The total number of partitions discovered at the source. + "partitionFailedCount": "A String", # Output only. The total number of partitions that failed to migrate at the target. + "partitionSuccessCount": "A String", # Output only. The total number of partitions successfully migrated at the target. + "planCounts": { # Output only. Number of tables with a specific migration plan action. The key is the action name (e.g. CREATE, UPDATE, SKIP, etc.). + "a_key": "A String", + }, + "resultCounts": { # Output only. Number of tables with a specific migration result status. The key is the status name (e.g. SUCCEEDED, FAILED, SKIPPED, etc.). This is only set if the migration is not a dry run. + "a_key": "A String", + }, + }, + }, + ], + }, + ], + "createTime": "A String", # Output only. The UTC time when this report was finalized. + "dryRun": True or False, # Output only. Whether the migration was a dry run. + "service": "A String", # Output only. The Dataproc Metastore service name (format: projects/*/locations/*/services/*) on which the migration was executed. + }, + "reportPath": "A String", # Output only. The Cloud Storage path where the backfill or dry run report is written. Format: "gs://path-to-report". + "state": "A String", # Output only. The current state of the backfill (or dry run). + }, + "conflictPolicy": "A String", # Optional. The policy to handle conflicts when migrating resources, defaults to SKIP if not specified. + "dryRun": True or False, # Optional. If true, performs discovery of requested resources and analysis against the target catalog to come up with a plan for each resource (e.g. Create, Update, Skip, etc.). No metadata is actually migrated. + "hiveConfig": { # Configuration for migrating Hive metadata. # Optional. At least one of hive_config or iceberg_config must be provided, otherwise, a validation error will be thrown. If only one is provided, the service only migrates tables of that specific type. If both are provided, both Hive and Iceberg tables will be migrated.Configuration for migrating Hive tables to a BigLake Hive catalog. + "catalog": "A String", # Required. The target catalog for migrated databases and tables. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" + "databases": [ # Required. The list of databases to migrate to the Hive catalog. Use "*" to migrate all databases. Note: If Iceberg tables exist in these databases, they will only be migrated if iceberg_config is also specified. + "A String", + ], + }, + "icebergConfig": { # Configuration for migrating Iceberg metadata. # Optional. Configuration for migrating Iceberg tables to a BigLake Iceberg REST catalog. + "catalog": "A String", # Required. The target catalog for migrated Iceberg metadata. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" + "namespaces": [ # Required. The list of namespaces to migrate to the Iceberg REST catalog. Use "*" to migrate all namespaces. Note: If Hive tables exist in these namespaces, they will only be migrated if hive_config is also specified. + "A String", + ], + }, + "mode": "A String", # Required. Defines the behavior of the migration execution. + "reportPath": "A String", # Optional. The Cloud Storage path where the backfill / dry run report should be written. If not provided, the report will be generated in the service's artifacts bucket. Format: "gs://path/to/folder" + }, "cloudSqlMigrationConfig": { # Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information for migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. # Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information specific to migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. "cdcConfig": { # Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. # Required. Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. Dataproc Metastore switches to using its backend database after the cutover phase of migration. "bucket": "A String", # Optional. The bucket to write the intermediate stream event data in. The bucket name must be without any prefix like "gs://". See the bucket naming requirements (https://cloud.google.com/storage/docs/buckets#naming). This field is optional. If not set, the Artifacts Cloud Storage bucket will be used. @@ -197,6 +248,57 @@

Method Details

{ # Response message for DataprocMetastore.ListMigrationExecutions. "migrationExecutions": [ # The migration executions on the specified service. { # The details of a migration execution resource. + "biglakeMetastoreMigrationConfig": { # Defines the configuration required to migrate metadata from a Dataproc Metastore service to BigLake Metastore. # Configuration information specific to migrating from Dataproc Metastore to BigLake Metastore. + "backfillStatus": { # Backfill status for the migration execution. # Output only. + "migrationSummary": { # Summary of the migration results. # Output only. Summary of the migration results. This is populated after the backfill or dry run is finished. + "catalogSummaries": [ # Output only. Summary of results for each catalog involved in the migration. + { # Summary of results for a specific destination catalog. + "catalog": "A String", # Output only. The catalog resource name (format: projects/*/catalogs/*). + "catalogType": "A String", # Output only. The type of the catalog. + "databaseSummaries": [ # Output only. Summary of results for each database in the catalog. + { # Summary of results for a specific database in a catalog. + "database": "A String", # Output only. The name of the database. + "planAction": "A String", # Output only. The migration plan action for the database. + "resultStatus": "A String", # Output only. The migration result status for the database. This is only set if the migration is not a dry run. + "tableSummary": { # Aggregated summary of results for all tables in a database. # Output only. Aggregated summary of results for all tables in the database. + "partitionDiscoveredCount": "A String", # Output only. Partition migration summary across all Hive tables in the database.The total number of partitions discovered at the source. + "partitionFailedCount": "A String", # Output only. The total number of partitions that failed to migrate at the target. + "partitionSuccessCount": "A String", # Output only. The total number of partitions successfully migrated at the target. + "planCounts": { # Output only. Number of tables with a specific migration plan action. The key is the action name (e.g. CREATE, UPDATE, SKIP, etc.). + "a_key": "A String", + }, + "resultCounts": { # Output only. Number of tables with a specific migration result status. The key is the status name (e.g. SUCCEEDED, FAILED, SKIPPED, etc.). This is only set if the migration is not a dry run. + "a_key": "A String", + }, + }, + }, + ], + }, + ], + "createTime": "A String", # Output only. The UTC time when this report was finalized. + "dryRun": True or False, # Output only. Whether the migration was a dry run. + "service": "A String", # Output only. The Dataproc Metastore service name (format: projects/*/locations/*/services/*) on which the migration was executed. + }, + "reportPath": "A String", # Output only. The Cloud Storage path where the backfill or dry run report is written. Format: "gs://path-to-report". + "state": "A String", # Output only. The current state of the backfill (or dry run). + }, + "conflictPolicy": "A String", # Optional. The policy to handle conflicts when migrating resources, defaults to SKIP if not specified. + "dryRun": True or False, # Optional. If true, performs discovery of requested resources and analysis against the target catalog to come up with a plan for each resource (e.g. Create, Update, Skip, etc.). No metadata is actually migrated. + "hiveConfig": { # Configuration for migrating Hive metadata. # Optional. At least one of hive_config or iceberg_config must be provided, otherwise, a validation error will be thrown. If only one is provided, the service only migrates tables of that specific type. If both are provided, both Hive and Iceberg tables will be migrated.Configuration for migrating Hive tables to a BigLake Hive catalog. + "catalog": "A String", # Required. The target catalog for migrated databases and tables. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" + "databases": [ # Required. The list of databases to migrate to the Hive catalog. Use "*" to migrate all databases. Note: If Iceberg tables exist in these databases, they will only be migrated if iceberg_config is also specified. + "A String", + ], + }, + "icebergConfig": { # Configuration for migrating Iceberg metadata. # Optional. Configuration for migrating Iceberg tables to a BigLake Iceberg REST catalog. + "catalog": "A String", # Required. The target catalog for migrated Iceberg metadata. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" + "namespaces": [ # Required. The list of namespaces to migrate to the Iceberg REST catalog. Use "*" to migrate all namespaces. Note: If Hive tables exist in these namespaces, they will only be migrated if hive_config is also specified. + "A String", + ], + }, + "mode": "A String", # Required. Defines the behavior of the migration execution. + "reportPath": "A String", # Optional. The Cloud Storage path where the backfill / dry run report should be written. If not provided, the report will be generated in the service's artifacts bucket. Format: "gs://path/to/folder" + }, "cloudSqlMigrationConfig": { # Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information for migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. # Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information specific to migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. "cdcConfig": { # Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. # Required. Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. Dataproc Metastore switches to using its backend database after the cutover phase of migration. "bucket": "A String", # Optional. The bucket to write the intermediate stream event data in. The bucket name must be without any prefix like "gs://". See the bucket naming requirements (https://cloud.google.com/storage/docs/buckets#naming). This field is optional. If not set, the Artifacts Cloud Storage bucket will be used. diff --git a/docs/dyn/metastore_v1beta.projects.locations.services.html b/docs/dyn/metastore_v1beta.projects.locations.services.html index f1bf71276f..d227453296 100644 --- a/docs/dyn/metastore_v1beta.projects.locations.services.html +++ b/docs/dyn/metastore_v1beta.projects.locations.services.html @@ -1460,6 +1460,57 @@

Method Details

{ # Request message for DataprocMetastore.StartMigration. "migrationExecution": { # The details of a migration execution resource. # Required. The configuration details for the migration. + "biglakeMetastoreMigrationConfig": { # Defines the configuration required to migrate metadata from a Dataproc Metastore service to BigLake Metastore. # Configuration information specific to migrating from Dataproc Metastore to BigLake Metastore. + "backfillStatus": { # Backfill status for the migration execution. # Output only. + "migrationSummary": { # Summary of the migration results. # Output only. Summary of the migration results. This is populated after the backfill or dry run is finished. + "catalogSummaries": [ # Output only. Summary of results for each catalog involved in the migration. + { # Summary of results for a specific destination catalog. + "catalog": "A String", # Output only. The catalog resource name (format: projects/*/catalogs/*). + "catalogType": "A String", # Output only. The type of the catalog. + "databaseSummaries": [ # Output only. Summary of results for each database in the catalog. + { # Summary of results for a specific database in a catalog. + "database": "A String", # Output only. The name of the database. + "planAction": "A String", # Output only. The migration plan action for the database. + "resultStatus": "A String", # Output only. The migration result status for the database. This is only set if the migration is not a dry run. + "tableSummary": { # Aggregated summary of results for all tables in a database. # Output only. Aggregated summary of results for all tables in the database. + "partitionDiscoveredCount": "A String", # Output only. Partition migration summary across all Hive tables in the database.The total number of partitions discovered at the source. + "partitionFailedCount": "A String", # Output only. The total number of partitions that failed to migrate at the target. + "partitionSuccessCount": "A String", # Output only. The total number of partitions successfully migrated at the target. + "planCounts": { # Output only. Number of tables with a specific migration plan action. The key is the action name (e.g. CREATE, UPDATE, SKIP, etc.). + "a_key": "A String", + }, + "resultCounts": { # Output only. Number of tables with a specific migration result status. The key is the status name (e.g. SUCCEEDED, FAILED, SKIPPED, etc.). This is only set if the migration is not a dry run. + "a_key": "A String", + }, + }, + }, + ], + }, + ], + "createTime": "A String", # Output only. The UTC time when this report was finalized. + "dryRun": True or False, # Output only. Whether the migration was a dry run. + "service": "A String", # Output only. The Dataproc Metastore service name (format: projects/*/locations/*/services/*) on which the migration was executed. + }, + "reportPath": "A String", # Output only. The Cloud Storage path where the backfill or dry run report is written. Format: "gs://path-to-report". + "state": "A String", # Output only. The current state of the backfill (or dry run). + }, + "conflictPolicy": "A String", # Optional. The policy to handle conflicts when migrating resources, defaults to SKIP if not specified. + "dryRun": True or False, # Optional. If true, performs discovery of requested resources and analysis against the target catalog to come up with a plan for each resource (e.g. Create, Update, Skip, etc.). No metadata is actually migrated. + "hiveConfig": { # Configuration for migrating Hive metadata. # Optional. At least one of hive_config or iceberg_config must be provided, otherwise, a validation error will be thrown. If only one is provided, the service only migrates tables of that specific type. If both are provided, both Hive and Iceberg tables will be migrated.Configuration for migrating Hive tables to a BigLake Hive catalog. + "catalog": "A String", # Required. The target catalog for migrated databases and tables. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" + "databases": [ # Required. The list of databases to migrate to the Hive catalog. Use "*" to migrate all databases. Note: If Iceberg tables exist in these databases, they will only be migrated if iceberg_config is also specified. + "A String", + ], + }, + "icebergConfig": { # Configuration for migrating Iceberg metadata. # Optional. Configuration for migrating Iceberg tables to a BigLake Iceberg REST catalog. + "catalog": "A String", # Required. The target catalog for migrated Iceberg metadata. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" + "namespaces": [ # Required. The list of namespaces to migrate to the Iceberg REST catalog. Use "*" to migrate all namespaces. Note: If Hive tables exist in these namespaces, they will only be migrated if hive_config is also specified. + "A String", + ], + }, + "mode": "A String", # Required. Defines the behavior of the migration execution. + "reportPath": "A String", # Optional. The Cloud Storage path where the backfill / dry run report should be written. If not provided, the report will be generated in the service's artifacts bucket. Format: "gs://path/to/folder" + }, "cloudSqlMigrationConfig": { # Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information for migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. # Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information specific to migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. "cdcConfig": { # Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. # Required. Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. Dataproc Metastore switches to using its backend database after the cutover phase of migration. "bucket": "A String", # Optional. The bucket to write the intermediate stream event data in. The bucket name must be without any prefix like "gs://". See the bucket naming requirements (https://cloud.google.com/storage/docs/buckets#naming). This field is optional. If not set, the Artifacts Cloud Storage bucket will be used. diff --git a/docs/dyn/metastore_v1beta.projects.locations.services.migrationExecutions.html b/docs/dyn/metastore_v1beta.projects.locations.services.migrationExecutions.html index 0d6b125f96..e57f275013 100644 --- a/docs/dyn/metastore_v1beta.projects.locations.services.migrationExecutions.html +++ b/docs/dyn/metastore_v1beta.projects.locations.services.migrationExecutions.html @@ -146,6 +146,57 @@

Method Details

An object of the form: { # The details of a migration execution resource. + "biglakeMetastoreMigrationConfig": { # Defines the configuration required to migrate metadata from a Dataproc Metastore service to BigLake Metastore. # Configuration information specific to migrating from Dataproc Metastore to BigLake Metastore. + "backfillStatus": { # Backfill status for the migration execution. # Output only. + "migrationSummary": { # Summary of the migration results. # Output only. Summary of the migration results. This is populated after the backfill or dry run is finished. + "catalogSummaries": [ # Output only. Summary of results for each catalog involved in the migration. + { # Summary of results for a specific destination catalog. + "catalog": "A String", # Output only. The catalog resource name (format: projects/*/catalogs/*). + "catalogType": "A String", # Output only. The type of the catalog. + "databaseSummaries": [ # Output only. Summary of results for each database in the catalog. + { # Summary of results for a specific database in a catalog. + "database": "A String", # Output only. The name of the database. + "planAction": "A String", # Output only. The migration plan action for the database. + "resultStatus": "A String", # Output only. The migration result status for the database. This is only set if the migration is not a dry run. + "tableSummary": { # Aggregated summary of results for all tables in a database. # Output only. Aggregated summary of results for all tables in the database. + "partitionDiscoveredCount": "A String", # Output only. Partition migration summary across all Hive tables in the database.The total number of partitions discovered at the source. + "partitionFailedCount": "A String", # Output only. The total number of partitions that failed to migrate at the target. + "partitionSuccessCount": "A String", # Output only. The total number of partitions successfully migrated at the target. + "planCounts": { # Output only. Number of tables with a specific migration plan action. The key is the action name (e.g. CREATE, UPDATE, SKIP, etc.). + "a_key": "A String", + }, + "resultCounts": { # Output only. Number of tables with a specific migration result status. The key is the status name (e.g. SUCCEEDED, FAILED, SKIPPED, etc.). This is only set if the migration is not a dry run. + "a_key": "A String", + }, + }, + }, + ], + }, + ], + "createTime": "A String", # Output only. The UTC time when this report was finalized. + "dryRun": True or False, # Output only. Whether the migration was a dry run. + "service": "A String", # Output only. The Dataproc Metastore service name (format: projects/*/locations/*/services/*) on which the migration was executed. + }, + "reportPath": "A String", # Output only. The Cloud Storage path where the backfill or dry run report is written. Format: "gs://path-to-report". + "state": "A String", # Output only. The current state of the backfill (or dry run). + }, + "conflictPolicy": "A String", # Optional. The policy to handle conflicts when migrating resources, defaults to SKIP if not specified. + "dryRun": True or False, # Optional. If true, performs discovery of requested resources and analysis against the target catalog to come up with a plan for each resource (e.g. Create, Update, Skip, etc.). No metadata is actually migrated. + "hiveConfig": { # Configuration for migrating Hive metadata. # Optional. At least one of hive_config or iceberg_config must be provided, otherwise, a validation error will be thrown. If only one is provided, the service only migrates tables of that specific type. If both are provided, both Hive and Iceberg tables will be migrated.Configuration for migrating Hive tables to a BigLake Hive catalog. + "catalog": "A String", # Required. The target catalog for migrated databases and tables. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" + "databases": [ # Required. The list of databases to migrate to the Hive catalog. Use "*" to migrate all databases. Note: If Iceberg tables exist in these databases, they will only be migrated if iceberg_config is also specified. + "A String", + ], + }, + "icebergConfig": { # Configuration for migrating Iceberg metadata. # Optional. Configuration for migrating Iceberg tables to a BigLake Iceberg REST catalog. + "catalog": "A String", # Required. The target catalog for migrated Iceberg metadata. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" + "namespaces": [ # Required. The list of namespaces to migrate to the Iceberg REST catalog. Use "*" to migrate all namespaces. Note: If Hive tables exist in these namespaces, they will only be migrated if hive_config is also specified. + "A String", + ], + }, + "mode": "A String", # Required. Defines the behavior of the migration execution. + "reportPath": "A String", # Optional. The Cloud Storage path where the backfill / dry run report should be written. If not provided, the report will be generated in the service's artifacts bucket. Format: "gs://path/to/folder" + }, "cloudSqlMigrationConfig": { # Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information for migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. # Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information specific to migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. "cdcConfig": { # Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. # Required. Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. Dataproc Metastore switches to using its backend database after the cutover phase of migration. "bucket": "A String", # Optional. The bucket to write the intermediate stream event data in. The bucket name must be without any prefix like "gs://". See the bucket naming requirements (https://cloud.google.com/storage/docs/buckets#naming). This field is optional. If not set, the Artifacts Cloud Storage bucket will be used. @@ -197,6 +248,57 @@

Method Details

{ # Response message for DataprocMetastore.ListMigrationExecutions. "migrationExecutions": [ # The migration executions on the specified service. { # The details of a migration execution resource. + "biglakeMetastoreMigrationConfig": { # Defines the configuration required to migrate metadata from a Dataproc Metastore service to BigLake Metastore. # Configuration information specific to migrating from Dataproc Metastore to BigLake Metastore. + "backfillStatus": { # Backfill status for the migration execution. # Output only. + "migrationSummary": { # Summary of the migration results. # Output only. Summary of the migration results. This is populated after the backfill or dry run is finished. + "catalogSummaries": [ # Output only. Summary of results for each catalog involved in the migration. + { # Summary of results for a specific destination catalog. + "catalog": "A String", # Output only. The catalog resource name (format: projects/*/catalogs/*). + "catalogType": "A String", # Output only. The type of the catalog. + "databaseSummaries": [ # Output only. Summary of results for each database in the catalog. + { # Summary of results for a specific database in a catalog. + "database": "A String", # Output only. The name of the database. + "planAction": "A String", # Output only. The migration plan action for the database. + "resultStatus": "A String", # Output only. The migration result status for the database. This is only set if the migration is not a dry run. + "tableSummary": { # Aggregated summary of results for all tables in a database. # Output only. Aggregated summary of results for all tables in the database. + "partitionDiscoveredCount": "A String", # Output only. Partition migration summary across all Hive tables in the database.The total number of partitions discovered at the source. + "partitionFailedCount": "A String", # Output only. The total number of partitions that failed to migrate at the target. + "partitionSuccessCount": "A String", # Output only. The total number of partitions successfully migrated at the target. + "planCounts": { # Output only. Number of tables with a specific migration plan action. The key is the action name (e.g. CREATE, UPDATE, SKIP, etc.). + "a_key": "A String", + }, + "resultCounts": { # Output only. Number of tables with a specific migration result status. The key is the status name (e.g. SUCCEEDED, FAILED, SKIPPED, etc.). This is only set if the migration is not a dry run. + "a_key": "A String", + }, + }, + }, + ], + }, + ], + "createTime": "A String", # Output only. The UTC time when this report was finalized. + "dryRun": True or False, # Output only. Whether the migration was a dry run. + "service": "A String", # Output only. The Dataproc Metastore service name (format: projects/*/locations/*/services/*) on which the migration was executed. + }, + "reportPath": "A String", # Output only. The Cloud Storage path where the backfill or dry run report is written. Format: "gs://path-to-report". + "state": "A String", # Output only. The current state of the backfill (or dry run). + }, + "conflictPolicy": "A String", # Optional. The policy to handle conflicts when migrating resources, defaults to SKIP if not specified. + "dryRun": True or False, # Optional. If true, performs discovery of requested resources and analysis against the target catalog to come up with a plan for each resource (e.g. Create, Update, Skip, etc.). No metadata is actually migrated. + "hiveConfig": { # Configuration for migrating Hive metadata. # Optional. At least one of hive_config or iceberg_config must be provided, otherwise, a validation error will be thrown. If only one is provided, the service only migrates tables of that specific type. If both are provided, both Hive and Iceberg tables will be migrated.Configuration for migrating Hive tables to a BigLake Hive catalog. + "catalog": "A String", # Required. The target catalog for migrated databases and tables. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" + "databases": [ # Required. The list of databases to migrate to the Hive catalog. Use "*" to migrate all databases. Note: If Iceberg tables exist in these databases, they will only be migrated if iceberg_config is also specified. + "A String", + ], + }, + "icebergConfig": { # Configuration for migrating Iceberg metadata. # Optional. Configuration for migrating Iceberg tables to a BigLake Iceberg REST catalog. + "catalog": "A String", # Required. The target catalog for migrated Iceberg metadata. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" + "namespaces": [ # Required. The list of namespaces to migrate to the Iceberg REST catalog. Use "*" to migrate all namespaces. Note: If Hive tables exist in these namespaces, they will only be migrated if hive_config is also specified. + "A String", + ], + }, + "mode": "A String", # Required. Defines the behavior of the migration execution. + "reportPath": "A String", # Optional. The Cloud Storage path where the backfill / dry run report should be written. If not provided, the report will be generated in the service's artifacts bucket. Format: "gs://path/to/folder" + }, "cloudSqlMigrationConfig": { # Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information for migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. # Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information specific to migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. "cdcConfig": { # Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. # Required. Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. Dataproc Metastore switches to using its backend database after the cutover phase of migration. "bucket": "A String", # Optional. The bucket to write the intermediate stream event data in. The bucket name must be without any prefix like "gs://". See the bucket naming requirements (https://cloud.google.com/storage/docs/buckets#naming). This field is optional. If not set, the Artifacts Cloud Storage bucket will be used. diff --git a/googleapiclient/discovery_cache/documents/metastore.v1.json b/googleapiclient/discovery_cache/documents/metastore.v1.json index 06f6018d14..b8273aaed5 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1.json @@ -1695,7 +1695,7 @@ } } }, -"revision": "20260427", +"revision": "20260716", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2926,7 +2926,8 @@ "SUCCEEDED", "FAILED", "CANCELLED", -"DELETING" +"DELETING", +"ROLLED_BACK" ], "enumDescriptions": [ "The state of the migration execution is unknown.", @@ -2937,7 +2938,8 @@ "The migration execution has completed successfully.", "The migration execution has failed.", "The migration execution is cancelled.", -"The migration execution is being deleted." +"The migration execution is being deleted.", +"The migration execution has been rolled back. This occurs when CancelMigration is invoked after the migration has completed and the metastore service is in the PROXY state, returning the service to the ACTIVE state. This enables rollback support when the customer wants to resume using DPMS after a successful migration." ], "readOnly": true, "type": "string" @@ -3442,7 +3444,8 @@ "DELETING", "ERROR", "AUTOSCALING", -"MIGRATING" +"MIGRATING", +"PROXY" ], "enumDescriptions": [ "The state of the metastore service is unknown.", @@ -3454,7 +3457,8 @@ "The metastore service is undergoing deletion. It cannot be used.", "The metastore service has encountered an error and cannot be used. The metastore service should be deleted.", "The Dataproc Metastore service 2 is being scaled up or down.", -"The metastore service is processing a managed migration." +"The metastore service is processing a managed migration.", +"The metastore service has completed managed migration and is now proxying requests to the Lakehouse runtime catalog." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json index 1f67098044..a8f7e4fbe8 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json @@ -1807,7 +1807,7 @@ } } }, -"revision": "20260427", +"revision": "20260723", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -1973,6 +1973,42 @@ }, "type": "object" }, +"BackfillStatus": { +"description": "Backfill status for the migration execution.", +"id": "BackfillStatus", +"properties": { +"migrationSummary": { +"$ref": "MigrationSummary", +"description": "Output only. Summary of the migration results. This is populated after the backfill or dry run is finished.", +"readOnly": true +}, +"reportPath": { +"description": "Output only. The Cloud Storage path where the backfill or dry run report is written. Format: \"gs://path-to-report\".", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The current state of the backfill (or dry run).", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The backfill state is unspecified.", +"Waiting to start.", +"Backfill in progress.", +"Backfill complete, report is available", +"Backfill failed; check report for details" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Backup": { "description": "The details of a backup resource.", "id": "Backup", @@ -2034,6 +2070,60 @@ }, "type": "object" }, +"BigLakeMetastoreMigrationConfig": { +"description": "Defines the configuration required to migrate metadata from a Dataproc Metastore service to BigLake Metastore.", +"id": "BigLakeMetastoreMigrationConfig", +"properties": { +"backfillStatus": { +"$ref": "BackfillStatus", +"description": "Output only. ", +"readOnly": true +}, +"conflictPolicy": { +"description": "Optional. The policy to handle conflicts when migrating resources, defaults to SKIP if not specified.", +"enum": [ +"CONFLICT_POLICY_UNSPECIFIED", +"SKIP", +"OVERWRITE" +], +"enumDescriptions": [ +"The conflict policy is unspecified.", +"Skip migrating resources that already exist in the target catalog.", +"Update resources that already exist in the target catalog." +], +"type": "string" +}, +"dryRun": { +"description": "Optional. If true, performs discovery of requested resources and analysis against the target catalog to come up with a plan for each resource (e.g. Create, Update, Skip, etc.). No metadata is actually migrated.", +"type": "boolean" +}, +"hiveConfig": { +"$ref": "HiveConfig", +"description": "Optional. At least one of hive_config or iceberg_config must be provided, otherwise, a validation error will be thrown. If only one is provided, the service only migrates tables of that specific type. If both are provided, both Hive and Iceberg tables will be migrated.Configuration for migrating Hive tables to a BigLake Hive catalog." +}, +"icebergConfig": { +"$ref": "IcebergConfig", +"description": "Optional. Configuration for migrating Iceberg tables to a BigLake Iceberg REST catalog." +}, +"mode": { +"description": "Required. Defines the behavior of the migration execution.", +"enum": [ +"MIGRATION_MODE_UNSPECIFIED", +"BACKFILL" +], +"enumDescriptions": [ +"The migration mode is unspecified.", +"Performs the metadata migration of requested resources. The migration completes once the backfill is finished." +], +"type": "string" +}, +"reportPath": { +"description": "Optional. The Cloud Storage path where the backfill / dry run report should be written. If not provided, the report will be generated in the service's artifacts bucket. Format: \"gs://path/to/folder\"", +"type": "string" +} +}, +"type": "object" +}, "Binding": { "description": "Associates members, or principals, with a role.", "id": "Binding", @@ -2079,6 +2169,41 @@ "properties": {}, "type": "object" }, +"CatalogSummary": { +"description": "Summary of results for a specific destination catalog.", +"id": "CatalogSummary", +"properties": { +"catalog": { +"description": "Output only. The catalog resource name (format: projects/*/catalogs/*).", +"readOnly": true, +"type": "string" +}, +"catalogType": { +"description": "Output only. The type of the catalog.", +"enum": [ +"CATALOG_TYPE_UNSPECIFIED", +"HIVE", +"ICEBERG" +], +"enumDescriptions": [ +"The catalog type is unspecified.", +"BigLake Metastore Hive catalog.", +"BigLake Metastore Iceberg REST catalog." +], +"readOnly": true, +"type": "string" +}, +"databaseSummaries": { +"description": "Output only. Summary of results for each database in the catalog.", +"items": { +"$ref": "DatabaseSummary" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "CdcConfig": { "description": "Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore.", "id": "CdcConfig", @@ -2309,6 +2434,61 @@ }, "type": "object" }, +"DatabaseSummary": { +"description": "Summary of results for a specific database in a catalog.", +"id": "DatabaseSummary", +"properties": { +"database": { +"description": "Output only. The name of the database.", +"readOnly": true, +"type": "string" +}, +"planAction": { +"description": "Output only. The migration plan action for the database.", +"enum": [ +"ACTION_UNSPECIFIED", +"CREATE", +"UPDATE", +"SKIP", +"DEPENDENCY_FAILURE", +"ERROR" +], +"enumDescriptions": [ +"The action is unspecified.", +"Resource missing; will be created.", +"Resource exists at the target, but differs from the source; will be updated.", +"Resource exists at the target; no changes will be made.", +"Resource cannot be migrated due to a dependency failure (e.g., parent resource missing).", +"Resource cannot be migrated due to an error during discovery." +], +"readOnly": true, +"type": "string" +}, +"resultStatus": { +"description": "Output only. The migration result status for the database. This is only set if the migration is not a dry run.", +"enum": [ +"STATE_UNSPECIFIED", +"SUCCEEDED", +"FAILED", +"SKIPPED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The resource was migrated successfully.", +"The resource failed to migrate.", +"The resource was skipped and will not be migrated." +], +"readOnly": true, +"type": "string" +}, +"tableSummary": { +"$ref": "TableSummary", +"description": "Output only. Aggregated summary of results for all tables in the database.", +"readOnly": true +} +}, +"type": "object" +}, "DataplexConfig": { "description": "Specifies how metastore metadata should be integrated with the Dataplex service.", "id": "DataplexConfig", @@ -2497,6 +2677,24 @@ }, "type": "object" }, +"HiveConfig": { +"description": "Configuration for migrating Hive metadata.", +"id": "HiveConfig", +"properties": { +"catalog": { +"description": "Required. The target catalog for migrated databases and tables. Format: \"projects/{project_id_or_number}/catalogs/{catalog_id}\"", +"type": "string" +}, +"databases": { +"description": "Required. The list of databases to migrate to the Hive catalog. Use \"*\" to migrate all databases. Note: If Iceberg tables exist in these databases, they will only be migrated if iceberg_config is also specified.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "HiveMetastoreConfig": { "description": "Specifies configuration information specific to running Hive metastore software as the metastore service.", "id": "HiveMetastoreConfig", @@ -2555,6 +2753,24 @@ }, "type": "object" }, +"IcebergConfig": { +"description": "Configuration for migrating Iceberg metadata.", +"id": "IcebergConfig", +"properties": { +"catalog": { +"description": "Required. The target catalog for migrated Iceberg metadata. Format: \"projects/{project_id_or_number}/catalogs/{catalog_id}\"", +"type": "string" +}, +"namespaces": { +"description": "Required. The list of namespaces to migrate to the Iceberg REST catalog. Use \"*\" to migrate all namespaces. Note: If Hive tables exist in these namespaces, they will only be migrated if hive_config is also specified.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "KerberosConfig": { "description": "Configuration information for a Kerberos principal.", "id": "KerberosConfig", @@ -3071,6 +3287,10 @@ "description": "The details of a migration execution resource.", "id": "MigrationExecution", "properties": { +"biglakeMetastoreMigrationConfig": { +"$ref": "BigLakeMetastoreMigrationConfig", +"description": "Configuration information specific to migrating from Dataproc Metastore to BigLake Metastore." +}, "cloudSqlMigrationConfig": { "$ref": "CloudSQLMigrationConfig", "deprecated": true, @@ -3120,7 +3340,8 @@ "SUCCEEDED", "FAILED", "CANCELLED", -"DELETING" +"DELETING", +"ROLLED_BACK" ], "enumDescriptions": [ "The state of the migration execution is unknown.", @@ -3131,7 +3352,8 @@ "The migration execution has completed successfully.", "The migration execution has failed.", "The migration execution is cancelled.", -"The migration execution is being deleted." +"The migration execution is being deleted.", +"The migration execution has been rolled back. This occurs when CancelMigration is invoked after the migration has completed and the metastore service is in the PROXY state, returning the service to the ACTIVE state. This enables rollback support when the customer wants to resume using DPMS after a successful migration." ], "readOnly": true, "type": "string" @@ -3144,6 +3366,37 @@ }, "type": "object" }, +"MigrationSummary": { +"description": "Summary of the migration results.", +"id": "MigrationSummary", +"properties": { +"catalogSummaries": { +"description": "Output only. Summary of results for each catalog involved in the migration.", +"items": { +"$ref": "CatalogSummary" +}, +"readOnly": true, +"type": "array" +}, +"createTime": { +"description": "Output only. The UTC time when this report was finalized.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dryRun": { +"description": "Output only. Whether the migration was a dry run.", +"readOnly": true, +"type": "boolean" +}, +"service": { +"description": "Output only. The Dataproc Metastore service name (format: projects/*/locations/*/services/*) on which the migration was executed.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "MoveTableToDatabaseRequest": { "description": "Request message for DataprocMetastore.MoveTableToDatabase.", "id": "MoveTableToDatabaseRequest", @@ -3708,7 +3961,8 @@ "DELETING", "ERROR", "AUTOSCALING", -"MIGRATING" +"MIGRATING", +"PROXY" ], "enumDescriptions": [ "The state of the metastore service is unknown.", @@ -3720,7 +3974,8 @@ "The metastore service is undergoing deletion. It cannot be used.", "The metastore service has encountered an error and cannot be used. The metastore service should be deleted.", "The Dataproc Metastore service 2 is being scaled up or down.", -"The metastore service is processing a managed migration." +"The metastore service is processing a managed migration.", +"The metastore service has completed managed migration and is now proxying requests to the Lakehouse runtime catalog." ], "readOnly": true, "type": "string" @@ -3856,6 +4111,49 @@ }, "type": "object" }, +"TableSummary": { +"description": "Aggregated summary of results for all tables in a database.", +"id": "TableSummary", +"properties": { +"partitionDiscoveredCount": { +"description": "Output only. Partition migration summary across all Hive tables in the database.The total number of partitions discovered at the source.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"partitionFailedCount": { +"description": "Output only. The total number of partitions that failed to migrate at the target.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"partitionSuccessCount": { +"description": "Output only. The total number of partitions successfully migrated at the target.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"planCounts": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Output only. Number of tables with a specific migration plan action. The key is the action name (e.g. CREATE, UPDATE, SKIP, etc.).", +"readOnly": true, +"type": "object" +}, +"resultCounts": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Output only. Number of tables with a specific migration result status. The key is the status name (e.g. SUCCEEDED, FAILED, SKIPPED, etc.). This is only set if the migration is not a dry run.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, "TelemetryConfig": { "description": "Telemetry Configuration for the Dataproc Metastore service.", "id": "TelemetryConfig", diff --git a/googleapiclient/discovery_cache/documents/metastore.v1beta.json b/googleapiclient/discovery_cache/documents/metastore.v1beta.json index 299537a12b..916e1f53d4 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1beta.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1beta.json @@ -1807,7 +1807,7 @@ } } }, -"revision": "20260427", +"revision": "20260723", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -1973,6 +1973,42 @@ }, "type": "object" }, +"BackfillStatus": { +"description": "Backfill status for the migration execution.", +"id": "BackfillStatus", +"properties": { +"migrationSummary": { +"$ref": "MigrationSummary", +"description": "Output only. Summary of the migration results. This is populated after the backfill or dry run is finished.", +"readOnly": true +}, +"reportPath": { +"description": "Output only. The Cloud Storage path where the backfill or dry run report is written. Format: \"gs://path-to-report\".", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The current state of the backfill (or dry run).", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The backfill state is unspecified.", +"Waiting to start.", +"Backfill in progress.", +"Backfill complete, report is available", +"Backfill failed; check report for details" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Backup": { "description": "The details of a backup resource.", "id": "Backup", @@ -2034,6 +2070,60 @@ }, "type": "object" }, +"BigLakeMetastoreMigrationConfig": { +"description": "Defines the configuration required to migrate metadata from a Dataproc Metastore service to BigLake Metastore.", +"id": "BigLakeMetastoreMigrationConfig", +"properties": { +"backfillStatus": { +"$ref": "BackfillStatus", +"description": "Output only. ", +"readOnly": true +}, +"conflictPolicy": { +"description": "Optional. The policy to handle conflicts when migrating resources, defaults to SKIP if not specified.", +"enum": [ +"CONFLICT_POLICY_UNSPECIFIED", +"SKIP", +"OVERWRITE" +], +"enumDescriptions": [ +"The conflict policy is unspecified.", +"Skip migrating resources that already exist in the target catalog.", +"Update resources that already exist in the target catalog." +], +"type": "string" +}, +"dryRun": { +"description": "Optional. If true, performs discovery of requested resources and analysis against the target catalog to come up with a plan for each resource (e.g. Create, Update, Skip, etc.). No metadata is actually migrated.", +"type": "boolean" +}, +"hiveConfig": { +"$ref": "HiveConfig", +"description": "Optional. At least one of hive_config or iceberg_config must be provided, otherwise, a validation error will be thrown. If only one is provided, the service only migrates tables of that specific type. If both are provided, both Hive and Iceberg tables will be migrated.Configuration for migrating Hive tables to a BigLake Hive catalog." +}, +"icebergConfig": { +"$ref": "IcebergConfig", +"description": "Optional. Configuration for migrating Iceberg tables to a BigLake Iceberg REST catalog." +}, +"mode": { +"description": "Required. Defines the behavior of the migration execution.", +"enum": [ +"MIGRATION_MODE_UNSPECIFIED", +"BACKFILL" +], +"enumDescriptions": [ +"The migration mode is unspecified.", +"Performs the metadata migration of requested resources. The migration completes once the backfill is finished." +], +"type": "string" +}, +"reportPath": { +"description": "Optional. The Cloud Storage path where the backfill / dry run report should be written. If not provided, the report will be generated in the service's artifacts bucket. Format: \"gs://path/to/folder\"", +"type": "string" +} +}, +"type": "object" +}, "Binding": { "description": "Associates members, or principals, with a role.", "id": "Binding", @@ -2079,6 +2169,41 @@ "properties": {}, "type": "object" }, +"CatalogSummary": { +"description": "Summary of results for a specific destination catalog.", +"id": "CatalogSummary", +"properties": { +"catalog": { +"description": "Output only. The catalog resource name (format: projects/*/catalogs/*).", +"readOnly": true, +"type": "string" +}, +"catalogType": { +"description": "Output only. The type of the catalog.", +"enum": [ +"CATALOG_TYPE_UNSPECIFIED", +"HIVE", +"ICEBERG" +], +"enumDescriptions": [ +"The catalog type is unspecified.", +"BigLake Metastore Hive catalog.", +"BigLake Metastore Iceberg REST catalog." +], +"readOnly": true, +"type": "string" +}, +"databaseSummaries": { +"description": "Output only. Summary of results for each database in the catalog.", +"items": { +"$ref": "DatabaseSummary" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "CdcConfig": { "description": "Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore.", "id": "CdcConfig", @@ -2309,6 +2434,61 @@ }, "type": "object" }, +"DatabaseSummary": { +"description": "Summary of results for a specific database in a catalog.", +"id": "DatabaseSummary", +"properties": { +"database": { +"description": "Output only. The name of the database.", +"readOnly": true, +"type": "string" +}, +"planAction": { +"description": "Output only. The migration plan action for the database.", +"enum": [ +"ACTION_UNSPECIFIED", +"CREATE", +"UPDATE", +"SKIP", +"DEPENDENCY_FAILURE", +"ERROR" +], +"enumDescriptions": [ +"The action is unspecified.", +"Resource missing; will be created.", +"Resource exists at the target, but differs from the source; will be updated.", +"Resource exists at the target; no changes will be made.", +"Resource cannot be migrated due to a dependency failure (e.g., parent resource missing).", +"Resource cannot be migrated due to an error during discovery." +], +"readOnly": true, +"type": "string" +}, +"resultStatus": { +"description": "Output only. The migration result status for the database. This is only set if the migration is not a dry run.", +"enum": [ +"STATE_UNSPECIFIED", +"SUCCEEDED", +"FAILED", +"SKIPPED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The resource was migrated successfully.", +"The resource failed to migrate.", +"The resource was skipped and will not be migrated." +], +"readOnly": true, +"type": "string" +}, +"tableSummary": { +"$ref": "TableSummary", +"description": "Output only. Aggregated summary of results for all tables in the database.", +"readOnly": true +} +}, +"type": "object" +}, "DataplexConfig": { "description": "Specifies how metastore metadata should be integrated with the Dataplex service.", "id": "DataplexConfig", @@ -2497,6 +2677,24 @@ }, "type": "object" }, +"HiveConfig": { +"description": "Configuration for migrating Hive metadata.", +"id": "HiveConfig", +"properties": { +"catalog": { +"description": "Required. The target catalog for migrated databases and tables. Format: \"projects/{project_id_or_number}/catalogs/{catalog_id}\"", +"type": "string" +}, +"databases": { +"description": "Required. The list of databases to migrate to the Hive catalog. Use \"*\" to migrate all databases. Note: If Iceberg tables exist in these databases, they will only be migrated if iceberg_config is also specified.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "HiveMetastoreConfig": { "description": "Specifies configuration information specific to running Hive metastore software as the metastore service.", "id": "HiveMetastoreConfig", @@ -2555,6 +2753,24 @@ }, "type": "object" }, +"IcebergConfig": { +"description": "Configuration for migrating Iceberg metadata.", +"id": "IcebergConfig", +"properties": { +"catalog": { +"description": "Required. The target catalog for migrated Iceberg metadata. Format: \"projects/{project_id_or_number}/catalogs/{catalog_id}\"", +"type": "string" +}, +"namespaces": { +"description": "Required. The list of namespaces to migrate to the Iceberg REST catalog. Use \"*\" to migrate all namespaces. Note: If Hive tables exist in these namespaces, they will only be migrated if hive_config is also specified.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "KerberosConfig": { "description": "Configuration information for a Kerberos principal.", "id": "KerberosConfig", @@ -3071,6 +3287,10 @@ "description": "The details of a migration execution resource.", "id": "MigrationExecution", "properties": { +"biglakeMetastoreMigrationConfig": { +"$ref": "BigLakeMetastoreMigrationConfig", +"description": "Configuration information specific to migrating from Dataproc Metastore to BigLake Metastore." +}, "cloudSqlMigrationConfig": { "$ref": "CloudSQLMigrationConfig", "deprecated": true, @@ -3120,7 +3340,8 @@ "SUCCEEDED", "FAILED", "CANCELLED", -"DELETING" +"DELETING", +"ROLLED_BACK" ], "enumDescriptions": [ "The state of the migration execution is unknown.", @@ -3131,7 +3352,8 @@ "The migration execution has completed successfully.", "The migration execution has failed.", "The migration execution is cancelled.", -"The migration execution is being deleted." +"The migration execution is being deleted.", +"The migration execution has been rolled back. This occurs when CancelMigration is invoked after the migration has completed and the metastore service is in the PROXY state, returning the service to the ACTIVE state. This enables rollback support when the customer wants to resume using DPMS after a successful migration." ], "readOnly": true, "type": "string" @@ -3144,6 +3366,37 @@ }, "type": "object" }, +"MigrationSummary": { +"description": "Summary of the migration results.", +"id": "MigrationSummary", +"properties": { +"catalogSummaries": { +"description": "Output only. Summary of results for each catalog involved in the migration.", +"items": { +"$ref": "CatalogSummary" +}, +"readOnly": true, +"type": "array" +}, +"createTime": { +"description": "Output only. The UTC time when this report was finalized.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dryRun": { +"description": "Output only. Whether the migration was a dry run.", +"readOnly": true, +"type": "boolean" +}, +"service": { +"description": "Output only. The Dataproc Metastore service name (format: projects/*/locations/*/services/*) on which the migration was executed.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "MoveTableToDatabaseRequest": { "description": "Request message for DataprocMetastore.MoveTableToDatabase.", "id": "MoveTableToDatabaseRequest", @@ -3708,7 +3961,8 @@ "DELETING", "ERROR", "AUTOSCALING", -"MIGRATING" +"MIGRATING", +"PROXY" ], "enumDescriptions": [ "The state of the metastore service is unknown.", @@ -3720,7 +3974,8 @@ "The metastore service is undergoing deletion. It cannot be used.", "The metastore service has encountered an error and cannot be used. The metastore service should be deleted.", "The Dataproc Metastore service 2 is being scaled up or down.", -"The metastore service is processing a managed migration." +"The metastore service is processing a managed migration.", +"The metastore service has completed managed migration and is now proxying requests to the Lakehouse runtime catalog." ], "readOnly": true, "type": "string" @@ -3856,6 +4111,49 @@ }, "type": "object" }, +"TableSummary": { +"description": "Aggregated summary of results for all tables in a database.", +"id": "TableSummary", +"properties": { +"partitionDiscoveredCount": { +"description": "Output only. Partition migration summary across all Hive tables in the database.The total number of partitions discovered at the source.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"partitionFailedCount": { +"description": "Output only. The total number of partitions that failed to migrate at the target.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"partitionSuccessCount": { +"description": "Output only. The total number of partitions successfully migrated at the target.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"planCounts": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Output only. Number of tables with a specific migration plan action. The key is the action name (e.g. CREATE, UPDATE, SKIP, etc.).", +"readOnly": true, +"type": "object" +}, +"resultCounts": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Output only. Number of tables with a specific migration result status. The key is the status name (e.g. SUCCEEDED, FAILED, SKIPPED, etc.). This is only set if the migration is not a dry run.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, "TelemetryConfig": { "description": "Telemetry Configuration for the Dataproc Metastore service.", "id": "TelemetryConfig", From db9e8a6e3abb5a9d58dc208617f9e834a0e73310 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:06 +0000 Subject: [PATCH 62/84] feat(netapp): update the api #### netapp:v1 The following keys were deleted: - schemas.BackupVault.properties.sourceRegion.readOnly (Total Keys: 1) The following keys were added: - resources.projects.resources.locations.resources.volumes.methods.getSplitStatus (Total Keys: 11) - resources.projects.resources.locations.resources.volumes.methods.startSplit (Total Keys: 12) - schemas.CloneDetails.properties.splitState (Total Keys: 2) - schemas.SplitStatus (Total Keys: 9) - schemas.StartSplitRequest (Total Keys: 2) #### netapp:v1beta1 The following keys were deleted: - schemas.BackupVault.properties.sourceRegion.readOnly (Total Keys: 1) --- ...pp_v1.projects.locations.backupVaults.html | 8 +- .../netapp_v1.projects.locations.volumes.html | 72 +++++++++++ ...beta1.projects.locations.backupVaults.html | 8 +- .../discovery_cache/documents/netapp.v1.json | 116 +++++++++++++++++- .../documents/netapp.v1beta1.json | 5 +- 5 files changed, 195 insertions(+), 14 deletions(-) diff --git a/docs/dyn/netapp_v1.projects.locations.backupVaults.html b/docs/dyn/netapp_v1.projects.locations.backupVaults.html index 78410c2032..028830bef4 100644 --- a/docs/dyn/netapp_v1.projects.locations.backupVaults.html +++ b/docs/dyn/netapp_v1.projects.locations.backupVaults.html @@ -136,7 +136,7 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. "sourceBackupVault": "A String", # Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` - "sourceRegion": "A String", # Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` + "sourceRegion": "A String", # Optional. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` "state": "A String", # Output only. The backup vault state. } @@ -240,7 +240,7 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. "sourceBackupVault": "A String", # Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` - "sourceRegion": "A String", # Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` + "sourceRegion": "A String", # Optional. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` "state": "A String", # Output only. The backup vault state. }
@@ -286,7 +286,7 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. "sourceBackupVault": "A String", # Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` - "sourceRegion": "A String", # Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` + "sourceRegion": "A String", # Optional. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` "state": "A String", # Output only. The backup vault state. }, ], @@ -341,7 +341,7 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. "sourceBackupVault": "A String", # Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` - "sourceRegion": "A String", # Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` + "sourceRegion": "A String", # Optional. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` "state": "A String", # Output only. The backup vault state. } diff --git a/docs/dyn/netapp_v1.projects.locations.volumes.html b/docs/dyn/netapp_v1.projects.locations.volumes.html index 5a5a76f6bf..c1a024c8bf 100644 --- a/docs/dyn/netapp_v1.projects.locations.volumes.html +++ b/docs/dyn/netapp_v1.projects.locations.volumes.html @@ -104,6 +104,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single Volume.

+

+ getSplitStatus(name, x__xgafv=None)

+

Retrieves the current state, progress, and details of a split operation for a volume. This method is relevant when the volume is a clone. For volumes that are not clones, this method will return an error.

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

Lists Volumes in a given project.

@@ -119,6 +122,9 @@

Instance Methods

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

Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.

+

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

+

Splits a clone volume from its source volume. This operation will only work for volumes which have clone_details set(clones). For volumes that are not clones, this operation will return an error.

Method Details

close() @@ -188,6 +194,7 @@

Method Details

"sharedSpaceGib": "A String", # Output only. Shared space in GiB. Determined at volume creation time based on size of source snapshot. "sourceSnapshot": "A String", # Output only. Specifies the full resource name of the source snapshot from which this volume was cloned. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot} "sourceVolume": "A String", # Output only. Full name of the source volume resource. Format: projects/{project}/locations/{location}/volumes/{volume} + "splitState": "A String", # Output only. The current state of the clone split operation. }, "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data rounded down to the nearest GiB. "createTime": "A String", # Output only. Create time of the volume @@ -492,6 +499,7 @@

Method Details

"sharedSpaceGib": "A String", # Output only. Shared space in GiB. Determined at volume creation time based on size of source snapshot. "sourceSnapshot": "A String", # Output only. Specifies the full resource name of the source snapshot from which this volume was cloned. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot} "sourceVolume": "A String", # Output only. Full name of the source volume resource. Format: projects/{project}/locations/{location}/volumes/{volume} + "splitState": "A String", # Output only. The current state of the clone split operation. }, "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data rounded down to the nearest GiB. "createTime": "A String", # Output only. Create time of the volume @@ -616,6 +624,27 @@

Method Details

}
+
+ getSplitStatus(name, x__xgafv=None) +
Retrieves the current state, progress, and details of a split operation for a volume. This method is relevant when the volume is a clone. For volumes that are not clones, this method will return an error.
+
+Args:
+  name: string, Required. The full name of the volume. Format: projects/{project_number}/locations/{location}/volumes/{volume_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for SplitStatus.
+  "progressPercent": 42, # Output only. The estimated progress percentage of the split operation (0-100). This is meaningful primarily when split_state is IN_PROGRESS.
+  "splitState": "A String", # Output only. The current state of the clone split operation.
+  "stateDetails": "A String", # Output only. Human-readable details about the current state. Mostly used for displaying error messages during split failure Examples: "Split in progress", "Error: insufficient capacity".
+}
+
+
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Volumes in a given project.
@@ -694,6 +723,7 @@ 

Method Details

"sharedSpaceGib": "A String", # Output only. Shared space in GiB. Determined at volume creation time based on size of source snapshot. "sourceSnapshot": "A String", # Output only. Specifies the full resource name of the source snapshot from which this volume was cloned. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot} "sourceVolume": "A String", # Output only. Full name of the source volume resource. Format: projects/{project}/locations/{location}/volumes/{volume} + "splitState": "A String", # Output only. The current state of the clone split operation. }, "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data rounded down to the nearest GiB. "createTime": "A String", # Output only. Create time of the volume @@ -897,6 +927,7 @@

Method Details

"sharedSpaceGib": "A String", # Output only. Shared space in GiB. Determined at volume creation time based on size of source snapshot. "sourceSnapshot": "A String", # Output only. Specifies the full resource name of the source snapshot from which this volume was cloned. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot} "sourceVolume": "A String", # Output only. Full name of the source volume resource. Format: projects/{project}/locations/{location}/volumes/{volume} + "splitState": "A String", # Output only. The current state of the clone split operation. }, "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data rounded down to the nearest GiB. "createTime": "A String", # Output only. Create time of the volume @@ -1138,4 +1169,45 @@

Method Details

}
+
+ startSplit(name, body=None, x__xgafv=None) +
Splits a clone volume from its source volume. This operation will only work for volumes which have clone_details set(clones). For volumes that are not clones, this operation will return an error.
+
+Args:
+  name: string, Required. The full name of the clone volume to be split from its source. Format: projects/{project_number}/locations/{location}/volumes/{volume_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for splitting a volume.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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/netapp_v1beta1.projects.locations.backupVaults.html b/docs/dyn/netapp_v1beta1.projects.locations.backupVaults.html index 88b259638c..9d96316ef1 100644 --- a/docs/dyn/netapp_v1beta1.projects.locations.backupVaults.html +++ b/docs/dyn/netapp_v1beta1.projects.locations.backupVaults.html @@ -137,7 +137,7 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. "sourceBackupVault": "A String", # Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` - "sourceRegion": "A String", # Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` + "sourceRegion": "A String", # Optional. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` "state": "A String", # Output only. The backup vault state. } @@ -242,7 +242,7 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. "sourceBackupVault": "A String", # Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` - "sourceRegion": "A String", # Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` + "sourceRegion": "A String", # Optional. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` "state": "A String", # Output only. The backup vault state. }
@@ -289,7 +289,7 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. "sourceBackupVault": "A String", # Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` - "sourceRegion": "A String", # Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` + "sourceRegion": "A String", # Optional. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` "state": "A String", # Output only. The backup vault state. }, ], @@ -345,7 +345,7 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`. "sourceBackupVault": "A String", # Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` - "sourceRegion": "A String", # Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` + "sourceRegion": "A String", # Optional. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}` "state": "A String", # Output only. The backup vault state. } diff --git a/googleapiclient/discovery_cache/documents/netapp.v1.json b/googleapiclient/discovery_cache/documents/netapp.v1.json index 3a47ae16c1..b2ee816fde 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1.json @@ -2147,6 +2147,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getSplitStatus": { +"description": "Retrieves the current state, progress, and details of a split operation for a volume. This method is relevant when the volume is a clone. For volumes that are not clones, this method will return an error.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:getSplitStatus", +"httpMethod": "GET", +"id": "netapp.projects.locations.volumes.getSplitStatus", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The full name of the volume. Format: projects/{project_number}/locations/{location}/volumes/{volume_id}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:getSplitStatus", +"response": { +"$ref": "SplitStatus" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists Volumes in a given project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes", @@ -2282,6 +2307,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"startSplit": { +"description": "Splits a clone volume from its source volume. This operation will only work for volumes which have clone_details set(clones). For volumes that are not clones, this operation will return an error.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:startSplit", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.startSplit", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The full name of the clone volume to be split from its source. Format: projects/{project_number}/locations/{location}/volumes/{volume_id}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:startSplit", +"request": { +"$ref": "StartSplitRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -2933,7 +2986,7 @@ } } }, -"revision": "20260628", +"revision": "20260719", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3417,8 +3470,7 @@ "type": "string" }, "sourceRegion": { -"description": "Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}`", -"readOnly": true, +"description": "Optional. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}`", "type": "string" }, "state": { @@ -3650,6 +3702,23 @@ "description": "Output only. Full name of the source volume resource. Format: projects/{project}/locations/{location}/volumes/{volume}", "readOnly": true, "type": "string" +}, +"splitState": { +"description": "Output only. The current state of the clone split operation.", +"enum": [ +"SPLIT_STATE_UNSPECIFIED", +"SPLIT_STATE_NOT_SPLITTING", +"SPLIT_STATE_IN_PROGRESS", +"SPLIT_STATE_FAILED" +], +"enumDescriptions": [ +"State is not specified.", +"The volume is a thin clone, sharing blocks with its source.", +"A split operation is currently active and in progress.", +"The attempt to split the volume failed." +], +"readOnly": true, +"type": "string" } }, "type": "object" @@ -5327,6 +5396,47 @@ }, "type": "object" }, +"SplitStatus": { +"description": "Message for SplitStatus.", +"id": "SplitStatus", +"properties": { +"progressPercent": { +"description": "Output only. The estimated progress percentage of the split operation (0-100). This is meaningful primarily when split_state is IN_PROGRESS.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"splitState": { +"description": "Output only. The current state of the clone split operation.", +"enum": [ +"SPLIT_STATE_UNSPECIFIED", +"SPLIT_STATE_NOT_SPLITTING", +"SPLIT_STATE_IN_PROGRESS", +"SPLIT_STATE_FAILED" +], +"enumDescriptions": [ +"State is not specified.", +"The volume is a thin clone, sharing blocks with its source.", +"A split operation is currently active and in progress.", +"The attempt to split the volume failed." +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"description": "Output only. Human-readable details about the current state. Mostly used for displaying error messages during split failure Examples: \"Split in progress\", \"Error: insufficient capacity\".", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"StartSplitRequest": { +"description": "Request message for splitting a volume.", +"id": "StartSplitRequest", +"properties": {}, +"type": "object" +}, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", diff --git a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json index ff432957c5..e751931cb5 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json @@ -3003,7 +3003,7 @@ } } }, -"revision": "20260628", +"revision": "20260719", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3491,8 +3491,7 @@ "type": "string" }, "sourceRegion": { -"description": "Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}`", -"readOnly": true, +"description": "Optional. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}`", "type": "string" }, "state": { From 932f28bebcd5ce821126d4c0c4ce32580724692e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:06 +0000 Subject: [PATCH 63/84] feat(networkconnectivity): update the api #### networkconnectivity:v1 The following keys were added: - resources.projects.resources.locations.resources.pscAuthorizationPolicies.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.pscAuthorizationPolicies.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.pscAuthorizationPolicies.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.pscAuthorizationPolicies.methods.list (Total Keys: 20) - schemas.ListPscAuthorizationPoliciesResponse (Total Keys: 7) - schemas.PscAuthorizationPolicy (Total Keys: 17) --- ...orkconnectivity_v1.projects.locations.html | 5 + ...ts.locations.pscAuthorizationPolicies.html | 285 ++++++++++++++++++ ...jects.locations.serviceConnectionMaps.html | 8 +- ...s.locations.serviceConnectionPolicies.html | 8 +- .../documents/networkconnectivity.v1.json | 243 ++++++++++++++- 5 files changed, 539 insertions(+), 10 deletions(-) create mode 100644 docs/dyn/networkconnectivity_v1.projects.locations.pscAuthorizationPolicies.html diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.html b/docs/dyn/networkconnectivity_v1.projects.locations.html index 40b0d1100c..98627f6db8 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.html @@ -104,6 +104,11 @@

Instance Methods

Returns the operations Resource.

+

+ pscAuthorizationPolicies() +

+

Returns the pscAuthorizationPolicies Resource.

+

regionalEndpoints()

diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.pscAuthorizationPolicies.html b/docs/dyn/networkconnectivity_v1.projects.locations.pscAuthorizationPolicies.html new file mode 100644 index 0000000000..fa5f2b2e34 --- /dev/null +++ b/docs/dyn/networkconnectivity_v1.projects.locations.pscAuthorizationPolicies.html @@ -0,0 +1,285 @@ + + + +

Network Connectivity API . projects . locations . pscAuthorizationPolicies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, pscAuthorizationPolicyId=None, requestId=None, x__xgafv=None)

+

Creates a new PscAuthorizationPolicy in a given project and location.

+

+ delete(name, etag=None, requestId=None, x__xgafv=None)

+

Deletes a single PscAuthorizationPolicy.

+

+ get(name, x__xgafv=None)

+

Gets details of a single PscAuthorizationPolicy.

+

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

+

Lists PscAuthorizationPolicies in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, pscAuthorizationPolicyId=None, requestId=None, x__xgafv=None) +
Creates a new PscAuthorizationPolicy in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource's name of the PscAuthorizationPolicy. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a PSC Authorization Policy.
+  "authorizationMode": "A String", # Required. The authorization mode.
+  "authorizedClientResources": [ # Required. List of authorized consumer resources allowed to connect. Supported values are: 1. Project resource name (e.g., `projects/{project_id}`) 2. Wildcard `"*"` (grants global ingress authorization to the target).
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The time when the PscAuthorizationPolicy was created.
+  "description": "A String", # Optional. A description of this resource.
+  "etag": "A String", # Output only. The etag of the PscAuthorizationPolicy.
+  "labels": { # Optional. User-defined labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The name of the PscAuthorizationPolicy. Format: projects/{project}/locations/{location}/pscAuthorizationPolicies/{psc_authorization_policy}
+  "targetResourceUri": "A String", # Required. The full absolute URI of the targeted resource governed by this policy. For example, for an AgentRegistry resource, the format is: `//agentregistry.googleapis.com/projects/{project}/locations/{location}`
+  "uid": "A String", # Output only. The unique identifier of the PscAuthorizationPolicy.
+  "updateTime": "A String", # Output only. The time when the PscAuthorizationPolicy was updated.
+}
+
+  pscAuthorizationPolicyId: string, Required. Resource ID of the PscAuthorizationPolicy.
+  requestId: string, Optional. An optional request ID to identify requests.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, etag=None, requestId=None, x__xgafv=None) +
Deletes a single PscAuthorizationPolicy.
+
+Args:
+  name: string, Required. The name of the PscAuthorizationPolicy to delete. (required)
+  etag: string, Optional. The etag of the PscAuthorizationPolicy to delete.
+  requestId: string, Optional. An optional request ID to identify requests.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single PscAuthorizationPolicy.
+
+Args:
+  name: string, Required. Name of the PscAuthorizationPolicy to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a PSC Authorization Policy.
+  "authorizationMode": "A String", # Required. The authorization mode.
+  "authorizedClientResources": [ # Required. List of authorized consumer resources allowed to connect. Supported values are: 1. Project resource name (e.g., `projects/{project_id}`) 2. Wildcard `"*"` (grants global ingress authorization to the target).
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The time when the PscAuthorizationPolicy was created.
+  "description": "A String", # Optional. A description of this resource.
+  "etag": "A String", # Output only. The etag of the PscAuthorizationPolicy.
+  "labels": { # Optional. User-defined labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The name of the PscAuthorizationPolicy. Format: projects/{project}/locations/{location}/pscAuthorizationPolicies/{psc_authorization_policy}
+  "targetResourceUri": "A String", # Required. The full absolute URI of the targeted resource governed by this policy. For example, for an AgentRegistry resource, the format is: `//agentregistry.googleapis.com/projects/{project}/locations/{location}`
+  "uid": "A String", # Output only. The unique identifier of the PscAuthorizationPolicy.
+  "updateTime": "A String", # Output only. The time when the PscAuthorizationPolicy was updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists PscAuthorizationPolicies in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource's name. (required)
+  filter: string, Optional. Filter expression to restrict the results.
+  orderBy: string, Optional. Sort order of the results.
+  pageSize: integer, Optional. The maximum number of PscAuthorizationPolicies to return in a single page. The service may return fewer than this value. If unspecified, at most 50 PscAuthorizationPolicies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. A page token, received from a previous `ListPscAuthorizationPolicies` call.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListPscAuthorizationPolicies.
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page.
+  "pscAuthorizationPolicies": [ # The list of PscAuthorizationPolicies.
+    { # Represents a PSC Authorization Policy.
+      "authorizationMode": "A String", # Required. The authorization mode.
+      "authorizedClientResources": [ # Required. List of authorized consumer resources allowed to connect. Supported values are: 1. Project resource name (e.g., `projects/{project_id}`) 2. Wildcard `"*"` (grants global ingress authorization to the target).
+        "A String",
+      ],
+      "createTime": "A String", # Output only. The time when the PscAuthorizationPolicy was created.
+      "description": "A String", # Optional. A description of this resource.
+      "etag": "A String", # Output only. The etag of the PscAuthorizationPolicy.
+      "labels": { # Optional. User-defined labels.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The name of the PscAuthorizationPolicy. Format: projects/{project}/locations/{location}/pscAuthorizationPolicies/{psc_authorization_policy}
+      "targetResourceUri": "A String", # Required. The full absolute URI of the targeted resource governed by this policy. For example, for an AgentRegistry resource, the format is: `//agentregistry.googleapis.com/projects/{project}/locations/{location}`
+      "uid": "A String", # Output only. The unique identifier of the PscAuthorizationPolicy.
+      "updateTime": "A String", # Output only. The time when the PscAuthorizationPolicy was updated.
+    },
+  ],
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionMaps.html b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionMaps.html index 5c6d6466a1..ab41f023fd 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionMaps.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionMaps.html @@ -157,7 +157,7 @@

Method Details

"metadata": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, - "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + "reason": "A String", # The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, "errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal. "forwardingRule": "A String", # The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}. @@ -329,7 +329,7 @@

Method Details

"metadata": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, - "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + "reason": "A String", # The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, "errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal. "forwardingRule": "A String", # The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}. @@ -441,7 +441,7 @@

Method Details

"metadata": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, - "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + "reason": "A String", # The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, "errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal. "forwardingRule": "A String", # The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}. @@ -560,7 +560,7 @@

Method Details

"metadata": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, - "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + "reason": "A String", # The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, "errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal. "forwardingRule": "A String", # The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}. diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html index cca7d323bb..525d9ebfdb 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html @@ -156,7 +156,7 @@

Method Details

"metadata": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, - "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + "reason": "A String", # The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, "errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal. "gceOperation": "A String", # The last Compute Engine operation to setup PSC connection. @@ -316,7 +316,7 @@

Method Details

"metadata": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, - "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + "reason": "A String", # The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, "errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal. "gceOperation": "A String", # The last Compute Engine operation to setup PSC connection. @@ -403,7 +403,7 @@

Method Details

"metadata": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, - "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + "reason": "A String", # The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, "errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal. "gceOperation": "A String", # The last Compute Engine operation to setup PSC connection. @@ -497,7 +497,7 @@

Method Details

"metadata": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, - "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + "reason": "A String", # The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, "errorType": "A String", # The error type indicates whether the error is consumer facing, producer facing or system internal. "gceOperation": "A String", # The last Compute Engine operation to setup PSC connection. diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json index 04d9305f42..9eae29615d 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json @@ -2325,6 +2325,154 @@ } } }, +"pscAuthorizationPolicies": { +"methods": { +"create": { +"description": "Creates a new PscAuthorizationPolicy in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pscAuthorizationPolicies", +"httpMethod": "POST", +"id": "networkconnectivity.projects.locations.pscAuthorizationPolicies.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource's name of the PscAuthorizationPolicy.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"pscAuthorizationPolicyId": { +"description": "Required. Resource ID of the PscAuthorizationPolicy.", +"location": "query", +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/pscAuthorizationPolicies", +"request": { +"$ref": "PscAuthorizationPolicy" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single PscAuthorizationPolicy.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pscAuthorizationPolicies/{pscAuthorizationPoliciesId}", +"httpMethod": "DELETE", +"id": "networkconnectivity.projects.locations.pscAuthorizationPolicies.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "Optional. The etag of the PscAuthorizationPolicy to delete.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the PscAuthorizationPolicy to delete.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/pscAuthorizationPolicies/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single PscAuthorizationPolicy.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pscAuthorizationPolicies/{pscAuthorizationPoliciesId}", +"httpMethod": "GET", +"id": "networkconnectivity.projects.locations.pscAuthorizationPolicies.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the PscAuthorizationPolicy to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/pscAuthorizationPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "PscAuthorizationPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists PscAuthorizationPolicies in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pscAuthorizationPolicies", +"httpMethod": "GET", +"id": "networkconnectivity.projects.locations.pscAuthorizationPolicies.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter expression to restrict the results.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Sort order of the results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of PscAuthorizationPolicies to return in a single page. The service may return fewer than this value. If unspecified, at most 50 PscAuthorizationPolicies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListPscAuthorizationPolicies` call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/pscAuthorizationPolicies", +"response": { +"$ref": "ListPscAuthorizationPoliciesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "regionalEndpoints": { "methods": { "create": { @@ -3898,7 +4046,7 @@ } } }, -"revision": "20260618", +"revision": "20260715", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -4934,7 +5082,7 @@ "type": "object" }, "reason": { -"description": "The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", +"description": "The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", "type": "string" } }, @@ -5854,6 +6002,31 @@ }, "type": "object" }, +"ListPscAuthorizationPoliciesResponse": { +"description": "Response for ListPscAuthorizationPolicies.", +"id": "ListPscAuthorizationPoliciesResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page.", +"type": "string" +}, +"pscAuthorizationPolicies": { +"description": "The list of PscAuthorizationPolicies.", +"items": { +"$ref": "PscAuthorizationPolicy" +}, +"type": "array" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListRegionalEndpointsResponse": { "description": "Response for ListRegionalEndpoints.", "id": "ListRegionalEndpointsResponse", @@ -6523,6 +6696,72 @@ }, "type": "object" }, +"PscAuthorizationPolicy": { +"description": "Represents a PSC Authorization Policy.", +"id": "PscAuthorizationPolicy", +"properties": { +"authorizationMode": { +"description": "Required. The authorization mode.", +"enum": [ +"AUTHORIZATION_MODE_UNSPECIFIED", +"AUTHORIZATION_MODE_TRANSITIVE_TO_SERVICE_ATTACHMENT" +], +"enumDescriptions": [ +"Default value.", +"In this mode, authorization is determined by the permissions on the underlying Service Attachment." +], +"type": "string" +}, +"authorizedClientResources": { +"description": "Required. List of authorized consumer resources allowed to connect. Supported values are: 1. Project resource name (e.g., `projects/{project_id}`) 2. Wildcard `\"*\"` (grants global ingress authorization to the target).", +"items": { +"type": "string" +}, +"type": "array" +}, +"createTime": { +"description": "Output only. The time when the PscAuthorizationPolicy was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A description of this resource.", +"type": "string" +}, +"etag": { +"description": "Output only. The etag of the PscAuthorizationPolicy.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. User-defined labels.", +"type": "object" +}, +"name": { +"description": "Identifier. The name of the PscAuthorizationPolicy. Format: projects/{project}/locations/{location}/pscAuthorizationPolicies/{psc_authorization_policy}", +"type": "string" +}, +"targetResourceUri": { +"description": "Required. The full absolute URI of the targeted resource governed by this policy. For example, for an AgentRegistry resource, the format is: `//agentregistry.googleapis.com/projects/{project}/locations/{location}`", +"type": "string" +}, +"uid": { +"description": "Output only. The unique identifier of the PscAuthorizationPolicy.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the PscAuthorizationPolicy was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "PscConfig": { "description": "Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.", "id": "PscConfig", From 47abd2112ca5c53a5605dd0d1e4ecc025a6097a0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:06 +0000 Subject: [PATCH 64/84] feat(networkmanagement): update the api #### networkmanagement:v1 The following keys were added: - schemas.ForwardingRuleInfo.properties.envoyHealthCheckFirewallsConfigState (Total Keys: 2) #### networkmanagement:v1beta1 The following keys were added: - schemas.ForwardingRuleInfo.properties.envoyHealthCheckFirewallsConfigState (Total Keys: 2) --- ...s.locations.global_.connectivityTests.html | 16 ++++++++++ ...s.locations.global_.connectivityTests.html | 16 ++++++++++ .../documents/networkmanagement.v1.json | 30 ++++++++++++++++++- .../documents/networkmanagement.v1beta1.json | 30 ++++++++++++++++++- 4 files changed, 90 insertions(+), 2 deletions(-) diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html index f3e9cb5a66..4d7ed31fa7 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html @@ -352,6 +352,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -466,6 +467,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -718,6 +720,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -832,6 +835,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -1291,6 +1295,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -1405,6 +1410,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -1657,6 +1663,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -1771,6 +1778,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -2221,6 +2229,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -2335,6 +2344,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -2587,6 +2597,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -2701,6 +2712,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -3110,6 +3122,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -3224,6 +3237,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -3476,6 +3490,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -3590,6 +3605,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index 7ce726b2d8..0a9f6b8dae 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -353,6 +353,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -467,6 +468,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -719,6 +721,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -833,6 +836,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -1294,6 +1298,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -1408,6 +1413,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -1660,6 +1666,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -1774,6 +1781,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -2226,6 +2234,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -2340,6 +2349,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -2592,6 +2602,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -2706,6 +2717,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -3117,6 +3129,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -3231,6 +3244,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. @@ -3483,6 +3497,7 @@

Method Details

}, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of the forwarding rule. + "envoyHealthCheckFirewallsConfigState": "A String", # Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target. "loadBalancerName": "A String", # Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules). "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the packet. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the packet. @@ -3597,6 +3612,7 @@

Method Details

"oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "ruleNumber": 42, # The number of the NAT rule that was matched. "type": "A String", # Type of NAT. }, "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index 5fee5b8b86..e604bd8103 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -1797,7 +1797,7 @@ } } }, -"revision": "20260617", +"revision": "20260724", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -2503,6 +2503,8 @@ false "NO_TRAFFIC_SELECTOR_TO_GCP_DESTINATION", "NO_KNOWN_ROUTE_FROM_PEERED_NETWORK_TO_DESTINATION", "PRIVATE_NAT_TO_PSC_ENDPOINT_UNSUPPORTED", +"PRIVATE_NAT_SOURCE_IP_IN_EXCLUDED_RANGE", +"PRIVATE_NAT_SOURCE_IP_IS_A_LINK_LOCAL_IP_IN_GKE", "PSC_PORT_MAPPING_PORT_MISMATCH", "PSC_PORT_MAPPING_WITHOUT_PSC_CONNECTION_UNSUPPORTED", "UNSUPPORTED_ROUTE_MATCHED_FOR_NAT64_DESTINATION", @@ -2615,6 +2617,8 @@ false "Packet from the non-GCP (on-prem) or unknown GCP network is dropped due to the destination IP address not belonging to any IP prefix included to the local traffic selector of the VPN tunnel.", "Packet from the unknown peered network is dropped due to no known route from the source network to the destination IP address.", "Sending packets processed by the Private NAT Gateways to the Private Service Connect endpoints is not supported.", +"Packet is dropped due to its source IP address being in the excluded range of the Spoke.", +"Packet is dropped due to its source IP address being a link-local IP address in GKE.", "Packet is sent to the PSC port mapping service, but its destination port does not match any port mapping rules.", "Sending packets directly to the PSC port mapping service without going through the PSC connection is not supported.", "Packet with destination IP address within the reserved NAT64 range is dropped due to matching a route of an unsupported type.", @@ -3193,6 +3197,25 @@ false "description": "Name of the forwarding rule.", "type": "string" }, +"envoyHealthCheckFirewallsConfigState": { +"description": "Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target.", +"enum": [ +"HEALTH_CHECK_FIREWALLS_CONFIG_STATE_UNSPECIFIED", +"FIREWALLS_CONFIGURED", +"FIREWALLS_PARTIALLY_CONFIGURED", +"FIREWALLS_NOT_CONFIGURED", +"FIREWALLS_UNSUPPORTED" +], +"enumDescriptions": [ +"Configuration state unspecified. It usually means that there are no relevant health checks for this load balancer frontend, or there was an unexpected configuration error preventing Connectivity Tests from verifying health check configuration.", +"Firewall rules (policies) allow health check traffic to the load balancer frontend.", +"Firewall rules (policies) allow health check traffic to the load balancer frontend only from a part of the required IP ranges.", +"Firewall rules (policies) deny health check traffic to the load balancer frontend.", +"Connectivity Tests doesn't support evaluating some of the firewall rules in the network, so it's not able to verify health check configuration status." +], +"readOnly": true, +"type": "string" +}, "loadBalancerName": { "description": "Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules).", "type": "string" @@ -4281,6 +4304,11 @@ false "description": "URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}`", "type": "string" }, +"ruleNumber": { +"description": "The number of the NAT rule that was matched.", +"format": "int32", +"type": "integer" +}, "type": { "description": "Type of NAT.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 93e125a17e..8419fc8dad 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -1237,7 +1237,7 @@ } } }, -"revision": "20260617", +"revision": "20260724", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1943,6 +1943,8 @@ false "NO_TRAFFIC_SELECTOR_TO_GCP_DESTINATION", "NO_KNOWN_ROUTE_FROM_PEERED_NETWORK_TO_DESTINATION", "PRIVATE_NAT_TO_PSC_ENDPOINT_UNSUPPORTED", +"PRIVATE_NAT_SOURCE_IP_IN_EXCLUDED_RANGE", +"PRIVATE_NAT_SOURCE_IP_IS_A_LINK_LOCAL_IP_IN_GKE", "PSC_PORT_MAPPING_PORT_MISMATCH", "PSC_PORT_MAPPING_WITHOUT_PSC_CONNECTION_UNSUPPORTED", "UNSUPPORTED_ROUTE_MATCHED_FOR_NAT64_DESTINATION", @@ -2055,6 +2057,8 @@ false "Packet from the non-GCP (on-prem) or unknown GCP network is dropped due to the destination IP address not belonging to any IP prefix included to the local traffic selector of the VPN tunnel.", "Packet from the unknown peered network is dropped due to no known route from the source network to the destination IP address.", "Sending packets processed by the Private NAT Gateways to the Private Service Connect endpoints is not supported.", +"Packet is dropped due to its source IP address being in the excluded range of the Spoke.", +"Packet is dropped due to its source IP address being a link-local IP address in GKE.", "Packet is sent to the PSC port mapping service, but its destination port does not match any port mapping rules.", "Sending packets directly to the PSC port mapping service without going through the PSC connection is not supported.", "Packet with destination IP address within the reserved NAT64 range is dropped due to matching a route of an unsupported type.", @@ -2637,6 +2641,25 @@ false "description": "Name of the forwarding rule.", "type": "string" }, +"envoyHealthCheckFirewallsConfigState": { +"description": "Output only. State of the firewalls allowing health check traffic to the load balancer frontend (Envoy proxies). This is the result of the firewall configuration analysis verifying that health check traffic from required IP ranges to the the Envoy-based load balancer frontend is allowed by firewall rules with the load balancer target.", +"enum": [ +"HEALTH_CHECK_FIREWALLS_CONFIG_STATE_UNSPECIFIED", +"FIREWALLS_CONFIGURED", +"FIREWALLS_PARTIALLY_CONFIGURED", +"FIREWALLS_NOT_CONFIGURED", +"FIREWALLS_UNSUPPORTED" +], +"enumDescriptions": [ +"Configuration state unspecified. It usually means that there are no relevant health checks for this load balancer frontend, or there was an unexpected configuration error preventing Connectivity Tests from verifying health check configuration.", +"Firewall rules (policies) allow health check traffic to the load balancer frontend.", +"Firewall rules (policies) allow health check traffic to the load balancer frontend only from a part of the required IP ranges.", +"Firewall rules (policies) deny health check traffic to the load balancer frontend.", +"Connectivity Tests doesn't support evaluating some of the firewall rules in the network, so it's not able to verify health check configuration status." +], +"readOnly": true, +"type": "string" +}, "loadBalancerName": { "description": "Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules).", "type": "string" @@ -3378,6 +3401,11 @@ false "description": "URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}`", "type": "string" }, +"ruleNumber": { +"description": "The number of the NAT rule that was matched.", +"format": "int32", +"type": "integer" +}, "type": { "description": "Type of NAT.", "enum": [ From 27cb2e70368610081fe8885576f990557421a690 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:07 +0000 Subject: [PATCH 65/84] feat(networkservices): update the api #### networkservices:v1 The following keys were added: - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch (Total Keys: 15) - schemas.AgentConnectivityTemplate (Total Keys: 15) - schemas.AgentGatewaySelfManaged.properties.resourceUris (Total Keys: 2) - schemas.DnsPeeringConfig (Total Keys: 4) - schemas.EgressNetworkConfig (Total Keys: 11) - schemas.EndpointPolicy.properties.clientTlsPolicy.deprecated (Total Keys: 1) - schemas.ListAgentConnectivityTemplatesResponse (Total Keys: 7) #### networkservices:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch (Total Keys: 15) - schemas.AgentConnectivityTemplate (Total Keys: 15) - schemas.AgentGatewaySelfManaged.properties.resourceUris (Total Keys: 2) - schemas.DnsPeeringConfig (Total Keys: 4) - schemas.EgressNetworkConfig (Total Keys: 11) - schemas.EndpointPolicy.properties.clientTlsPolicy.deprecated (Total Keys: 1) - schemas.ListAgentConnectivityTemplatesResponse (Total Keys: 7) --- ....locations.agentConnectivityTemplates.html | 385 ++++++++++++++++++ ...s_v1.projects.locations.agentGateways.html | 12 + ...v1.projects.locations.authzExtensions.html | 24 +- ...1.projects.locations.endpointPolicies.html | 8 +- ...networkservices_v1.projects.locations.html | 5 + ....locations.agentConnectivityTemplates.html | 385 ++++++++++++++++++ ...eta1.projects.locations.agentGateways.html | 12 + ...a1.projects.locations.authzExtensions.html | 24 +- ...1.projects.locations.endpointPolicies.html | 8 +- ...rkservices_v1beta1.projects.locations.html | 5 + .../documents/networkservices.v1.json | 359 +++++++++++++++- .../documents/networkservices.v1beta1.json | 359 +++++++++++++++- 12 files changed, 1544 insertions(+), 42 deletions(-) create mode 100644 docs/dyn/networkservices_v1.projects.locations.agentConnectivityTemplates.html create mode 100644 docs/dyn/networkservices_v1beta1.projects.locations.agentConnectivityTemplates.html diff --git a/docs/dyn/networkservices_v1.projects.locations.agentConnectivityTemplates.html b/docs/dyn/networkservices_v1.projects.locations.agentConnectivityTemplates.html new file mode 100644 index 0000000000..532a536021 --- /dev/null +++ b/docs/dyn/networkservices_v1.projects.locations.agentConnectivityTemplates.html @@ -0,0 +1,385 @@ + + + +

Network Services API . projects . locations . agentConnectivityTemplates

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new AgentConnectivityTemplate in a given project and location.

+

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

+

Deletes a single AgentConnectivityTemplate.

+

+ get(name, x__xgafv=None)

+

Gets details of a single AgentConnectivityTemplate.

+

+ list(parent, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists AgentConnectivityTemplates in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the parameters of a single AgentConnectivityTemplate.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, agentConnectivityTemplateId=None, body=None, x__xgafv=None) +
Creates a new AgentConnectivityTemplate in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource of the AgentConnectivityTemplate. Must be in the format `projects/*/locations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # AgentConnectivityTemplate represents a reusable network configuration.
+  "accessPath": "A String", # Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.
+  "accessTypes": [ # Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
+  "egressNetworkConfig": { # Optional. Configuration for egress network traffic.
+    "dnsPeeringConfig": { # DNS Peering configuration. # Optional. DNS Peering configuration.
+      "domain": "A String", # Optional. The domain to peer.
+      "targetNetwork": "A String", # Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}
+    },
+    "networkAttachment": "A String", # Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}
+    "tlsConfig": { # Configuration for TLS connections. # Optional. The TLS configuration for the egress traffic.
+      "additionalRoots": "A String", # Optional. The additional roots to trust.
+      "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+    },
+    "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+    "vpcEgress": "A String", # Optional. The VPC egress setting.
+  },
+  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
+  "labels": { # Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+  agentConnectivityTemplateId: string, Required. Short name of the AgentConnectivityTemplate resource to be created.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, etag=None, x__xgafv=None) +
Deletes a single AgentConnectivityTemplate.
+
+Args:
+  name: string, Required. A name of the AgentConnectivityTemplate to delete. Must be in the format `projects/*/locations/*/agentConnectivityTemplates/*`. (required)
+  etag: string, Optional. The etag of the AgentConnectivityTemplate to delete.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single AgentConnectivityTemplate.
+
+Args:
+  name: string, Required. A name of the AgentConnectivityTemplate to get. Must be in the format `projects/*/locations/*/agentConnectivityTemplates/*`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # AgentConnectivityTemplate represents a reusable network configuration.
+  "accessPath": "A String", # Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.
+  "accessTypes": [ # Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
+  "egressNetworkConfig": { # Optional. Configuration for egress network traffic.
+    "dnsPeeringConfig": { # DNS Peering configuration. # Optional. DNS Peering configuration.
+      "domain": "A String", # Optional. The domain to peer.
+      "targetNetwork": "A String", # Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}
+    },
+    "networkAttachment": "A String", # Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}
+    "tlsConfig": { # Configuration for TLS connections. # Optional. The TLS configuration for the egress traffic.
+      "additionalRoots": "A String", # Optional. The additional roots to trust.
+      "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+    },
+    "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+    "vpcEgress": "A String", # Optional. The VPC egress setting.
+  },
+  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
+  "labels": { # Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists AgentConnectivityTemplates in a given project and location.
+
+Args:
+  parent: string, Required. The project and location from which the AgentConnectivityTemplates should be listed, specified in the format `projects/*/locations/*`. (required)
+  pageSize: integer, Optional. Maximum number of AgentConnectivityTemplates to return per call.
+  pageToken: string, Optional. The value returned by the last `ListAgentConnectivityTemplatesResponse` Indicates that this is a continuation of a prior `ListAgentConnectivityTemplates` call, and that the system should return the next page of data.
+  returnPartialSuccess: boolean, Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response returned by the ListAgentConnectivityTemplates method.
+  "agentConnectivityTemplates": [ # List of AgentConnectivityTemplate resources.
+    { # AgentConnectivityTemplate represents a reusable network configuration.
+      "accessPath": "A String", # Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.
+      "accessTypes": [ # Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
+      "egressNetworkConfig": { # Optional. Configuration for egress network traffic.
+        "dnsPeeringConfig": { # DNS Peering configuration. # Optional. DNS Peering configuration.
+          "domain": "A String", # Optional. The domain to peer.
+          "targetNetwork": "A String", # Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}
+        },
+        "networkAttachment": "A String", # Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}
+        "tlsConfig": { # Configuration for TLS connections. # Optional. The TLS configuration for the egress traffic.
+          "additionalRoots": "A String", # Optional. The additional roots to trust.
+          "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+        },
+        "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+        "vpcEgress": "A String", # Optional. The VPC egress setting.
+      },
+      "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
+      "labels": { # Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+    },
+  ],
+  "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single AgentConnectivityTemplate.
+
+Args:
+  name: string, Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # AgentConnectivityTemplate represents a reusable network configuration.
+  "accessPath": "A String", # Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.
+  "accessTypes": [ # Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
+  "egressNetworkConfig": { # Optional. Configuration for egress network traffic.
+    "dnsPeeringConfig": { # DNS Peering configuration. # Optional. DNS Peering configuration.
+      "domain": "A String", # Optional. The domain to peer.
+      "targetNetwork": "A String", # Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}
+    },
+    "networkAttachment": "A String", # Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}
+    "tlsConfig": { # Configuration for TLS connections. # Optional. The TLS configuration for the egress traffic.
+      "additionalRoots": "A String", # Optional. The additional roots to trust.
+      "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+    },
+    "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+    "vpcEgress": "A String", # Optional. The VPC egress setting.
+  },
+  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
+  "labels": { # Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the AgentConnectivityTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/networkservices_v1.projects.locations.agentGateways.html b/docs/dyn/networkservices_v1.projects.locations.agentGateways.html index 4faa4091ca..fc1086a2e3 100644 --- a/docs/dyn/networkservices_v1.projects.locations.agentGateways.html +++ b/docs/dyn/networkservices_v1.projects.locations.agentGateways.html @@ -148,6 +148,9 @@

Method Details

], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location + "resourceUris": [ # Optional. List of supported Google Cloud networking proxies in the Project and Location. resource_uris is mutually exclusive with resource_uri. + "A String", + ], }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. } @@ -270,6 +273,9 @@

Method Details

], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location + "resourceUris": [ # Optional. List of supported Google Cloud networking proxies in the Project and Location. resource_uris is mutually exclusive with resource_uri. + "A String", + ], }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. }
@@ -332,6 +338,9 @@

Method Details

], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location + "resourceUris": [ # Optional. List of supported Google Cloud networking proxies in the Project and Location. resource_uris is mutually exclusive with resource_uri. + "A String", + ], }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. }, @@ -404,6 +413,9 @@

Method Details

], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location + "resourceUris": [ # Optional. List of supported Google Cloud networking proxies in the Project and Location. resource_uris is mutually exclusive with resource_uri. + "A String", + ], }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. } diff --git a/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html b/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html index bea3172d90..fe27d2d323 100644 --- a/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html +++ b/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # `AuthzExtension` is a resource that allows traffic forwarding to a callout backend service to make an authorization decision. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service or a wasm plugin. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -124,12 +124,12 @@

Method Details

"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. "a_key": "A String", }, - "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. The supported values are `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. You can omit this field for `AuthzExtensions` resources that don't reference a backend service. For more information, see [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. @@ -217,7 +217,7 @@

Method Details

An object of the form: { # `AuthzExtension` is a resource that allows traffic forwarding to a callout backend service to make an authorization decision. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service or a wasm plugin. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -230,12 +230,12 @@

Method Details

"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. "a_key": "A String", }, - "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. The supported values are `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. You can omit this field for `AuthzExtensions` resources that don't reference a backend service. For more information, see [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. @@ -263,7 +263,7 @@

Method Details

{ # Message for response to listing `AuthzExtension` resources. "authzExtensions": [ # The list of `AuthzExtension` resources. { # `AuthzExtension` is a resource that allows traffic forwarding to a callout backend service to make an authorization decision. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service or a wasm plugin. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -276,12 +276,12 @@

Method Details

"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. "a_key": "A String", }, - "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. The supported values are `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. You can omit this field for `AuthzExtensions` resources that don't reference a backend service. For more information, see [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. @@ -318,7 +318,7 @@

Method Details

The object takes the form of: { # `AuthzExtension` is a resource that allows traffic forwarding to a callout backend service to make an authorization decision. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service or a wasm plugin. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -331,12 +331,12 @@

Method Details

"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. "a_key": "A String", }, - "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. The supported values are `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. You can omit this field for `AuthzExtensions` resources that don't reference a backend service. For more information, see [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. diff --git a/docs/dyn/networkservices_v1.projects.locations.endpointPolicies.html b/docs/dyn/networkservices_v1.projects.locations.endpointPolicies.html index 21b813bff9..f47e788172 100644 --- a/docs/dyn/networkservices_v1.projects.locations.endpointPolicies.html +++ b/docs/dyn/networkservices_v1.projects.locations.endpointPolicies.html @@ -112,7 +112,7 @@

Method Details

{ # EndpointPolicy is a resource that helps apply desired configuration on the endpoints that match specific criteria. For example, this resource can be used to apply "authentication config" an all endpoints that serve on port 8080. "authorizationPolicy": "A String", # Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint. - "clientTlsPolicy": "A String", # Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. + "clientTlsPolicy": "A String", # Optional. Deprecated: This field is not used and is a no-op. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. "endpointMatcher": { # A definition of a matcher that selects endpoints to which the policies should be applied. # Required. A matcher that selects endpoints to which the policies should be applied. @@ -221,7 +221,7 @@

Method Details

{ # EndpointPolicy is a resource that helps apply desired configuration on the endpoints that match specific criteria. For example, this resource can be used to apply "authentication config" an all endpoints that serve on port 8080. "authorizationPolicy": "A String", # Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint. - "clientTlsPolicy": "A String", # Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. + "clientTlsPolicy": "A String", # Optional. Deprecated: This field is not used and is a no-op. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. "endpointMatcher": { # A definition of a matcher that selects endpoints to which the policies should be applied. # Required. A matcher that selects endpoints to which the policies should be applied. @@ -271,7 +271,7 @@

Method Details

"endpointPolicies": [ # List of EndpointPolicy resources. { # EndpointPolicy is a resource that helps apply desired configuration on the endpoints that match specific criteria. For example, this resource can be used to apply "authentication config" an all endpoints that serve on port 8080. "authorizationPolicy": "A String", # Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint. - "clientTlsPolicy": "A String", # Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. + "clientTlsPolicy": "A String", # Optional. Deprecated: This field is not used and is a no-op. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. "endpointMatcher": { # A definition of a matcher that selects endpoints to which the policies should be applied. # Required. A matcher that selects endpoints to which the policies should be applied. @@ -331,7 +331,7 @@

Method Details

{ # EndpointPolicy is a resource that helps apply desired configuration on the endpoints that match specific criteria. For example, this resource can be used to apply "authentication config" an all endpoints that serve on port 8080. "authorizationPolicy": "A String", # Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint. - "clientTlsPolicy": "A String", # Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. + "clientTlsPolicy": "A String", # Optional. Deprecated: This field is not used and is a no-op. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. "endpointMatcher": { # A definition of a matcher that selects endpoints to which the policies should be applied. # Required. A matcher that selects endpoints to which the policies should be applied. diff --git a/docs/dyn/networkservices_v1.projects.locations.html b/docs/dyn/networkservices_v1.projects.locations.html index 914c25a3f6..af4a53bad6 100644 --- a/docs/dyn/networkservices_v1.projects.locations.html +++ b/docs/dyn/networkservices_v1.projects.locations.html @@ -74,6 +74,11 @@

Network Services API . projects . locations

Instance Methods

+

+ agentConnectivityTemplates() +

+

Returns the agentConnectivityTemplates Resource.

+

agentGateways()

diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.agentConnectivityTemplates.html b/docs/dyn/networkservices_v1beta1.projects.locations.agentConnectivityTemplates.html new file mode 100644 index 0000000000..ac979e4dbd --- /dev/null +++ b/docs/dyn/networkservices_v1beta1.projects.locations.agentConnectivityTemplates.html @@ -0,0 +1,385 @@ + + + +

Network Services API . projects . locations . agentConnectivityTemplates

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new AgentConnectivityTemplate in a given project and location.

+

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

+

Deletes a single AgentConnectivityTemplate.

+

+ get(name, x__xgafv=None)

+

Gets details of a single AgentConnectivityTemplate.

+

+ list(parent, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists AgentConnectivityTemplates in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the parameters of a single AgentConnectivityTemplate.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, agentConnectivityTemplateId=None, body=None, x__xgafv=None) +
Creates a new AgentConnectivityTemplate in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource of the AgentConnectivityTemplate. Must be in the format `projects/*/locations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # AgentConnectivityTemplate represents a reusable network configuration.
+  "accessPath": "A String", # Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.
+  "accessTypes": [ # Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
+  "egressNetworkConfig": { # Optional. Configuration for egress network traffic.
+    "dnsPeeringConfig": { # DNS Peering configuration. # Optional. DNS Peering configuration.
+      "domain": "A String", # Optional. The domain to peer.
+      "targetNetwork": "A String", # Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}
+    },
+    "networkAttachment": "A String", # Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}
+    "tlsConfig": { # Configuration for TLS connections. # Optional. The TLS configuration for the egress traffic.
+      "additionalRoots": "A String", # Optional. The additional roots to trust.
+      "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+    },
+    "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+    "vpcEgress": "A String", # Optional. The VPC egress setting.
+  },
+  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
+  "labels": { # Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+  agentConnectivityTemplateId: string, Required. Short name of the AgentConnectivityTemplate resource to be created.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, etag=None, x__xgafv=None) +
Deletes a single AgentConnectivityTemplate.
+
+Args:
+  name: string, Required. A name of the AgentConnectivityTemplate to delete. Must be in the format `projects/*/locations/*/agentConnectivityTemplates/*`. (required)
+  etag: string, Optional. The etag of the AgentConnectivityTemplate to delete.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single AgentConnectivityTemplate.
+
+Args:
+  name: string, Required. A name of the AgentConnectivityTemplate to get. Must be in the format `projects/*/locations/*/agentConnectivityTemplates/*`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # AgentConnectivityTemplate represents a reusable network configuration.
+  "accessPath": "A String", # Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.
+  "accessTypes": [ # Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
+  "egressNetworkConfig": { # Optional. Configuration for egress network traffic.
+    "dnsPeeringConfig": { # DNS Peering configuration. # Optional. DNS Peering configuration.
+      "domain": "A String", # Optional. The domain to peer.
+      "targetNetwork": "A String", # Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}
+    },
+    "networkAttachment": "A String", # Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}
+    "tlsConfig": { # Configuration for TLS connections. # Optional. The TLS configuration for the egress traffic.
+      "additionalRoots": "A String", # Optional. The additional roots to trust.
+      "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+    },
+    "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+    "vpcEgress": "A String", # Optional. The VPC egress setting.
+  },
+  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
+  "labels": { # Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists AgentConnectivityTemplates in a given project and location.
+
+Args:
+  parent: string, Required. The project and location from which the AgentConnectivityTemplates should be listed, specified in the format `projects/*/locations/*`. (required)
+  pageSize: integer, Optional. Maximum number of AgentConnectivityTemplates to return per call.
+  pageToken: string, Optional. The value returned by the last `ListAgentConnectivityTemplatesResponse` Indicates that this is a continuation of a prior `ListAgentConnectivityTemplates` call, and that the system should return the next page of data.
+  returnPartialSuccess: boolean, Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response returned by the ListAgentConnectivityTemplates method.
+  "agentConnectivityTemplates": [ # List of AgentConnectivityTemplate resources.
+    { # AgentConnectivityTemplate represents a reusable network configuration.
+      "accessPath": "A String", # Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.
+      "accessTypes": [ # Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
+      "egressNetworkConfig": { # Optional. Configuration for egress network traffic.
+        "dnsPeeringConfig": { # DNS Peering configuration. # Optional. DNS Peering configuration.
+          "domain": "A String", # Optional. The domain to peer.
+          "targetNetwork": "A String", # Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}
+        },
+        "networkAttachment": "A String", # Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}
+        "tlsConfig": { # Configuration for TLS connections. # Optional. The TLS configuration for the egress traffic.
+          "additionalRoots": "A String", # Optional. The additional roots to trust.
+          "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+        },
+        "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+        "vpcEgress": "A String", # Optional. The VPC egress setting.
+      },
+      "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
+      "labels": { # Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+    },
+  ],
+  "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single AgentConnectivityTemplate.
+
+Args:
+  name: string, Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # AgentConnectivityTemplate represents a reusable network configuration.
+  "accessPath": "A String", # Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.
+  "accessTypes": [ # Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
+  "egressNetworkConfig": { # Optional. Configuration for egress network traffic.
+    "dnsPeeringConfig": { # DNS Peering configuration. # Optional. DNS Peering configuration.
+      "domain": "A String", # Optional. The domain to peer.
+      "targetNetwork": "A String", # Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}
+    },
+    "networkAttachment": "A String", # Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}
+    "tlsConfig": { # Configuration for TLS connections. # Optional. The TLS configuration for the egress traffic.
+      "additionalRoots": "A String", # Optional. The additional roots to trust.
+      "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+    },
+    "trustConfig": "A String", # Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+    "vpcEgress": "A String", # Optional. The VPC egress setting.
+  },
+  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
+  "labels": { # Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the AgentConnectivityTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html b/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html index ebbfd1f464..887ecaf34a 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html @@ -148,6 +148,9 @@

Method Details

], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location + "resourceUris": [ # Optional. List of supported Google Cloud networking proxies in the Project and Location. resource_uris is mutually exclusive with resource_uri. + "A String", + ], }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. } @@ -270,6 +273,9 @@

Method Details

], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location + "resourceUris": [ # Optional. List of supported Google Cloud networking proxies in the Project and Location. resource_uris is mutually exclusive with resource_uri. + "A String", + ], }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. }
@@ -332,6 +338,9 @@

Method Details

], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location + "resourceUris": [ # Optional. List of supported Google Cloud networking proxies in the Project and Location. resource_uris is mutually exclusive with resource_uri. + "A String", + ], }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. }, @@ -404,6 +413,9 @@

Method Details

], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location + "resourceUris": [ # Optional. List of supported Google Cloud networking proxies in the Project and Location. resource_uris is mutually exclusive with resource_uri. + "A String", + ], }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. } diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html index e731610f30..45bc97cafd 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # `AuthzExtension` is a resource that allows traffic forwarding to a callout backend service to make an authorization decision. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service or a wasm plugin. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -124,12 +124,12 @@

Method Details

"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. "a_key": "A String", }, - "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. The supported values are `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. You can omit this field for `AuthzExtensions` resources that don't reference a backend service. For more information, see [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. @@ -217,7 +217,7 @@

Method Details

An object of the form: { # `AuthzExtension` is a resource that allows traffic forwarding to a callout backend service to make an authorization decision. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service or a wasm plugin. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -230,12 +230,12 @@

Method Details

"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. "a_key": "A String", }, - "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. The supported values are `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. You can omit this field for `AuthzExtensions` resources that don't reference a backend service. For more information, see [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. @@ -263,7 +263,7 @@

Method Details

{ # Message for response to listing `AuthzExtension` resources. "authzExtensions": [ # The list of `AuthzExtension` resources. { # `AuthzExtension` is a resource that allows traffic forwarding to a callout backend service to make an authorization decision. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service or a wasm plugin. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -276,12 +276,12 @@

Method Details

"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. "a_key": "A String", }, - "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. The supported values are `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. You can omit this field for `AuthzExtensions` resources that don't reference a backend service. For more information, see [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. @@ -318,7 +318,7 @@

Method Details

The object takes the form of: { # `AuthzExtension` is a resource that allows traffic forwarding to a callout backend service to make an authorization decision. - "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service or a wasm plugin. + "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -331,12 +331,12 @@

Method Details

"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. "a_key": "A String", }, - "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. The supported values are `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. You can omit this field for `AuthzExtensions` resources that don't reference a backend service. For more information, see [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. "a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.endpointPolicies.html b/docs/dyn/networkservices_v1beta1.projects.locations.endpointPolicies.html index 25e4fafd1e..ec0c6ea23f 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.endpointPolicies.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.endpointPolicies.html @@ -112,7 +112,7 @@

Method Details

{ # EndpointPolicy is a resource that helps apply desired configuration on the endpoints that match specific criteria. For example, this resource can be used to apply "authentication config" an all endpoints that serve on port 8080. "authorizationPolicy": "A String", # Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint. - "clientTlsPolicy": "A String", # Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. + "clientTlsPolicy": "A String", # Optional. Deprecated: This field is not used and is a no-op. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. "endpointMatcher": { # A definition of a matcher that selects endpoints to which the policies should be applied. # Required. A matcher that selects endpoints to which the policies should be applied. @@ -222,7 +222,7 @@

Method Details

{ # EndpointPolicy is a resource that helps apply desired configuration on the endpoints that match specific criteria. For example, this resource can be used to apply "authentication config" an all endpoints that serve on port 8080. "authorizationPolicy": "A String", # Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint. - "clientTlsPolicy": "A String", # Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. + "clientTlsPolicy": "A String", # Optional. Deprecated: This field is not used and is a no-op. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. "endpointMatcher": { # A definition of a matcher that selects endpoints to which the policies should be applied. # Required. A matcher that selects endpoints to which the policies should be applied. @@ -273,7 +273,7 @@

Method Details

"endpointPolicies": [ # List of EndpointPolicy resources. { # EndpointPolicy is a resource that helps apply desired configuration on the endpoints that match specific criteria. For example, this resource can be used to apply "authentication config" an all endpoints that serve on port 8080. "authorizationPolicy": "A String", # Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint. - "clientTlsPolicy": "A String", # Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. + "clientTlsPolicy": "A String", # Optional. Deprecated: This field is not used and is a no-op. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. "endpointMatcher": { # A definition of a matcher that selects endpoints to which the policies should be applied. # Required. A matcher that selects endpoints to which the policies should be applied. @@ -334,7 +334,7 @@

Method Details

{ # EndpointPolicy is a resource that helps apply desired configuration on the endpoints that match specific criteria. For example, this resource can be used to apply "authentication config" an all endpoints that serve on port 8080. "authorizationPolicy": "A String", # Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint. - "clientTlsPolicy": "A String", # Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. + "clientTlsPolicy": "A String", # Optional. Deprecated: This field is not used and is a no-op. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters. "endpointMatcher": { # A definition of a matcher that selects endpoints to which the policies should be applied. # Required. A matcher that selects endpoints to which the policies should be applied. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.html b/docs/dyn/networkservices_v1beta1.projects.locations.html index e0c9c6ac4e..0d6c8d8fde 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.html @@ -74,6 +74,11 @@

Network Services API . projects . locations

Instance Methods

+

+ agentConnectivityTemplates() +

+

Returns the agentConnectivityTemplates Resource.

+

agentGateways()

diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index abef7ee6bb..f34b4cc96c 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -183,6 +183,173 @@ } }, "resources": { +"agentConnectivityTemplates": { +"methods": { +"create": { +"description": "Creates a new AgentConnectivityTemplate in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates", +"httpMethod": "POST", +"id": "networkservices.projects.locations.agentConnectivityTemplates.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"agentConnectivityTemplateId": { +"description": "Required. Short name of the AgentConnectivityTemplate resource to be created.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the AgentConnectivityTemplate. Must be in the format `projects/*/locations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/agentConnectivityTemplates", +"request": { +"$ref": "AgentConnectivityTemplate" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single AgentConnectivityTemplate.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates/{agentConnectivityTemplatesId}", +"httpMethod": "DELETE", +"id": "networkservices.projects.locations.agentConnectivityTemplates.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "Optional. The etag of the AgentConnectivityTemplate to delete.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. A name of the AgentConnectivityTemplate to delete. Must be in the format `projects/*/locations/*/agentConnectivityTemplates/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agentConnectivityTemplates/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single AgentConnectivityTemplate.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates/{agentConnectivityTemplatesId}", +"httpMethod": "GET", +"id": "networkservices.projects.locations.agentConnectivityTemplates.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the AgentConnectivityTemplate to get. Must be in the format `projects/*/locations/*/agentConnectivityTemplates/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agentConnectivityTemplates/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "AgentConnectivityTemplate" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists AgentConnectivityTemplates in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates", +"httpMethod": "GET", +"id": "networkservices.projects.locations.agentConnectivityTemplates.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of AgentConnectivityTemplates to return per call.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The value returned by the last `ListAgentConnectivityTemplatesResponse` Indicates that this is a continuation of a prior `ListAgentConnectivityTemplates` call, and that the system should return the next page of data.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location from which the AgentConnectivityTemplates should be listed, specified in the format `projects/*/locations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+parent}/agentConnectivityTemplates", +"response": { +"$ref": "ListAgentConnectivityTemplatesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single AgentConnectivityTemplate.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates/{agentConnectivityTemplatesId}", +"httpMethod": "PATCH", +"id": "networkservices.projects.locations.agentConnectivityTemplates.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agentConnectivityTemplates/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the AgentConnectivityTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "AgentConnectivityTemplate" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "agentGateways": { "methods": { "create": { @@ -3732,9 +3899,82 @@ } } }, -"revision": "20260626", +"revision": "20260724", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { +"AgentConnectivityTemplate": { +"description": "AgentConnectivityTemplate represents a reusable network configuration.", +"id": "AgentConnectivityTemplate", +"properties": { +"accessPath": { +"description": "Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.", +"enum": [ +"ACCESS_PATH_UNSPECIFIED", +"CLIENT_TO_AGENT", +"AGENT_TO_ANYWHERE" +], +"enumDescriptions": [ +"Unspecified access path.", +"Protect connection to Agent or Tool.", +"Govern agent connections to destinations." +], +"type": "string" +}, +"accessTypes": { +"description": "Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.", +"items": { +"enum": [ +"ACCESS_TYPE_UNSPECIFIED", +"PUBLIC", +"PRIVATE" +], +"enumDescriptions": [ +"Unspecified access type.", +"Public network access.", +"Private network access." +], +"type": "string" +}, +"type": "array" +}, +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A free-text description of the resource. Max length 1024 characters.", +"type": "string" +}, +"egressNetworkConfig": { +"$ref": "EgressNetworkConfig", +"description": "Optional. Configuration for egress network traffic." +}, +"etag": { +"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Set of label tags associated with the AgentConnectivityTemplate resource.", +"type": "object" +}, +"name": { +"description": "Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the resource was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "AgentGateway": { "description": "AgentGateway represents the agent gateway resource.", "id": "AgentGateway", @@ -3914,6 +4154,13 @@ "resourceUri": { "description": "Optional. A supported Google Cloud networking proxy in the Project and Location", "type": "string" +}, +"resourceUris": { +"description": "Optional. List of supported Google Cloud networking proxies in the Project and Location. resource_uris is mutually exclusive with resource_uri.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -3971,7 +4218,7 @@ "id": "AuthzExtension", "properties": { "authority": { -"description": "Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service or a wasm plugin.", +"description": "Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service.", "type": "string" }, "createTime": { @@ -4010,7 +4257,7 @@ "type": "object" }, "loadBalancingScheme": { -"description": "Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", +"description": "Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. The supported values are `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. You can omit this field for `AuthzExtensions` resources that don't reference a backend service. For more information, see [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", "enum": [ "LOAD_BALANCING_SCHEME_UNSPECIFIED", "INTERNAL_MANAGED", @@ -4036,7 +4283,7 @@ "type": "string" }, "service": { -"description": "Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.", +"description": "Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ.", "type": "string" }, "timeout": { @@ -4095,6 +4342,82 @@ "properties": {}, "type": "object" }, +"DnsPeeringConfig": { +"description": "DNS Peering configuration.", +"id": "DnsPeeringConfig", +"properties": { +"domain": { +"description": "Optional. The domain to peer.", +"type": "string" +}, +"targetNetwork": { +"description": "Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}", +"type": "string" +} +}, +"type": "object" +}, +"EgressNetworkConfig": { +"id": "EgressNetworkConfig", +"properties": { +"dnsPeeringConfig": { +"$ref": "DnsPeeringConfig", +"description": "Optional. DNS Peering configuration." +}, +"networkAttachment": { +"description": "Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}", +"type": "string" +}, +"tlsConfig": { +"$ref": "EgressNetworkConfigTlsConfig", +"description": "Optional. The TLS configuration for the egress traffic." +}, +"trustConfig": { +"description": "Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}", +"type": "string" +}, +"vpcEgress": { +"description": "Optional. The VPC egress setting.", +"enum": [ +"VPC_EGRESS_UNSPECIFIED", +"ALL_TRAFFIC", +"PRIVATE_RANGES_ONLY" +], +"enumDescriptions": [ +"Unspecified", +"All outbound traffic is routed through the VPC connector.", +"Only private IP ranges are routed through the VPC connector." +], +"type": "string" +} +}, +"type": "object" +}, +"EgressNetworkConfigTlsConfig": { +"description": "Configuration for TLS connections.", +"id": "EgressNetworkConfigTlsConfig", +"properties": { +"additionalRoots": { +"description": "Optional. The additional roots to trust.", +"enum": [ +"ADDITIONAL_ROOTS_UNSPECIFIED", +"NO_ADDITIONAL_ROOTS", +"PUBLICLY_TRUSTED_ROOTS" +], +"enumDescriptions": [ +"Unspecified additional roots.", +"Trust only the certificates provided in `trust_config`.", +"Trust certificates provided in `trust_config` and publicly trusted roots." +], +"type": "string" +}, +"trustConfig": { +"description": "Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}", +"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", @@ -4164,7 +4487,8 @@ "type": "string" }, "clientTlsPolicy": { -"description": "Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY.", +"deprecated": true, +"description": "Optional. Deprecated: This field is not used and is a no-op. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY.", "type": "string" }, "createTime": { @@ -5621,6 +5945,31 @@ }, "type": "object" }, +"ListAgentConnectivityTemplatesResponse": { +"description": "Response returned by the ListAgentConnectivityTemplates method.", +"id": "ListAgentConnectivityTemplatesResponse", +"properties": { +"agentConnectivityTemplates": { +"description": "List of AgentConnectivityTemplate resources.", +"items": { +"$ref": "AgentConnectivityTemplate" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListAgentGatewaysResponse": { "description": "Response returned by the ListAgentGateways method.", "id": "ListAgentGatewaysResponse", diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index 0bd254b6bc..329a2ddd93 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -183,6 +183,173 @@ } }, "resources": { +"agentConnectivityTemplates": { +"methods": { +"create": { +"description": "Creates a new AgentConnectivityTemplate in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates", +"httpMethod": "POST", +"id": "networkservices.projects.locations.agentConnectivityTemplates.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"agentConnectivityTemplateId": { +"description": "Required. Short name of the AgentConnectivityTemplate resource to be created.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the AgentConnectivityTemplate. Must be in the format `projects/*/locations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/agentConnectivityTemplates", +"request": { +"$ref": "AgentConnectivityTemplate" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single AgentConnectivityTemplate.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates/{agentConnectivityTemplatesId}", +"httpMethod": "DELETE", +"id": "networkservices.projects.locations.agentConnectivityTemplates.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "Optional. The etag of the AgentConnectivityTemplate to delete.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. A name of the AgentConnectivityTemplate to delete. Must be in the format `projects/*/locations/*/agentConnectivityTemplates/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agentConnectivityTemplates/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single AgentConnectivityTemplate.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates/{agentConnectivityTemplatesId}", +"httpMethod": "GET", +"id": "networkservices.projects.locations.agentConnectivityTemplates.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the AgentConnectivityTemplate to get. Must be in the format `projects/*/locations/*/agentConnectivityTemplates/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agentConnectivityTemplates/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "AgentConnectivityTemplate" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists AgentConnectivityTemplates in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates", +"httpMethod": "GET", +"id": "networkservices.projects.locations.agentConnectivityTemplates.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of AgentConnectivityTemplates to return per call.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The value returned by the last `ListAgentConnectivityTemplatesResponse` Indicates that this is a continuation of a prior `ListAgentConnectivityTemplates` call, and that the system should return the next page of data.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location from which the AgentConnectivityTemplates should be listed, specified in the format `projects/*/locations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+parent}/agentConnectivityTemplates", +"response": { +"$ref": "ListAgentConnectivityTemplatesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single AgentConnectivityTemplate.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates/{agentConnectivityTemplatesId}", +"httpMethod": "PATCH", +"id": "networkservices.projects.locations.agentConnectivityTemplates.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agentConnectivityTemplates/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the AgentConnectivityTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "AgentConnectivityTemplate" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "agentGateways": { "methods": { "create": { @@ -3277,9 +3444,82 @@ } } }, -"revision": "20260626", +"revision": "20260724", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { +"AgentConnectivityTemplate": { +"description": "AgentConnectivityTemplate represents a reusable network configuration.", +"id": "AgentConnectivityTemplate", +"properties": { +"accessPath": { +"description": "Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.", +"enum": [ +"ACCESS_PATH_UNSPECIFIED", +"CLIENT_TO_AGENT", +"AGENT_TO_ANYWHERE" +], +"enumDescriptions": [ +"Unspecified access path.", +"Protect connection to Agent or Tool.", +"Govern agent connections to destinations." +], +"type": "string" +}, +"accessTypes": { +"description": "Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.", +"items": { +"enum": [ +"ACCESS_TYPE_UNSPECIFIED", +"PUBLIC", +"PRIVATE" +], +"enumDescriptions": [ +"Unspecified access type.", +"Public network access.", +"Private network access." +], +"type": "string" +}, +"type": "array" +}, +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A free-text description of the resource. Max length 1024 characters.", +"type": "string" +}, +"egressNetworkConfig": { +"$ref": "EgressNetworkConfig", +"description": "Optional. Configuration for egress network traffic." +}, +"etag": { +"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Set of label tags associated with the AgentConnectivityTemplate resource.", +"type": "object" +}, +"name": { +"description": "Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the resource was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "AgentGateway": { "description": "AgentGateway represents the agent gateway resource.", "id": "AgentGateway", @@ -3459,6 +3699,13 @@ "resourceUri": { "description": "Optional. A supported Google Cloud networking proxy in the Project and Location", "type": "string" +}, +"resourceUris": { +"description": "Optional. List of supported Google Cloud networking proxies in the Project and Location. resource_uris is mutually exclusive with resource_uri.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -3468,7 +3715,7 @@ "id": "AuthzExtension", "properties": { "authority": { -"description": "Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service or a wasm plugin.", +"description": "Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. It is required when the `service` field points to a backend service.", "type": "string" }, "createTime": { @@ -3507,7 +3754,7 @@ "type": "object" }, "loadBalancingScheme": { -"description": "Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", +"description": "Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. The supported values are `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. You can omit this field for `AuthzExtensions` resources that don't reference a backend service. For more information, see [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", "enum": [ "LOAD_BALANCING_SCHEME_UNSPECIFIED", "INTERNAL_MANAGED", @@ -3533,7 +3780,7 @@ "type": "string" }, "service": { -"description": "Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.", +"description": "Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ.", "type": "string" }, "timeout": { @@ -3570,6 +3817,82 @@ "properties": {}, "type": "object" }, +"DnsPeeringConfig": { +"description": "DNS Peering configuration.", +"id": "DnsPeeringConfig", +"properties": { +"domain": { +"description": "Optional. The domain to peer.", +"type": "string" +}, +"targetNetwork": { +"description": "Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}", +"type": "string" +} +}, +"type": "object" +}, +"EgressNetworkConfig": { +"id": "EgressNetworkConfig", +"properties": { +"dnsPeeringConfig": { +"$ref": "DnsPeeringConfig", +"description": "Optional. DNS Peering configuration." +}, +"networkAttachment": { +"description": "Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}", +"type": "string" +}, +"tlsConfig": { +"$ref": "EgressNetworkConfigTlsConfig", +"description": "Optional. The TLS configuration for the egress traffic." +}, +"trustConfig": { +"description": "Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}", +"type": "string" +}, +"vpcEgress": { +"description": "Optional. The VPC egress setting.", +"enum": [ +"VPC_EGRESS_UNSPECIFIED", +"ALL_TRAFFIC", +"PRIVATE_RANGES_ONLY" +], +"enumDescriptions": [ +"Unspecified", +"All outbound traffic is routed through the VPC connector.", +"Only private IP ranges are routed through the VPC connector." +], +"type": "string" +} +}, +"type": "object" +}, +"EgressNetworkConfigTlsConfig": { +"description": "Configuration for TLS connections.", +"id": "EgressNetworkConfigTlsConfig", +"properties": { +"additionalRoots": { +"description": "Optional. The additional roots to trust.", +"enum": [ +"ADDITIONAL_ROOTS_UNSPECIFIED", +"NO_ADDITIONAL_ROOTS", +"PUBLICLY_TRUSTED_ROOTS" +], +"enumDescriptions": [ +"Unspecified additional roots.", +"Trust only the certificates provided in `trust_config`.", +"Trust certificates provided in `trust_config` and publicly trusted roots." +], +"type": "string" +}, +"trustConfig": { +"description": "Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}", +"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", @@ -3596,7 +3919,8 @@ "type": "string" }, "clientTlsPolicy": { -"description": "Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY.", +"deprecated": true, +"description": "Optional. Deprecated: This field is not used and is a no-op. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY.", "type": "string" }, "createTime": { @@ -5100,6 +5424,31 @@ }, "type": "object" }, +"ListAgentConnectivityTemplatesResponse": { +"description": "Response returned by the ListAgentConnectivityTemplates method.", +"id": "ListAgentConnectivityTemplatesResponse", +"properties": { +"agentConnectivityTemplates": { +"description": "List of AgentConnectivityTemplate resources.", +"items": { +"$ref": "AgentConnectivityTemplate" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListAgentGatewaysResponse": { "description": "Response returned by the ListAgentGateways method.", "id": "ListAgentGatewaysResponse", From df59027642c3cdb29f401143ea8fae30bfc635dd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:07 +0000 Subject: [PATCH 66/84] feat(oracledatabase): update the api #### oracledatabase:v1 The following keys were deleted: - schemas.CloudExadataInfrastructureProperties.properties.databaseServerType.readOnly (Total Keys: 1) - schemas.CloudExadataInfrastructureProperties.properties.storageServerType.readOnly (Total Keys: 1) The following keys were added: - schemas.DbSystemShape.properties.availableCoreCount (Total Keys: 2) - schemas.DbSystemShape.properties.coreCountIncrement (Total Keys: 2) - schemas.DbSystemShape.properties.minimumCoreCount (Total Keys: 2) - schemas.ExadbVmCluster.properties.identityConnector (Total Keys: 2) --- ...locations.cloudExadataInfrastructures.html | 12 ++--- ..._v1.projects.locations.dbSystemShapes.html | 5 +- ...abase_v1.projects.locations.dbSystems.html | 24 ++++----- ...v1.projects.locations.exadbVmClusters.html | 16 ++++++ ...base_v1.projects.locations.giVersions.html | 2 +- ...ts.locations.giVersions.minorVersions.html | 2 +- .../documents/oracledatabase.v1.json | 49 ++++++++++++++----- 7 files changed, 76 insertions(+), 34 deletions(-) diff --git a/docs/dyn/oracledatabase_v1.projects.locations.cloudExadataInfrastructures.html b/docs/dyn/oracledatabase_v1.projects.locations.cloudExadataInfrastructures.html index de835b4d79..35ccd21e35 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.cloudExadataInfrastructures.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.cloudExadataInfrastructures.html @@ -180,7 +180,7 @@

Method Details

}, ], "dataStorageSizeTb": 3.14, # Output only. Size, in terabytes, of the DATA disk group. - "databaseServerType": "A String", # Output only. The database server type of the Exadata Infrastructure. + "databaseServerType": "A String", # Optional. The database server type of the Exadata Infrastructure. "dbNodeStorageSizeGb": 42, # Output only. The local node storage allocated in GBs. "dbServerVersion": "A String", # Output only. The software version of the database servers (dom0) in the Exadata Infrastructure. "exascaleConfig": { # Details of the Exascale configuration for the Exadata Infrastructure. # Output only. The Exascale configuration for the Exadata Infrastructure. @@ -221,7 +221,7 @@

Method Details

"shape": "A String", # Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. "state": "A String", # Output only. The current lifecycle state of the Exadata Infrastructure. "storageCount": 42, # Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure. - "storageServerType": "A String", # Output only. The storage server type of the Exadata Infrastructure. + "storageServerType": "A String", # Optional. The storage server type of the Exadata Infrastructure. "storageServerVersion": "A String", # Output only. The software version of the storage servers (cells) in the Exadata Infrastructure. "totalStorageSizeGb": 42, # Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB). }, @@ -331,7 +331,7 @@

Method Details

}, ], "dataStorageSizeTb": 3.14, # Output only. Size, in terabytes, of the DATA disk group. - "databaseServerType": "A String", # Output only. The database server type of the Exadata Infrastructure. + "databaseServerType": "A String", # Optional. The database server type of the Exadata Infrastructure. "dbNodeStorageSizeGb": 42, # Output only. The local node storage allocated in GBs. "dbServerVersion": "A String", # Output only. The software version of the database servers (dom0) in the Exadata Infrastructure. "exascaleConfig": { # Details of the Exascale configuration for the Exadata Infrastructure. # Output only. The Exascale configuration for the Exadata Infrastructure. @@ -372,7 +372,7 @@

Method Details

"shape": "A String", # Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. "state": "A String", # Output only. The current lifecycle state of the Exadata Infrastructure. "storageCount": 42, # Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure. - "storageServerType": "A String", # Output only. The storage server type of the Exadata Infrastructure. + "storageServerType": "A String", # Optional. The storage server type of the Exadata Infrastructure. "storageServerVersion": "A String", # Output only. The software version of the storage servers (cells) in the Exadata Infrastructure. "totalStorageSizeGb": 42, # Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB). }, @@ -421,7 +421,7 @@

Method Details

}, ], "dataStorageSizeTb": 3.14, # Output only. Size, in terabytes, of the DATA disk group. - "databaseServerType": "A String", # Output only. The database server type of the Exadata Infrastructure. + "databaseServerType": "A String", # Optional. The database server type of the Exadata Infrastructure. "dbNodeStorageSizeGb": 42, # Output only. The local node storage allocated in GBs. "dbServerVersion": "A String", # Output only. The software version of the database servers (dom0) in the Exadata Infrastructure. "exascaleConfig": { # Details of the Exascale configuration for the Exadata Infrastructure. # Output only. The Exascale configuration for the Exadata Infrastructure. @@ -462,7 +462,7 @@

Method Details

"shape": "A String", # Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. "state": "A String", # Output only. The current lifecycle state of the Exadata Infrastructure. "storageCount": 42, # Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure. - "storageServerType": "A String", # Output only. The storage server type of the Exadata Infrastructure. + "storageServerType": "A String", # Optional. The storage server type of the Exadata Infrastructure. "storageServerVersion": "A String", # Output only. The software version of the storage servers (cells) in the Exadata Infrastructure. "totalStorageSizeGb": 42, # Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB). }, diff --git a/docs/dyn/oracledatabase_v1.projects.locations.dbSystemShapes.html b/docs/dyn/oracledatabase_v1.projects.locations.dbSystemShapes.html index 7971c403e1..ba794c7b70 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.dbSystemShapes.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.dbSystemShapes.html @@ -95,7 +95,7 @@

Method Details

Args: parent: string, Required. The parent value for Database System Shapes in the following format: projects/{project}/locations/{location}. (required) - filter: string, Optional. An expression for filtering the results of the request. Only the gcp_oracle_zone_id field is supported in this format: `gcp_oracle_zone_id="{gcp_oracle_zone_id}"`. + filter: string, Optional. An expression for filtering the results of the request. The `gcp_oracle_zone_id`, `shape_family`, and `database_edition` fields are supported in the following format: `gcp_oracle_zone_id="{gcp_oracle_zone_id}" AND shape_family="{shape_family}" AND database_edition="{database_edition}"`. pageSize: integer, Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. pageToken: string, Optional. A token identifying a page of results the server should return. x__xgafv: string, V1 error format. @@ -109,9 +109,11 @@

Method Details

{ # The response for `DbSystemShape.List`. "dbSystemShapes": [ # The list of Database System shapes. { # Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/ + "availableCoreCount": 42, # Optional. Available core count. "availableCoreCountPerNode": 42, # Optional. Number of cores per node. "availableDataStorageTb": 42, # Optional. Storage per storage server in terabytes. "availableMemoryPerNodeGb": 42, # Optional. Memory per database server node in gigabytes. + "coreCountIncrement": 42, # Optional. Core count increment. "maxNodeCount": 42, # Optional. Maximum number of database servers. "maxStorageCount": 42, # Optional. Maximum number of storage servers. "minCoreCountPerNode": 42, # Optional. Minimum core count per node. @@ -119,6 +121,7 @@

Method Details

"minMemoryPerNodeGb": 42, # Optional. Minimum memory per node in gigabytes. "minNodeCount": 42, # Optional. Minimum number of database servers. "minStorageCount": 42, # Optional. Minimum number of storage servers. + "minimumCoreCount": 42, # Optional. Minimum core count per node. "name": "A String", # Identifier. The name of the Database System Shape resource with the format: projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape} "shape": "A String", # Optional. shape }, diff --git a/docs/dyn/oracledatabase_v1.projects.locations.dbSystems.html b/docs/dyn/oracledatabase_v1.projects.locations.dbSystems.html index 620a32e751..ecb0162cf7 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.dbSystems.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.dbSystems.html @@ -126,7 +126,7 @@

Method Details

"isDiagnosticsEventsEnabled": True or False, # Optional. Indicates whether to enable data collection for diagnostics. "isIncidentLogsEnabled": True or False, # Optional. Indicates whether to enable incident logs and trace collection. }, - "dataStorageSizeGb": 42, # Optional. The data storage size in GB that is currently available to DbSystems. + "dataStorageSizeGb": 42, # Optional. The data storage size in GB that is currently available to DbSystems. The value is same as initial_data_storage_size_gb. This can be modified from OCI console. "databaseEdition": "A String", # Required. The database edition of the DbSystem. "dbHome": { # Details of the Database Home resource. # Optional. Details for creating a Database Home. "database": { # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/ # Required. The Database resource. @@ -182,11 +182,11 @@

Method Details

"initialDataStorageSizeGb": 42, # Required. The initial data storage size in GB. "licenseModel": "A String", # Required. The license model of the DbSystem. "lifecycleState": "A String", # Output only. State of the DbSystem. - "memorySizeGb": 42, # Optional. The memory size in GB. - "nodeCount": 42, # Optional. The number of nodes in the DbSystem. + "memorySizeGb": 42, # Optional. The memory size in GB. This value can not be set and is automatically calculated based on the number of ECPUs allocated to the DbSystem. + "nodeCount": 42, # Optional. The number of nodes to launch for a virtual machine DbSystem. By default this will be set to 1. "ocid": "A String", # Output only. OCID of the DbSystem. "privateIp": "A String", # Optional. The private IP address of the DbSystem. - "recoStorageSizeGb": 42, # Optional. The reco/redo storage size in GB. + "recoStorageSizeGb": 42, # Optional. The reco/redo storage size in GB. The value for recovery storage size is based on the available data storage size. "shape": "A String", # Required. Shape of DB System. "sshPublicKeys": [ # Required. SSH public keys to be stored with the DbSystem. "A String", @@ -298,7 +298,7 @@

Method Details

"isDiagnosticsEventsEnabled": True or False, # Optional. Indicates whether to enable data collection for diagnostics. "isIncidentLogsEnabled": True or False, # Optional. Indicates whether to enable incident logs and trace collection. }, - "dataStorageSizeGb": 42, # Optional. The data storage size in GB that is currently available to DbSystems. + "dataStorageSizeGb": 42, # Optional. The data storage size in GB that is currently available to DbSystems. The value is same as initial_data_storage_size_gb. This can be modified from OCI console. "databaseEdition": "A String", # Required. The database edition of the DbSystem. "dbHome": { # Details of the Database Home resource. # Optional. Details for creating a Database Home. "database": { # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/ # Required. The Database resource. @@ -354,11 +354,11 @@

Method Details

"initialDataStorageSizeGb": 42, # Required. The initial data storage size in GB. "licenseModel": "A String", # Required. The license model of the DbSystem. "lifecycleState": "A String", # Output only. State of the DbSystem. - "memorySizeGb": 42, # Optional. The memory size in GB. - "nodeCount": 42, # Optional. The number of nodes in the DbSystem. + "memorySizeGb": 42, # Optional. The memory size in GB. This value can not be set and is automatically calculated based on the number of ECPUs allocated to the DbSystem. + "nodeCount": 42, # Optional. The number of nodes to launch for a virtual machine DbSystem. By default this will be set to 1. "ocid": "A String", # Output only. OCID of the DbSystem. "privateIp": "A String", # Optional. The private IP address of the DbSystem. - "recoStorageSizeGb": 42, # Optional. The reco/redo storage size in GB. + "recoStorageSizeGb": 42, # Optional. The reco/redo storage size in GB. The value for recovery storage size is based on the available data storage size. "shape": "A String", # Required. Shape of DB System. "sshPublicKeys": [ # Required. SSH public keys to be stored with the DbSystem. "A String", @@ -410,7 +410,7 @@

Method Details

"isDiagnosticsEventsEnabled": True or False, # Optional. Indicates whether to enable data collection for diagnostics. "isIncidentLogsEnabled": True or False, # Optional. Indicates whether to enable incident logs and trace collection. }, - "dataStorageSizeGb": 42, # Optional. The data storage size in GB that is currently available to DbSystems. + "dataStorageSizeGb": 42, # Optional. The data storage size in GB that is currently available to DbSystems. The value is same as initial_data_storage_size_gb. This can be modified from OCI console. "databaseEdition": "A String", # Required. The database edition of the DbSystem. "dbHome": { # Details of the Database Home resource. # Optional. Details for creating a Database Home. "database": { # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/ # Required. The Database resource. @@ -466,11 +466,11 @@

Method Details

"initialDataStorageSizeGb": 42, # Required. The initial data storage size in GB. "licenseModel": "A String", # Required. The license model of the DbSystem. "lifecycleState": "A String", # Output only. State of the DbSystem. - "memorySizeGb": 42, # Optional. The memory size in GB. - "nodeCount": 42, # Optional. The number of nodes in the DbSystem. + "memorySizeGb": 42, # Optional. The memory size in GB. This value can not be set and is automatically calculated based on the number of ECPUs allocated to the DbSystem. + "nodeCount": 42, # Optional. The number of nodes to launch for a virtual machine DbSystem. By default this will be set to 1. "ocid": "A String", # Output only. OCID of the DbSystem. "privateIp": "A String", # Optional. The private IP address of the DbSystem. - "recoStorageSizeGb": 42, # Optional. The reco/redo storage size in GB. + "recoStorageSizeGb": 42, # Optional. The reco/redo storage size in GB. The value for recovery storage size is based on the available data storage size. "shape": "A String", # Required. Shape of DB System. "sshPublicKeys": [ # Required. SSH public keys to be stored with the DbSystem. "A String", diff --git a/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html b/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html index 8a7d18137e..c0799d4995 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html @@ -124,6 +124,10 @@

Method Details

"displayName": "A String", # Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters. "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the ExadbVmCluster. "gcpOracleZone": "A String", # Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault. + "identityConnector": { # The identity connector details which will allow OCI to securely access the resources in the customer project. # Output only. The identity connector details which will allow OCI to securely access the resources in the customer project. + "connectionState": "A String", # Output only. The connection state of the identity connector. + "serviceAgentEmail": "A String", # Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com` + }, "labels": { # Optional. The labels or tags associated with the ExadbVmCluster. "a_key": "A String", }, @@ -251,6 +255,10 @@

Method Details

"displayName": "A String", # Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters. "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the ExadbVmCluster. "gcpOracleZone": "A String", # Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault. + "identityConnector": { # The identity connector details which will allow OCI to securely access the resources in the customer project. # Output only. The identity connector details which will allow OCI to securely access the resources in the customer project. + "connectionState": "A String", # Output only. The connection state of the identity connector. + "serviceAgentEmail": "A String", # Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com` + }, "labels": { # Optional. The labels or tags associated with the ExadbVmCluster. "a_key": "A String", }, @@ -318,6 +326,10 @@

Method Details

"displayName": "A String", # Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters. "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the ExadbVmCluster. "gcpOracleZone": "A String", # Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault. + "identityConnector": { # The identity connector details which will allow OCI to securely access the resources in the customer project. # Output only. The identity connector details which will allow OCI to securely access the resources in the customer project. + "connectionState": "A String", # Output only. The connection state of the identity connector. + "serviceAgentEmail": "A String", # Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com` + }, "labels": { # Optional. The labels or tags associated with the ExadbVmCluster. "a_key": "A String", }, @@ -394,6 +406,10 @@

Method Details

"displayName": "A String", # Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters. "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the ExadbVmCluster. "gcpOracleZone": "A String", # Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault. + "identityConnector": { # The identity connector details which will allow OCI to securely access the resources in the customer project. # Output only. The identity connector details which will allow OCI to securely access the resources in the customer project. + "connectionState": "A String", # Output only. The connection state of the identity connector. + "serviceAgentEmail": "A String", # Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com` + }, "labels": { # Optional. The labels or tags associated with the ExadbVmCluster. "a_key": "A String", }, diff --git a/docs/dyn/oracledatabase_v1.projects.locations.giVersions.html b/docs/dyn/oracledatabase_v1.projects.locations.giVersions.html index 10e16ee99f..aa26ee3808 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.giVersions.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.giVersions.html @@ -100,7 +100,7 @@

Method Details

Args: parent: string, Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project}/locations/{location}. (required) - filter: string, Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: `shape="{shape}"`. + filter: string, Optional. An expression for filtering the results of the request. Only the `shape` and `gcp_oracle_zone_id` fields are supported in the following format: `shape="{shape}" AND gcp_oracle_zone_id="{gcp_oracle_zone_id}"`. pageSize: integer, Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. pageToken: string, Optional. A token identifying a page of results the server should return. x__xgafv: string, V1 error format. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.giVersions.minorVersions.html b/docs/dyn/oracledatabase_v1.projects.locations.giVersions.minorVersions.html index 5db9586bd7..dafb2b0e3d 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.giVersions.minorVersions.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.giVersions.minorVersions.html @@ -95,7 +95,7 @@

Method Details

Args: parent: string, Required. The parent value for the MinorVersion resource with the format: projects/{project}/locations/{location}/giVersions/{gi_version} (required) - filter: string, Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: `shape_family="{shapeFamily}" AND gcp_oracle_zone_id="{gcp_oracle_zone_id}"`. + filter: string, Optional. An expression for filtering the results of the request. Only the `shape_family` and `gcp_oracle_zone_id` fields are supported in the following format: `shape_family="{shape_family}" AND gcp_oracle_zone_id="{gcp_oracle_zone_id}"`. pageSize: integer, Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. pageToken: string, Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. x__xgafv: string, V1 error format. diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json index 5ff2c30b8d..daaed6c85c 100644 --- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json +++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json @@ -1346,7 +1346,7 @@ ], "parameters": { "filter": { -"description": "Optional. An expression for filtering the results of the request. Only the gcp_oracle_zone_id field is supported in this format: `gcp_oracle_zone_id=\"{gcp_oracle_zone_id}\"`.", +"description": "Optional. An expression for filtering the results of the request. The `gcp_oracle_zone_id`, `shape_family`, and `database_edition` fields are supported in the following format: `gcp_oracle_zone_id=\"{gcp_oracle_zone_id}\" AND shape_family=\"{shape_family}\" AND database_edition=\"{database_edition}\"`.", "location": "query", "type": "string" }, @@ -2014,7 +2014,7 @@ ], "parameters": { "filter": { -"description": "Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: `shape=\"{shape}\"`.", +"description": "Optional. An expression for filtering the results of the request. Only the `shape` and `gcp_oracle_zone_id` fields are supported in the following format: `shape=\"{shape}\" AND gcp_oracle_zone_id=\"{gcp_oracle_zone_id}\"`.", "location": "query", "type": "string" }, @@ -2059,7 +2059,7 @@ ], "parameters": { "filter": { -"description": "Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: `shape_family=\"{shapeFamily}\" AND gcp_oracle_zone_id=\"{gcp_oracle_zone_id}\"`.", +"description": "Optional. An expression for filtering the results of the request. Only the `shape_family` and `gcp_oracle_zone_id` fields are supported in the following format: `shape_family=\"{shape_family}\" AND gcp_oracle_zone_id=\"{gcp_oracle_zone_id}\"`.", "location": "query", "type": "string" }, @@ -3278,7 +3278,7 @@ } } }, -"revision": "20260629", +"revision": "20260721", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { @@ -4637,8 +4637,7 @@ "type": "number" }, "databaseServerType": { -"description": "Output only. The database server type of the Exadata Infrastructure.", -"readOnly": true, +"description": "Optional. The database server type of the Exadata Infrastructure.", "type": "string" }, "dbNodeStorageSizeGb": { @@ -4763,8 +4762,7 @@ "type": "integer" }, "storageServerType": { -"description": "Output only. The storage server type of the Exadata Infrastructure.", -"readOnly": true, +"description": "Optional. The storage server type of the Exadata Infrastructure.", "type": "string" }, "storageServerVersion": { @@ -6018,10 +6016,15 @@ "ECPU", "OCPU" ], +"enumDeprecated": [ +false, +false, +true +], "enumDescriptions": [ "The compute model is unspecified.", "The compute model is virtual.", -"The compute model is physical." +"Deprecated: This option is not supported. Please use ECPU instead. The compute model is physical." ], "type": "string" }, @@ -6030,7 +6033,7 @@ "description": "Optional. Data collection options for diagnostics." }, "dataStorageSizeGb": { -"description": "Optional. The data storage size in GB that is currently available to DbSystems.", +"description": "Optional. The data storage size in GB that is currently available to DbSystems. The value is same as initial_data_storage_size_gb. This can be modified from OCI console.", "format": "int32", "type": "integer" }, @@ -6122,12 +6125,12 @@ "type": "string" }, "memorySizeGb": { -"description": "Optional. The memory size in GB.", +"description": "Optional. The memory size in GB. This value can not be set and is automatically calculated based on the number of ECPUs allocated to the DbSystem.", "format": "int32", "type": "integer" }, "nodeCount": { -"description": "Optional. The number of nodes in the DbSystem.", +"description": "Optional. The number of nodes to launch for a virtual machine DbSystem. By default this will be set to 1.", "format": "int32", "type": "integer" }, @@ -6141,7 +6144,7 @@ "type": "string" }, "recoStorageSizeGb": { -"description": "Optional. The reco/redo storage size in GB.", +"description": "Optional. The reco/redo storage size in GB. The value for recovery storage size is based on the available data storage size.", "format": "int32", "type": "integer" }, @@ -6167,6 +6170,11 @@ "description": "Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/", "id": "DbSystemShape", "properties": { +"availableCoreCount": { +"description": "Optional. Available core count.", +"format": "int32", +"type": "integer" +}, "availableCoreCountPerNode": { "description": "Optional. Number of cores per node.", "format": "int32", @@ -6182,6 +6190,11 @@ "format": "int32", "type": "integer" }, +"coreCountIncrement": { +"description": "Optional. Core count increment.", +"format": "int32", +"type": "integer" +}, "maxNodeCount": { "description": "Optional. Maximum number of database servers.", "format": "int32", @@ -6217,6 +6230,11 @@ "format": "int32", "type": "integer" }, +"minimumCoreCount": { +"description": "Optional. Minimum core count per node.", +"format": "int32", +"type": "integer" +}, "name": { "description": "Identifier. The name of the Database System Shape resource with the format: projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape}", "type": "string" @@ -6460,6 +6478,11 @@ "readOnly": true, "type": "string" }, +"identityConnector": { +"$ref": "IdentityConnector", +"description": "Output only. The identity connector details which will allow OCI to securely access the resources in the customer project.", +"readOnly": true +}, "labels": { "additionalProperties": { "type": "string" From 8c1ffa775bffb3bcfa1315aa8a2e865ffebb3abe Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:07 +0000 Subject: [PATCH 67/84] fix(orgpolicy): update the api #### orgpolicy:v2 The following keys were changed: - resources.folders.resources.constraints.methods.list.scopes (Total Keys: 1) - resources.folders.resources.policies.methods.create.scopes (Total Keys: 1) - resources.folders.resources.policies.methods.delete.scopes (Total Keys: 1) - resources.folders.resources.policies.methods.get.scopes (Total Keys: 1) - resources.folders.resources.policies.methods.getEffectivePolicy.scopes (Total Keys: 1) - resources.folders.resources.policies.methods.list.scopes (Total Keys: 1) - resources.folders.resources.policies.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.constraints.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.customConstraints.methods.create.scopes (Total Keys: 1) - resources.organizations.resources.customConstraints.methods.delete.scopes (Total Keys: 1) - resources.organizations.resources.customConstraints.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.customConstraints.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.customConstraints.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.policies.methods.create.scopes (Total Keys: 1) - resources.organizations.resources.policies.methods.delete.scopes (Total Keys: 1) - resources.organizations.resources.policies.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.policies.methods.getEffectivePolicy.scopes (Total Keys: 1) - resources.organizations.resources.policies.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.policies.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.constraints.methods.list.scopes (Total Keys: 1) - resources.projects.resources.policies.methods.create.scopes (Total Keys: 1) - resources.projects.resources.policies.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.policies.methods.get.scopes (Total Keys: 1) - resources.projects.resources.policies.methods.getEffectivePolicy.scopes (Total Keys: 1) - resources.projects.resources.policies.methods.list.scopes (Total Keys: 1) - resources.projects.resources.policies.methods.patch.scopes (Total Keys: 1) --- .../dyn/orgpolicy_v2.folders.constraints.html | 4 +- docs/dyn/orgpolicy_v2.folders.policies.html | 20 +-- ...rgpolicy_v2.organizations.constraints.html | 4 +- .../orgpolicy_v2.organizations.policies.html | 20 +-- .../orgpolicy_v2.projects.constraints.html | 4 +- docs/dyn/orgpolicy_v2.projects.policies.html | 20 +-- .../documents/orgpolicy.v2.json | 128 ++++++++++++------ 7 files changed, 123 insertions(+), 77 deletions(-) diff --git a/docs/dyn/orgpolicy_v2.folders.constraints.html b/docs/dyn/orgpolicy_v2.folders.constraints.html index dc4fd194a2..42e4647749 100644 --- a/docs/dyn/orgpolicy_v2.folders.constraints.html +++ b/docs/dyn/orgpolicy_v2.folders.constraints.html @@ -94,7 +94,7 @@

Method Details

Lists constraints that could be applied on the specified resource.
 
 Args:
-  parent: string, Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` (required)
+  parent: string, Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}` (required)
   pageSize: integer, Size of the pages to be returned. This is not used, but the server may at any point start using this field to limit page size.
   pageToken: string, Page token used to retrieve the next page. This is not used, but the server may at any point start using this field.
   x__xgafv: string, V1 error format.
@@ -139,7 +139,7 @@ 

Method Details

"supportsIn": True or False, # Indicates whether values grouped into categories can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"in:Python"` would match any value in the 'Python' group. "supportsUnder": True or False, # Indicates whether subtrees of the Resource Manager resource hierarchy can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"under:folders/123"` would match any resource under the 'folders/123' folder. }, - "name": "A String", # Immutable. The resource name of the constraint. Must be in one of the following forms: * `projects/{project_number}/constraints/{constraint_name}` * `folders/{folder_id}/constraints/{constraint_name}` * `organizations/{organization_id}/constraints/{constraint_name}` For example, "/projects/123/constraints/compute.disableSerialPortAccess". + "name": "A String", # Immutable. The resource name of the constraint. Must be in one of the following forms: * `projects/{project_number}/constraints/{constraint_name}` * `folders/{folder_number}/constraints/{constraint_name}` * `organizations/{organization_number}/constraints/{constraint_name}` For example, "/projects/123/constraints/compute.disableSerialPortAccess". "supportsDryRun": True or False, # Shows if dry run is supported for this constraint or not. "supportsSimulation": True or False, # Shows if simulation is supported for this constraint or not. }, diff --git a/docs/dyn/orgpolicy_v2.folders.policies.html b/docs/dyn/orgpolicy_v2.folders.policies.html index b8199d0c80..4bcdcab45c 100644 --- a/docs/dyn/orgpolicy_v2.folders.policies.html +++ b/docs/dyn/orgpolicy_v2.folders.policies.html @@ -109,7 +109,7 @@

Method Details

Creates a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy already exists on the given Google Cloud resource.
 
 Args:
-  parent: string, Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` (required)
+  parent: string, Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -178,7 +178,7 @@ 

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -284,7 +284,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -416,7 +416,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -529,7 +529,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -568,7 +568,7 @@

Method Details

Retrieves all of the policies that exist on a particular resource.
 
 Args:
-  parent: string, Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` (required)
+  parent: string, Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}` (required)
   pageSize: integer, Size of the pages to be returned. This is not used, but the server may at any point start using this field to limit page size.
   pageToken: string, Page token used to retrieve the next page. This is not used, but the server may at any point start using this field.
   x__xgafv: string, V1 error format.
@@ -647,7 +647,7 @@ 

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -702,7 +702,7 @@

Method Details

Updates a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint or the policy doesn't exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the ETag supplied in the request doesn't match the persisted ETag of the policy. Note: the supplied policy will perform a full overwrite of all fields.
 
 Args:
-  name: string, Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. (required)
+  name: string, Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -771,7 +771,7 @@ 

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -878,7 +878,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. diff --git a/docs/dyn/orgpolicy_v2.organizations.constraints.html b/docs/dyn/orgpolicy_v2.organizations.constraints.html index 27491c9fc7..17a2e25a56 100644 --- a/docs/dyn/orgpolicy_v2.organizations.constraints.html +++ b/docs/dyn/orgpolicy_v2.organizations.constraints.html @@ -94,7 +94,7 @@

Method Details

Lists constraints that could be applied on the specified resource.
 
 Args:
-  parent: string, Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` (required)
+  parent: string, Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}` (required)
   pageSize: integer, Size of the pages to be returned. This is not used, but the server may at any point start using this field to limit page size.
   pageToken: string, Page token used to retrieve the next page. This is not used, but the server may at any point start using this field.
   x__xgafv: string, V1 error format.
@@ -139,7 +139,7 @@ 

Method Details

"supportsIn": True or False, # Indicates whether values grouped into categories can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"in:Python"` would match any value in the 'Python' group. "supportsUnder": True or False, # Indicates whether subtrees of the Resource Manager resource hierarchy can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"under:folders/123"` would match any resource under the 'folders/123' folder. }, - "name": "A String", # Immutable. The resource name of the constraint. Must be in one of the following forms: * `projects/{project_number}/constraints/{constraint_name}` * `folders/{folder_id}/constraints/{constraint_name}` * `organizations/{organization_id}/constraints/{constraint_name}` For example, "/projects/123/constraints/compute.disableSerialPortAccess". + "name": "A String", # Immutable. The resource name of the constraint. Must be in one of the following forms: * `projects/{project_number}/constraints/{constraint_name}` * `folders/{folder_number}/constraints/{constraint_name}` * `organizations/{organization_number}/constraints/{constraint_name}` For example, "/projects/123/constraints/compute.disableSerialPortAccess". "supportsDryRun": True or False, # Shows if dry run is supported for this constraint or not. "supportsSimulation": True or False, # Shows if simulation is supported for this constraint or not. }, diff --git a/docs/dyn/orgpolicy_v2.organizations.policies.html b/docs/dyn/orgpolicy_v2.organizations.policies.html index 52309e43b3..d6e86e6852 100644 --- a/docs/dyn/orgpolicy_v2.organizations.policies.html +++ b/docs/dyn/orgpolicy_v2.organizations.policies.html @@ -109,7 +109,7 @@

Method Details

Creates a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy already exists on the given Google Cloud resource.
 
 Args:
-  parent: string, Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` (required)
+  parent: string, Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -178,7 +178,7 @@ 

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -284,7 +284,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -416,7 +416,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -529,7 +529,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -568,7 +568,7 @@

Method Details

Retrieves all of the policies that exist on a particular resource.
 
 Args:
-  parent: string, Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` (required)
+  parent: string, Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}` (required)
   pageSize: integer, Size of the pages to be returned. This is not used, but the server may at any point start using this field to limit page size.
   pageToken: string, Page token used to retrieve the next page. This is not used, but the server may at any point start using this field.
   x__xgafv: string, V1 error format.
@@ -647,7 +647,7 @@ 

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -702,7 +702,7 @@

Method Details

Updates a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint or the policy doesn't exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the ETag supplied in the request doesn't match the persisted ETag of the policy. Note: the supplied policy will perform a full overwrite of all fields.
 
 Args:
-  name: string, Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. (required)
+  name: string, Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -771,7 +771,7 @@ 

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -878,7 +878,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. diff --git a/docs/dyn/orgpolicy_v2.projects.constraints.html b/docs/dyn/orgpolicy_v2.projects.constraints.html index 251a7f3106..83e793fc28 100644 --- a/docs/dyn/orgpolicy_v2.projects.constraints.html +++ b/docs/dyn/orgpolicy_v2.projects.constraints.html @@ -94,7 +94,7 @@

Method Details

Lists constraints that could be applied on the specified resource.
 
 Args:
-  parent: string, Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` (required)
+  parent: string, Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}` (required)
   pageSize: integer, Size of the pages to be returned. This is not used, but the server may at any point start using this field to limit page size.
   pageToken: string, Page token used to retrieve the next page. This is not used, but the server may at any point start using this field.
   x__xgafv: string, V1 error format.
@@ -139,7 +139,7 @@ 

Method Details

"supportsIn": True or False, # Indicates whether values grouped into categories can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"in:Python"` would match any value in the 'Python' group. "supportsUnder": True or False, # Indicates whether subtrees of the Resource Manager resource hierarchy can be used in `Policy.allowed_values` and `Policy.denied_values`. For example, `"under:folders/123"` would match any resource under the 'folders/123' folder. }, - "name": "A String", # Immutable. The resource name of the constraint. Must be in one of the following forms: * `projects/{project_number}/constraints/{constraint_name}` * `folders/{folder_id}/constraints/{constraint_name}` * `organizations/{organization_id}/constraints/{constraint_name}` For example, "/projects/123/constraints/compute.disableSerialPortAccess". + "name": "A String", # Immutable. The resource name of the constraint. Must be in one of the following forms: * `projects/{project_number}/constraints/{constraint_name}` * `folders/{folder_number}/constraints/{constraint_name}` * `organizations/{organization_number}/constraints/{constraint_name}` For example, "/projects/123/constraints/compute.disableSerialPortAccess". "supportsDryRun": True or False, # Shows if dry run is supported for this constraint or not. "supportsSimulation": True or False, # Shows if simulation is supported for this constraint or not. }, diff --git a/docs/dyn/orgpolicy_v2.projects.policies.html b/docs/dyn/orgpolicy_v2.projects.policies.html index 6c67bfb50e..66e07b7732 100644 --- a/docs/dyn/orgpolicy_v2.projects.policies.html +++ b/docs/dyn/orgpolicy_v2.projects.policies.html @@ -109,7 +109,7 @@

Method Details

Creates a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy already exists on the given Google Cloud resource.
 
 Args:
-  parent: string, Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` (required)
+  parent: string, Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -178,7 +178,7 @@ 

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -284,7 +284,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -416,7 +416,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -529,7 +529,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -568,7 +568,7 @@

Method Details

Retrieves all of the policies that exist on a particular resource.
 
 Args:
-  parent: string, Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` (required)
+  parent: string, Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}` (required)
   pageSize: integer, Size of the pages to be returned. This is not used, but the server may at any point start using this field to limit page size.
   pageToken: string, Page token used to retrieve the next page. This is not used, but the server may at any point start using this field.
   x__xgafv: string, V1 error format.
@@ -647,7 +647,7 @@ 

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -702,7 +702,7 @@

Method Details

Updates a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint or the policy doesn't exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the ETag supplied in the request doesn't match the persisted ETag of the policy. Note: the supplied policy will perform a full overwrite of all fields.
 
 Args:
-  name: string, Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. (required)
+  name: string, Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -771,7 +771,7 @@ 

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -878,7 +878,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. diff --git a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json index c523747827..44833d5640 100644 --- a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json +++ b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json @@ -4,6 +4,12 @@ "scopes": { "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." +}, +"https://www.googleapis.com/auth/organizationpolicy": { +"description": "See, edit, configure, and delete your Google Cloud Organization Policy data and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/organizationpolicy.readonly": { +"description": "See your Google Cloud Organization Policy data and the email address of your Google Account" } } } @@ -130,7 +136,7 @@ "type": "string" }, "parent": { -"description": "Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`", +"description": "Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}`", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -142,7 +148,9 @@ "$ref": "GoogleCloudOrgpolicyV2ListConstraintsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] } } @@ -159,7 +167,7 @@ ], "parameters": { "parent": { -"description": "Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`", +"description": "Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}`", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -174,7 +182,8 @@ "$ref": "GoogleCloudOrgpolicyV2Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy" ] }, "delete": { @@ -204,7 +213,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy" ] }, "get": { @@ -229,7 +239,9 @@ "$ref": "GoogleCloudOrgpolicyV2Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] }, "getEffectivePolicy": { @@ -254,7 +266,9 @@ "$ref": "GoogleCloudOrgpolicyV2Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] }, "list": { @@ -278,7 +292,7 @@ "type": "string" }, "parent": { -"description": "Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`", +"description": "Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}`", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -290,7 +304,9 @@ "$ref": "GoogleCloudOrgpolicyV2ListPoliciesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] }, "patch": { @@ -303,7 +319,7 @@ ], "parameters": { "name": { -"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", +"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", "location": "path", "pattern": "^folders/[^/]+/policies/[^/]+$", "required": true, @@ -324,7 +340,8 @@ "$ref": "GoogleCloudOrgpolicyV2Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy" ] } } @@ -356,7 +373,7 @@ "type": "string" }, "parent": { -"description": "Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`", +"description": "Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -368,7 +385,9 @@ "$ref": "GoogleCloudOrgpolicyV2ListConstraintsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] } } @@ -400,7 +419,8 @@ "$ref": "GoogleCloudOrgpolicyV2CustomConstraint" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy" ] }, "delete": { @@ -425,7 +445,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy" ] }, "get": { @@ -450,7 +471,9 @@ "$ref": "GoogleCloudOrgpolicyV2CustomConstraint" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] }, "list": { @@ -486,7 +509,9 @@ "$ref": "GoogleCloudOrgpolicyV2ListCustomConstraintsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] }, "patch": { @@ -514,7 +539,8 @@ "$ref": "GoogleCloudOrgpolicyV2CustomConstraint" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy" ] } } @@ -531,7 +557,7 @@ ], "parameters": { "parent": { -"description": "Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`", +"description": "Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -546,7 +572,8 @@ "$ref": "GoogleCloudOrgpolicyV2Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy" ] }, "delete": { @@ -576,7 +603,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy" ] }, "get": { @@ -601,7 +629,9 @@ "$ref": "GoogleCloudOrgpolicyV2Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] }, "getEffectivePolicy": { @@ -626,7 +656,9 @@ "$ref": "GoogleCloudOrgpolicyV2Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] }, "list": { @@ -650,7 +682,7 @@ "type": "string" }, "parent": { -"description": "Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`", +"description": "Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -662,7 +694,9 @@ "$ref": "GoogleCloudOrgpolicyV2ListPoliciesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] }, "patch": { @@ -675,7 +709,7 @@ ], "parameters": { "name": { -"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", +"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", "location": "path", "pattern": "^organizations/[^/]+/policies/[^/]+$", "required": true, @@ -696,7 +730,8 @@ "$ref": "GoogleCloudOrgpolicyV2Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy" ] } } @@ -728,7 +763,7 @@ "type": "string" }, "parent": { -"description": "Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`", +"description": "Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}`", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -740,7 +775,9 @@ "$ref": "GoogleCloudOrgpolicyV2ListConstraintsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] } } @@ -757,7 +794,7 @@ ], "parameters": { "parent": { -"description": "Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`", +"description": "Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}`", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -772,7 +809,8 @@ "$ref": "GoogleCloudOrgpolicyV2Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy" ] }, "delete": { @@ -802,7 +840,8 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy" ] }, "get": { @@ -827,7 +866,9 @@ "$ref": "GoogleCloudOrgpolicyV2Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] }, "getEffectivePolicy": { @@ -852,7 +893,9 @@ "$ref": "GoogleCloudOrgpolicyV2Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] }, "list": { @@ -876,7 +919,7 @@ "type": "string" }, "parent": { -"description": "Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`", +"description": "Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * `projects/{project_number}` * `projects/{project_id}` * `folders/{folder_number}` * `organizations/{organization_number}`", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -888,7 +931,9 @@ "$ref": "GoogleCloudOrgpolicyV2ListPoliciesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy", +"https://www.googleapis.com/auth/organizationpolicy.readonly" ] }, "patch": { @@ -901,7 +946,7 @@ ], "parameters": { "name": { -"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", +"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", "location": "path", "pattern": "^projects/[^/]+/policies/[^/]+$", "required": true, @@ -922,7 +967,8 @@ "$ref": "GoogleCloudOrgpolicyV2Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/organizationpolicy" ] } } @@ -930,7 +976,7 @@ } } }, -"revision": "20260504", +"revision": "20260723", "rootUrl": "https://orgpolicy.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -987,7 +1033,7 @@ "description": "Defines this constraint as being a list constraint." }, "name": { -"description": "Immutable. The resource name of the constraint. Must be in one of the following forms: * `projects/{project_number}/constraints/{constraint_name}` * `folders/{folder_id}/constraints/{constraint_name}` * `organizations/{organization_id}/constraints/{constraint_name}` For example, \"/projects/123/constraints/compute.disableSerialPortAccess\".", +"description": "Immutable. The resource name of the constraint. Must be in one of the following forms: * `projects/{project_number}/constraints/{constraint_name}` * `folders/{folder_number}/constraints/{constraint_name}` * `organizations/{organization_number}/constraints/{constraint_name}` For example, \"/projects/123/constraints/compute.disableSerialPortAccess\".", "type": "string" }, "supportsDryRun": { @@ -1296,7 +1342,7 @@ "type": "string" }, "name": { -"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", +"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", "type": "string" }, "spec": { From 60b8b0542f6a79bf7640d22827edc26836824344 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:07 +0000 Subject: [PATCH 68/84] feat(places): update the api #### places:v1 The following keys were added: - schemas.GoogleMapsPlacesV1Place.properties.entrances (Total Keys: 2) - schemas.GoogleMapsPlacesV1Place.properties.navigationPoints (Total Keys: 2) - schemas.GoogleMapsPlacesV1PlaceEntrance (Total Keys: 5) - schemas.GoogleMapsPlacesV1PlaceNavigationPoint (Total Keys: 9) --- docs/dyn/places_v1.places.html | 90 +++++++++++++++++ .../discovery_cache/documents/places.v1.json | 97 ++++++++++++++++++- 2 files changed, 186 insertions(+), 1 deletion(-) diff --git a/docs/dyn/places_v1.places.html b/docs/dyn/places_v1.places.html index 5e946d7ff8..54cc90698f 100644 --- a/docs/dyn/places_v1.places.html +++ b/docs/dyn/places_v1.places.html @@ -445,6 +445,17 @@

Method Details

"languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "text": "A String", # Localized string in the language corresponding to language_code below. }, + "entrances": [ # Entrances for this destination. + { # An entrance is a single latitude/longitude coordinate pair that defines the location of an entry and exit point for a place. + "location": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the entrance. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "tags": [ # A list of tags that describe the entrance. + "A String", + ], + }, + ], "evChargeAmenitySummary": { # The summary of amenities near the EV charging station. This only applies to places with type `electric_vehicle_charging_station`. The `overview` field is guaranteed to be provided while the other fields are optional. # The summary of amenities near the EV charging station. "coffee": { # A block of content that can be served individually. # A summary of the nearby coffee options. "content": { # Localized variant of a text in a particular language. # Content related to the topic. @@ -555,6 +566,25 @@

Method Details

"movedPlaceId": "A String", # If this Place is permanently closed and has moved to a new Place, this field contains the new Place's place ID. If this Place moved multiple times, this field will represent the first moved Place. This field will not be populated if this Place has not moved. "name": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. "nationalPhoneNumber": "A String", # A human-readable phone number for the place, in national format. + "navigationPoints": [ # Navigation points for this destination. + { # A navigation point is a location next to a road where navigation can end. + "displayName": { # Localized variant of a text in a particular language. # The display name of this navigation point. For example, "5th Ave" or "Gate B". + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "location": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A point next to the road segment where navigation should end. The point is intentionally slightly offset from the road's centerline to clearly mark the side of the road where the place is located. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "navigationPointToken": "A String", # A token that can be used to identify this navigation point. + "travelModes": [ # Travel modes that are appropriate for this navigation point. + "A String", + ], + "usages": [ # Lists `usages` supported by this navigation point. If empty, it does not necessarily mean its usage is restricted in any way. All navigation points can be used for general navigation. + "A String", + ], + }, + ], "neighborhoodSummary": { # A summary of points of interest near the place. # A summary of points of interest near the place. "description": { # A block of content that can be served individually. # A detailed description of the neighborhood. "content": { # Localized variant of a text in a particular language. # Content related to the topic. @@ -1137,6 +1167,17 @@

Method Details

"languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "text": "A String", # Localized string in the language corresponding to language_code below. }, + "entrances": [ # Entrances for this destination. + { # An entrance is a single latitude/longitude coordinate pair that defines the location of an entry and exit point for a place. + "location": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the entrance. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "tags": [ # A list of tags that describe the entrance. + "A String", + ], + }, + ], "evChargeAmenitySummary": { # The summary of amenities near the EV charging station. This only applies to places with type `electric_vehicle_charging_station`. The `overview` field is guaranteed to be provided while the other fields are optional. # The summary of amenities near the EV charging station. "coffee": { # A block of content that can be served individually. # A summary of the nearby coffee options. "content": { # Localized variant of a text in a particular language. # Content related to the topic. @@ -1247,6 +1288,25 @@

Method Details

"movedPlaceId": "A String", # If this Place is permanently closed and has moved to a new Place, this field contains the new Place's place ID. If this Place moved multiple times, this field will represent the first moved Place. This field will not be populated if this Place has not moved. "name": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. "nationalPhoneNumber": "A String", # A human-readable phone number for the place, in national format. + "navigationPoints": [ # Navigation points for this destination. + { # A navigation point is a location next to a road where navigation can end. + "displayName": { # Localized variant of a text in a particular language. # The display name of this navigation point. For example, "5th Ave" or "Gate B". + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "location": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A point next to the road segment where navigation should end. The point is intentionally slightly offset from the road's centerline to clearly mark the side of the road where the place is located. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "navigationPointToken": "A String", # A token that can be used to identify this navigation point. + "travelModes": [ # Travel modes that are appropriate for this navigation point. + "A String", + ], + "usages": [ # Lists `usages` supported by this navigation point. If empty, it does not necessarily mean its usage is restricted in any way. All navigation points can be used for general navigation. + "A String", + ], + }, + ], "neighborhoodSummary": { # A summary of points of interest near the place. # A summary of points of interest near the place. "description": { # A block of content that can be served individually. # A detailed description of the neighborhood. "content": { # Localized variant of a text in a particular language. # Content related to the topic. @@ -1969,6 +2029,17 @@

Method Details

"languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "text": "A String", # Localized string in the language corresponding to language_code below. }, + "entrances": [ # Entrances for this destination. + { # An entrance is a single latitude/longitude coordinate pair that defines the location of an entry and exit point for a place. + "location": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the entrance. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "tags": [ # A list of tags that describe the entrance. + "A String", + ], + }, + ], "evChargeAmenitySummary": { # The summary of amenities near the EV charging station. This only applies to places with type `electric_vehicle_charging_station`. The `overview` field is guaranteed to be provided while the other fields are optional. # The summary of amenities near the EV charging station. "coffee": { # A block of content that can be served individually. # A summary of the nearby coffee options. "content": { # Localized variant of a text in a particular language. # Content related to the topic. @@ -2079,6 +2150,25 @@

Method Details

"movedPlaceId": "A String", # If this Place is permanently closed and has moved to a new Place, this field contains the new Place's place ID. If this Place moved multiple times, this field will represent the first moved Place. This field will not be populated if this Place has not moved. "name": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. "nationalPhoneNumber": "A String", # A human-readable phone number for the place, in national format. + "navigationPoints": [ # Navigation points for this destination. + { # A navigation point is a location next to a road where navigation can end. + "displayName": { # Localized variant of a text in a particular language. # The display name of this navigation point. For example, "5th Ave" or "Gate B". + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "location": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A point next to the road segment where navigation should end. The point is intentionally slightly offset from the road's centerline to clearly mark the side of the road where the place is located. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "navigationPointToken": "A String", # A token that can be used to identify this navigation point. + "travelModes": [ # Travel modes that are appropriate for this navigation point. + "A String", + ], + "usages": [ # Lists `usages` supported by this navigation point. If empty, it does not necessarily mean its usage is restricted in any way. All navigation points can be used for general navigation. + "A String", + ], + }, + ], "neighborhoodSummary": { # A summary of points of interest near the place. # A summary of points of interest near the place. "description": { # A block of content that can be served individually. # A detailed description of the neighborhood. "content": { # Localized variant of a text in a particular language. # Content related to the topic. diff --git a/googleapiclient/discovery_cache/documents/places.v1.json b/googleapiclient/discovery_cache/documents/places.v1.json index 0b256906e8..1e8a32cf32 100644 --- a/googleapiclient/discovery_cache/documents/places.v1.json +++ b/googleapiclient/discovery_cache/documents/places.v1.json @@ -280,7 +280,7 @@ } } }, -"revision": "20260601", +"revision": "20260729", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -1102,6 +1102,13 @@ "$ref": "GoogleTypeLocalizedText", "description": "Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered." }, +"entrances": { +"description": "Entrances for this destination.", +"items": { +"$ref": "GoogleMapsPlacesV1PlaceEntrance" +}, +"type": "array" +}, "evChargeAmenitySummary": { "$ref": "GoogleMapsPlacesV1PlaceEvChargeAmenitySummary", "description": "The summary of amenities near the EV charging station." @@ -1190,6 +1197,13 @@ "description": "A human-readable phone number for the place, in national format.", "type": "string" }, +"navigationPoints": { +"description": "Navigation points for this destination.", +"items": { +"$ref": "GoogleMapsPlacesV1PlaceNavigationPoint" +}, +"type": "array" +}, "neighborhoodSummary": { "$ref": "GoogleMapsPlacesV1PlaceNeighborhoodSummary", "description": "A summary of points of interest near the place." @@ -1519,6 +1533,32 @@ }, "type": "object" }, +"GoogleMapsPlacesV1PlaceEntrance": { +"description": "An entrance is a single latitude/longitude coordinate pair that defines the location of an entry and exit point for a place.", +"id": "GoogleMapsPlacesV1PlaceEntrance", +"properties": { +"location": { +"$ref": "GoogleTypeLatLng", +"description": "The location of the entrance." +}, +"tags": { +"description": "A list of tags that describe the entrance.", +"items": { +"enum": [ +"TAG_UNSPECIFIED", +"PREFERRED" +], +"enumDescriptions": [ +"Not used.", +"The entrance likely provides physical access to the primary place in the returned destination. A place can have multiple preferred entrances. If an entrance does not have this tag, it means the entrance is physically on the same building as the primary place, but does not necessarily provide access to the place. For example, if the primary place is a restaurant in a strip mall, the \"PREFERRED\" entrances will be the ones that likely lead into the restaurant itself, while the other returned entrances will be other entrances for the building, such as entrances into other restaurants in the strip mall. If the primary place is a building itself, the `PREFERRED` entrances will be the ones that lead into the \"main\" part of the building. For example, in a shopping center the `PREFERRED` entrances will be the ones that allow access to the main foyer area, but if an entrance only provides access to a store on the side of the building, it won't be a `PREFERRED` entrance. Note: a `PREFERRED` entrance might not provide access to the primary place, and a non-`PREFERRED` entrance might provide access to the primary place." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleMapsPlacesV1PlaceEvChargeAmenitySummary": { "description": "The summary of amenities near the EV charging station. This only applies to places with type `electric_vehicle_charging_station`. The `overview` field is guaranteed to be provided while the other fields are optional.", "id": "GoogleMapsPlacesV1PlaceEvChargeAmenitySummary", @@ -1596,6 +1636,61 @@ }, "type": "object" }, +"GoogleMapsPlacesV1PlaceNavigationPoint": { +"description": "A navigation point is a location next to a road where navigation can end.", +"id": "GoogleMapsPlacesV1PlaceNavigationPoint", +"properties": { +"displayName": { +"$ref": "GoogleTypeLocalizedText", +"description": "The display name of this navigation point. For example, \"5th Ave\" or \"Gate B\"." +}, +"location": { +"$ref": "GoogleTypeLatLng", +"description": "A point next to the road segment where navigation should end. The point is intentionally slightly offset from the road's centerline to clearly mark the side of the road where the place is located." +}, +"navigationPointToken": { +"description": "A token that can be used to identify this navigation point.", +"type": "string" +}, +"travelModes": { +"description": "Travel modes that are appropriate for this navigation point.", +"items": { +"enum": [ +"TRAVEL_MODE_UNSPECIFIED", +"DRIVE", +"WALK" +], +"enumDescriptions": [ +"Not used.", +"Suitable for driving.", +"Suitable for walking." +], +"type": "string" +}, +"type": "array" +}, +"usages": { +"description": "Lists `usages` supported by this navigation point. If empty, it does not necessarily mean its usage is restricted in any way. All navigation points can be used for general navigation.", +"items": { +"enum": [ +"USAGE_UNSPECIFIED", +"DROPOFF", +"PICKUP", +"PARKING" +], +"enumDescriptions": [ +"Not used.", +"Suitable for dropping off a passenger. For example, a rideshare drop off location.", +"Suitable for picking up a passenger. For example, a rideshare pick up location.", +"Suitable for parking. For example, within a parking lot." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleMapsPlacesV1PlaceNeighborhoodSummary": { "description": "A summary of points of interest near the place.", "id": "GoogleMapsPlacesV1PlaceNeighborhoodSummary", From da9502e958a57b80ed1bacb78a6606bec18b0a84 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:07 +0000 Subject: [PATCH 69/84] feat(realtimebidding): update the api #### realtimebidding:v1 The following keys were added: - schemas.PretargetingConfig.properties.allowedUserTargetingModes.deprecated (Total Keys: 1) --- ...idding_v1.bidders.pretargetingConfigs.html | 28 +++++++++---------- .../documents/realtimebidding.v1.json | 5 ++-- 2 files changed, 17 insertions(+), 16 deletions(-) diff --git a/docs/dyn/realtimebidding_v1.bidders.pretargetingConfigs.html b/docs/dyn/realtimebidding_v1.bidders.pretargetingConfigs.html index fb7cd037e5..cf5cba3984 100644 --- a/docs/dyn/realtimebidding_v1.bidders.pretargetingConfigs.html +++ b/docs/dyn/realtimebidding_v1.bidders.pretargetingConfigs.html @@ -141,7 +141,7 @@

Method Details

An object of the form: { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). @@ -261,7 +261,7 @@

Method Details

An object of the form: { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). @@ -381,7 +381,7 @@

Method Details

An object of the form: { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). @@ -501,7 +501,7 @@

Method Details

An object of the form: { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). @@ -611,7 +611,7 @@

Method Details

The object takes the form of: { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). @@ -714,7 +714,7 @@

Method Details

An object of the form: { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). @@ -842,7 +842,7 @@

Method Details

An object of the form: { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). @@ -957,7 +957,7 @@

Method Details

"nextPageToken": "A String", # A token which can be passed to a subsequent call to the `ListPretargetingConfigs` method to retrieve the next page of results in ListPretargetingConfigsRequest.pageToken. "pretargetingConfigs": [ # List of pretargeting configurations. { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). @@ -1078,7 +1078,7 @@

Method Details

The object takes the form of: { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). @@ -1182,7 +1182,7 @@

Method Details

An object of the form: { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). @@ -1301,7 +1301,7 @@

Method Details

An object of the form: { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). @@ -1420,7 +1420,7 @@

Method Details

An object of the form: { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). @@ -1539,7 +1539,7 @@

Method Details

An object of the form: { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). @@ -1655,7 +1655,7 @@

Method Details

An object of the form: { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + "allowedUserTargetingModes": [ # Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index 7069339f63..2ec3f4909e 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -1305,7 +1305,7 @@ } } }, -"revision": "20260427", +"revision": "20260716", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { @@ -2800,7 +2800,8 @@ false "id": "PretargetingConfig", "properties": { "allowedUserTargetingModes": { -"description": "Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.", +"deprecated": true, +"description": "Deprecated: The value of this field no longer has any effect. Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.", "items": { "enum": [ "USER_TARGETING_MODE_UNSPECIFIED", From ef24b22484a0ea70087c2862a1ae8fe5ddde2cf0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:07 +0000 Subject: [PATCH 70/84] feat(recaptchaenterprise): update the api #### recaptchaenterprise:v1 The following keys were added: - resources.projects.resources.keys.methods.getPolicy (Total Keys: 11) - resources.projects.resources.keys.methods.updatePolicy (Total Keys: 15) - schemas.GoogleCloudRecaptchaenterpriseV1Assessment.properties.policyEvaluation (Total Keys: 2) - schemas.GoogleCloudRecaptchaenterpriseV1ChallengeRule (Total Keys: 18) - schemas.GoogleCloudRecaptchaenterpriseV1ClientSettings (Total Keys: 6) - schemas.GoogleCloudRecaptchaenterpriseV1Key.properties.universalSettings.$ref (Total Keys: 1) - schemas.GoogleCloudRecaptchaenterpriseV1Policy (Total Keys: 10) - schemas.GoogleCloudRecaptchaenterpriseV1ProtectedEndpoint (Total Keys: 8) - schemas.GoogleCloudRecaptchaenterpriseV1RiskAnalysis.properties.lastChallengeType (Total Keys: 2) - schemas.GoogleCloudRecaptchaenterpriseV1UniversalKeySettings (Total Keys: 2) --- ...chaenterprise_v1.projects.assessments.html | 46 +-- .../recaptchaenterprise_v1.projects.keys.html | 159 ++++++++++ .../documents/recaptchaenterprise.v1.json | 277 +++++++++++++++++- 3 files changed, 452 insertions(+), 30 deletions(-) diff --git a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html index 135cce1acd..f9a62d1c05 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html @@ -139,16 +139,16 @@

Method Details

The object takes the form of: { # A reCAPTCHA Enterprise assessment resource. - "accountDefenderAssessment": { # Account defender risk assessment. # Output only. Assessment returned by account defender when an account identifier is provided. + "accountDefenderAssessment": { # Account defense risk assessment. # Output only. Assessment returned by Account defense when an account identifier is provided. "accountTakeoverVerdict": { # Account takeover risk assessment. # Output only. Account takeover risk assessment for this request. "risk": 3.14, # Output only. Account takeover attempt probability. Values are from 0.0 (lowest risk) to 1.0 (highest risk). "riskReasons": [ # Output only. Unordered list. Reasons why the request appears risky. Risk reasons can be returned even if the risk is low, as trustworthy requests can still have some risk signals. - { # Risk explainability reasons for account defender. + { # Risk explainability reasons for Account defense. "reason": "A String", # Output only. A risk reason associated with this request. }, ], "trustReasons": [ # Output only. Unordered list. Reasons why the request appears trustworthy. Trust reasons can be returned even if the risk is high, as risky requests can still have some trust signals. - { # Trust explainability reasons for account defender. + { # Trust explainability reasons for Account defense. "reason": "A String", # Output only. A trust reason associated with this request. }, ], @@ -175,7 +175,7 @@

Method Details

"version": "A String", # Optional. The version of the client module. For example, "1.0.0". }, "event": { # The event being assessed. # Optional. The event being assessed. - "expectedAction": "A String", # Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise. + "expectedAction": "A String", # Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise. Required for Universal keys. "express": True or False, # Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference an Express site key. "firewallPolicyEvaluation": True or False, # Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy is evaluated and a suggested firewall action is returned in the response. "fraudPrevention": "A String", # Optional. The Fraud Prevention setting for this assessment. @@ -218,7 +218,7 @@

Method Details

], "merchants": [ # Optional. Information about the user or users fulfilling the transaction. { # Details about a user's account involved in the transaction. - "accountId": "A String", # Optional. Unique account identifier for this user. If using account defender, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account. + "accountId": "A String", # Optional. Unique account identifier for this user. If using Account defense, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account. "creationMs": "A String", # Optional. The epoch milliseconds of the user's account creation. "email": "A String", # Optional. The email address of the user. "emailVerified": True or False, # Optional. Whether the email has been verified to be accessible by the user (OTP or similar). @@ -240,7 +240,7 @@

Method Details

"shippingValue": 3.14, # Optional. The value of shipping in the specified currency. 0 for free or no shipping. "transactionId": "A String", # Unique identifier for the transaction. This custom identifier can be used to reference this transaction in the future, for example, labeling a refund or chargeback event. Two attempts at the same transaction should use the same transaction id. "user": { # Details about a user's account involved in the transaction. # Optional. Information about the user paying/initiating the transaction. - "accountId": "A String", # Optional. Unique account identifier for this user. If using account defender, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account. + "accountId": "A String", # Optional. Unique account identifier for this user. If using Account defense, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account. "creationMs": "A String", # Optional. The epoch milliseconds of the user's account creation. "email": "A String", # Optional. The email address of the user. "emailVerified": True or False, # Optional. Whether the email has been verified to be accessible by the user (OTP or similar). @@ -329,7 +329,7 @@

Method Details

}, }, "name": "A String", # Output only. Identifier. The resource name for the Assessment in the format `projects/{project}/assessments/{assessment}`. - "phoneFraudAssessment": { # Assessment for Phone Fraud # Output only. Assessment returned when a site key, a token, and a phone number as `user_id` are provided. Account defender and SMS toll fraud protection need to be enabled. + "phoneFraudAssessment": { # Assessment for Phone Fraud # Output only. Assessment returned when a site key, a token, and a phone number as `user_id` are provided. SMS defense needs to be enabled. "smsTollFraudVerdict": { # Information about SMS toll fraud. # Output only. Assessment of this phone event for risk of SMS toll fraud. "reasons": [ # Output only. Reasons contributing to the SMS toll fraud verdict. "A String", @@ -337,6 +337,10 @@

Method Details

"risk": 3.14, # Output only. Probability of an SMS event being fraudulent. Values are from 0.0 (lowest) to 1.0 (highest). }, }, + "policyEvaluation": { # Information about the policy evaluation. # Output only. Provides information about the policy evaluation for this assessment. + "challengeRuleEvaluation": { # Information about the evaluation of a `ChallengeRule`. # Output only. Populated if one or more Challenge rules were matched. Its presence in the assessment indicates that at least one challenge rule was matched and determined whether a challenge was presented to the user. + }, + }, "privatePasswordLeakVerification": { # Private password leak verification info. # Optional. The private password leak verification field contains the parameters that are used to to check for leaks privately without sharing user credentials. "encryptedLeakMatchPrefixes": [ # Output only. List of prefixes of the encrypted potential password leaks that matched the given parameters. They must be compared with the client-side decryption prefix of `reencrypted_user_credentials_hash` "A String", @@ -346,10 +350,11 @@

Method Details

"reencryptedUserCredentialsHash": "A String", # Output only. Corresponds to the re-encryption of the `encrypted_user_credentials_hash` field. It is used to match potential password leaks within `encrypted_leak_match_prefixes`. }, "riskAnalysis": { # Risk analysis result for an event. # Output only. The risk analysis result for the event being assessed. - "challenge": "A String", # Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys. + "challenge": "A String", # Output only. Challenge information for Universal, `POLICY_BASED_CHALLENGE` and `INVISIBLE` keys. "extendedVerdictReasons": [ # Output only. Additional reasons contributing to the risk analysis verdict. These reasons are available to Enterprise tier projects only. Contact sales for more information. The set of reasons is subject to change. "A String", ], + "lastChallengeType": "A String", # Output only. Type of the last challenge presented to the user for Universal, `POLICY_BASED_CHALLENGE` and `INVISIBLE` keys. The field is only set when a challenge was presented to the user. "reasons": [ # Output only. Reasons contributing to the risk analysis verdict. "A String", ], @@ -357,7 +362,7 @@

Method Details

"verifiedBots": [ # Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event. { # Bot information and metadata. "botType": "A String", # Optional. Enumerated field representing the type of bot. - "name": "A String", # Optional. Enumerated string value that indicates the identity of the bot, formatted in kebab-case. Current example values include the following: * google-agent * browser-base * chat-gpt * aws-bedrock * cybaa-bot * cloudflare * payhawk Ensure that your applications can handle identifier values not explicitly listed here. Deprecated values might take some time to stop showing up in responses. New values can be pushed so this list should be taken as non exhaustive. + "name": "A String", # Optional. Enumerated string value that indicates the identity of the bot, formatted in kebab-case. Current example values include the following: * google-agent - AI_AGENT * browser-base - AI_AGENT * chat-gpt - AI_AGENT * aws-bedrock - AI_AGENT * cybaa-bot - AI_AGENT * cloudflare - AI_AGENT * payhawk - AI_AGENT * duck-duck-go - SEARCH_INDEXER * mediaboard - CONTENT_SCRAPER * marker-io - AI_AGENT * broadcom - AI_AGENT * anchor-browser - AI_AGENT * shopify - AI_AGENT * stackscope - CONTENT_SCRAPER * manus - AI_AGENT * kernel-sh - AI_AGENT * zvelo - SEARCH_INDEXER Ensure that your applications can handle identifier values not explicitly listed here. Deprecated values might take some time to stop showing up in responses. New values can be pushed so this list should be taken as non exhaustive. }, ], }, @@ -381,16 +386,16 @@

Method Details

An object of the form: { # A reCAPTCHA Enterprise assessment resource. - "accountDefenderAssessment": { # Account defender risk assessment. # Output only. Assessment returned by account defender when an account identifier is provided. + "accountDefenderAssessment": { # Account defense risk assessment. # Output only. Assessment returned by Account defense when an account identifier is provided. "accountTakeoverVerdict": { # Account takeover risk assessment. # Output only. Account takeover risk assessment for this request. "risk": 3.14, # Output only. Account takeover attempt probability. Values are from 0.0 (lowest risk) to 1.0 (highest risk). "riskReasons": [ # Output only. Unordered list. Reasons why the request appears risky. Risk reasons can be returned even if the risk is low, as trustworthy requests can still have some risk signals. - { # Risk explainability reasons for account defender. + { # Risk explainability reasons for Account defense. "reason": "A String", # Output only. A risk reason associated with this request. }, ], "trustReasons": [ # Output only. Unordered list. Reasons why the request appears trustworthy. Trust reasons can be returned even if the risk is high, as risky requests can still have some trust signals. - { # Trust explainability reasons for account defender. + { # Trust explainability reasons for Account defense. "reason": "A String", # Output only. A trust reason associated with this request. }, ], @@ -417,7 +422,7 @@

Method Details

"version": "A String", # Optional. The version of the client module. For example, "1.0.0". }, "event": { # The event being assessed. # Optional. The event being assessed. - "expectedAction": "A String", # Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise. + "expectedAction": "A String", # Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise. Required for Universal keys. "express": True or False, # Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference an Express site key. "firewallPolicyEvaluation": True or False, # Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy is evaluated and a suggested firewall action is returned in the response. "fraudPrevention": "A String", # Optional. The Fraud Prevention setting for this assessment. @@ -460,7 +465,7 @@

Method Details

], "merchants": [ # Optional. Information about the user or users fulfilling the transaction. { # Details about a user's account involved in the transaction. - "accountId": "A String", # Optional. Unique account identifier for this user. If using account defender, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account. + "accountId": "A String", # Optional. Unique account identifier for this user. If using Account defense, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account. "creationMs": "A String", # Optional. The epoch milliseconds of the user's account creation. "email": "A String", # Optional. The email address of the user. "emailVerified": True or False, # Optional. Whether the email has been verified to be accessible by the user (OTP or similar). @@ -482,7 +487,7 @@

Method Details

"shippingValue": 3.14, # Optional. The value of shipping in the specified currency. 0 for free or no shipping. "transactionId": "A String", # Unique identifier for the transaction. This custom identifier can be used to reference this transaction in the future, for example, labeling a refund or chargeback event. Two attempts at the same transaction should use the same transaction id. "user": { # Details about a user's account involved in the transaction. # Optional. Information about the user paying/initiating the transaction. - "accountId": "A String", # Optional. Unique account identifier for this user. If using account defender, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account. + "accountId": "A String", # Optional. Unique account identifier for this user. If using Account defense, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account. "creationMs": "A String", # Optional. The epoch milliseconds of the user's account creation. "email": "A String", # Optional. The email address of the user. "emailVerified": True or False, # Optional. Whether the email has been verified to be accessible by the user (OTP or similar). @@ -571,7 +576,7 @@

Method Details

}, }, "name": "A String", # Output only. Identifier. The resource name for the Assessment in the format `projects/{project}/assessments/{assessment}`. - "phoneFraudAssessment": { # Assessment for Phone Fraud # Output only. Assessment returned when a site key, a token, and a phone number as `user_id` are provided. Account defender and SMS toll fraud protection need to be enabled. + "phoneFraudAssessment": { # Assessment for Phone Fraud # Output only. Assessment returned when a site key, a token, and a phone number as `user_id` are provided. SMS defense needs to be enabled. "smsTollFraudVerdict": { # Information about SMS toll fraud. # Output only. Assessment of this phone event for risk of SMS toll fraud. "reasons": [ # Output only. Reasons contributing to the SMS toll fraud verdict. "A String", @@ -579,6 +584,10 @@

Method Details

"risk": 3.14, # Output only. Probability of an SMS event being fraudulent. Values are from 0.0 (lowest) to 1.0 (highest). }, }, + "policyEvaluation": { # Information about the policy evaluation. # Output only. Provides information about the policy evaluation for this assessment. + "challengeRuleEvaluation": { # Information about the evaluation of a `ChallengeRule`. # Output only. Populated if one or more Challenge rules were matched. Its presence in the assessment indicates that at least one challenge rule was matched and determined whether a challenge was presented to the user. + }, + }, "privatePasswordLeakVerification": { # Private password leak verification info. # Optional. The private password leak verification field contains the parameters that are used to to check for leaks privately without sharing user credentials. "encryptedLeakMatchPrefixes": [ # Output only. List of prefixes of the encrypted potential password leaks that matched the given parameters. They must be compared with the client-side decryption prefix of `reencrypted_user_credentials_hash` "A String", @@ -588,10 +597,11 @@

Method Details

"reencryptedUserCredentialsHash": "A String", # Output only. Corresponds to the re-encryption of the `encrypted_user_credentials_hash` field. It is used to match potential password leaks within `encrypted_leak_match_prefixes`. }, "riskAnalysis": { # Risk analysis result for an event. # Output only. The risk analysis result for the event being assessed. - "challenge": "A String", # Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys. + "challenge": "A String", # Output only. Challenge information for Universal, `POLICY_BASED_CHALLENGE` and `INVISIBLE` keys. "extendedVerdictReasons": [ # Output only. Additional reasons contributing to the risk analysis verdict. These reasons are available to Enterprise tier projects only. Contact sales for more information. The set of reasons is subject to change. "A String", ], + "lastChallengeType": "A String", # Output only. Type of the last challenge presented to the user for Universal, `POLICY_BASED_CHALLENGE` and `INVISIBLE` keys. The field is only set when a challenge was presented to the user. "reasons": [ # Output only. Reasons contributing to the risk analysis verdict. "A String", ], @@ -599,7 +609,7 @@

Method Details

"verifiedBots": [ # Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event. { # Bot information and metadata. "botType": "A String", # Optional. Enumerated field representing the type of bot. - "name": "A String", # Optional. Enumerated string value that indicates the identity of the bot, formatted in kebab-case. Current example values include the following: * google-agent * browser-base * chat-gpt * aws-bedrock * cybaa-bot * cloudflare * payhawk Ensure that your applications can handle identifier values not explicitly listed here. Deprecated values might take some time to stop showing up in responses. New values can be pushed so this list should be taken as non exhaustive. + "name": "A String", # Optional. Enumerated string value that indicates the identity of the bot, formatted in kebab-case. Current example values include the following: * google-agent - AI_AGENT * browser-base - AI_AGENT * chat-gpt - AI_AGENT * aws-bedrock - AI_AGENT * cybaa-bot - AI_AGENT * cloudflare - AI_AGENT * payhawk - AI_AGENT * duck-duck-go - SEARCH_INDEXER * mediaboard - CONTENT_SCRAPER * marker-io - AI_AGENT * broadcom - AI_AGENT * anchor-browser - AI_AGENT * shopify - AI_AGENT * stackscope - CONTENT_SCRAPER * manus - AI_AGENT * kernel-sh - AI_AGENT * zvelo - SEARCH_INDEXER Ensure that your applications can handle identifier values not explicitly listed here. Deprecated values might take some time to stop showing up in responses. New values can be pushed so this list should be taken as non exhaustive. }, ], }, diff --git a/docs/dyn/recaptchaenterprise_v1.projects.keys.html b/docs/dyn/recaptchaenterprise_v1.projects.keys.html index 55a8d8960d..a0e4525da4 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.keys.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.keys.html @@ -92,6 +92,9 @@

Instance Methods

getMetrics(name, x__xgafv=None)

Get some aggregated metrics for a Key. This data can be used to build dashboards.

+

+ getPolicy(name, x__xgafv=None)

+

Get the policy for a key.

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

Returns the list of all keys that belong to a project.

@@ -116,6 +119,9 @@

Instance Methods

retrieveLegacySecretKey(x__xgafv=None)

Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

+

+ updatePolicy(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the policy for a key.

Method Details

addIpOverride(name, body=None, x__xgafv=None) @@ -190,6 +196,8 @@

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "universalSettings": { # Settings for keys that are configured through their Policy. # Settings for keys that are configured through their Policy. + }, "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. @@ -254,6 +262,8 @@

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "universalSettings": { # Settings for keys that are configured through their Policy. # Settings for keys that are configured through their Policy. + }, "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. @@ -343,6 +353,8 @@

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "universalSettings": { # Settings for keys that are configured through their Policy. # Settings for keys that are configured through their Policy. + }, "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. @@ -413,6 +425,56 @@

Method Details

}
+
+ getPolicy(name, x__xgafv=None) +
Get the policy for a key.
+
+Args:
+  name: string, Required. The name of the policy to get, in the format `projects/{project}/keys/{key}/policy`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A complete configuration set containing multiple grouped rules defining the behavior of reCAPTCHA for fraud detection and prevention.
+  "challengeRuleGroups": [ # Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.
+    { # A collection of challenge rules that applies to one or more actions.
+      "actions": [ # Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.
+        "A String",
+      ],
+      "challengeRules": [ # Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.
+        { # A rule to configure the behavior of reCAPTCHA for conditionally presenting a challenge.
+          "challenge": { # An outcome that indicates that a challenge of a specified difficulty should be presented to the user. # Present a challenge to the user.
+            "difficulty": "A String", # Optional. The difficulty of the challenge to present to the user. If unspecified, `BALANCE` is used.
+          },
+          "condition": "A String", # Optional. A CEL condition that must be met for this rule to apply. If unspecified, the rule applies unconditionally. The following fields can be referenced in the condition: * `score` * `user_ip_address` * `user_asn` * `user_agent` * `verified_bots.name` * `verified_bots.bot_type` Examples: * `score < 0.5` * `user_ip_address == "123.45.67.89"` * `user_agent.contains("Chrome")` * `score < 0.5 && user_ip_address == "123.45.67.89"`
+          "noChallenge": { # An outcome that indicates that no challenge should be presented to the user. # Do not present a challenge to the user.
+          },
+        },
+      ],
+    },
+  ],
+  "clientSettings": { # Configuration for clients to protect with reCAPTCHA. # Required. Configuration for clients protected by this policy.
+    "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
+    "allowedDomains": [ # Optional. Domains or subdomains of websites allowed to use the policy. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com' Each policy supports a maximum of 250 domains. To use a policy on more domains, set `allow_all_domains` to true. When this is set, you are responsible for validating the hostname by checking the `token_properties.hostname` field in each assessment response against your list of allowed domains.
+      "A String",
+    ],
+    "protectedEndpointGroup": { # Configuration for API endpoints to protect with reCAPTCHA. # Optional. Configuration for all API endpoints to protect with reCAPTCHA. If this field is not set, reCAPTCHA will not automatically request tokens on any API endpoints.
+      "protectedEndpoints": [ # Optional. List of API endpoints to automatically protect with reCAPTCHA. If any of these endpoints is invoked from a page where a key bound to this policy is installed, a reCAPTCHA token is automatically generated and attached to the request. If multiple protected endpoints match a given API endpoint, the first one in the list is used.
+        { # Configuration for an API endpoint to protect with reCAPTCHA.
+          "action": "A String", # Required. Action name to be used for token generation for this endpoint. The action name can only contain alphanumeric characters, slashes, and underscores.
+          "path": "A String", # Required. URI path of the API endpoint to protect. Must start with '/'. Supports glob characters '*' to match a single path segment and '**' to match multiple path segments. Standalone root catch-alls ('/*' and '/**') are invalid because it can negatively impact performance to trigger reCAPTCHA on every single request to your backend. Matching is evaluated against the URL path only (domain, scheme, and query parameters are ignored). Examples: - `/login` matches `/login`, `https://example.com/login`, and `/login?query=1`, but not `/login/step1`. - `/products/*` matches `/products/123`, but not `/products/123/456`. - `/content/**` matches `/content/articles/2024/01/01`.
+        },
+      ],
+    },
+  },
+  "name": "A String", # Identifier. Resource name for this policy. Format: "projects/{project}/keys/{key}/policy" for a policy under a key.
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all keys that belong to a project.
@@ -462,6 +524,8 @@ 

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "universalSettings": { # Settings for keys that are configured through their Policy. # Settings for keys that are configured through their Policy. + }, "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. @@ -598,6 +662,8 @@

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "universalSettings": { # Settings for keys that are configured through their Policy. # Settings for keys that are configured through their Policy. + }, "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. @@ -664,6 +730,8 @@

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "universalSettings": { # Settings for keys that are configured through their Policy. # Settings for keys that are configured through their Policy. + }, "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. @@ -729,6 +797,8 @@

Method Details

"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. "testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. }, + "universalSettings": { # Settings for keys that are configured through their Policy. # Settings for keys that are configured through their Policy. + }, "wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for Web Application Firewall (WAF). "wafFeature": "A String", # Required. The Web Application Firewall (WAF) feature for which this key is enabled. "wafService": "A String", # Required. The Web Application Firewall (WAF) service that uses this key. @@ -801,4 +871,93 @@

Method Details

}
+
+ updatePolicy(name, body=None, updateMask=None, x__xgafv=None) +
Updates the policy for a key.
+
+Args:
+  name: string, Identifier. Resource name for this policy. Format: "projects/{project}/keys/{key}/policy" for a policy under a key. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A complete configuration set containing multiple grouped rules defining the behavior of reCAPTCHA for fraud detection and prevention.
+  "challengeRuleGroups": [ # Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.
+    { # A collection of challenge rules that applies to one or more actions.
+      "actions": [ # Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.
+        "A String",
+      ],
+      "challengeRules": [ # Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.
+        { # A rule to configure the behavior of reCAPTCHA for conditionally presenting a challenge.
+          "challenge": { # An outcome that indicates that a challenge of a specified difficulty should be presented to the user. # Present a challenge to the user.
+            "difficulty": "A String", # Optional. The difficulty of the challenge to present to the user. If unspecified, `BALANCE` is used.
+          },
+          "condition": "A String", # Optional. A CEL condition that must be met for this rule to apply. If unspecified, the rule applies unconditionally. The following fields can be referenced in the condition: * `score` * `user_ip_address` * `user_asn` * `user_agent` * `verified_bots.name` * `verified_bots.bot_type` Examples: * `score < 0.5` * `user_ip_address == "123.45.67.89"` * `user_agent.contains("Chrome")` * `score < 0.5 && user_ip_address == "123.45.67.89"`
+          "noChallenge": { # An outcome that indicates that no challenge should be presented to the user. # Do not present a challenge to the user.
+          },
+        },
+      ],
+    },
+  ],
+  "clientSettings": { # Configuration for clients to protect with reCAPTCHA. # Required. Configuration for clients protected by this policy.
+    "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
+    "allowedDomains": [ # Optional. Domains or subdomains of websites allowed to use the policy. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com' Each policy supports a maximum of 250 domains. To use a policy on more domains, set `allow_all_domains` to true. When this is set, you are responsible for validating the hostname by checking the `token_properties.hostname` field in each assessment response against your list of allowed domains.
+      "A String",
+    ],
+    "protectedEndpointGroup": { # Configuration for API endpoints to protect with reCAPTCHA. # Optional. Configuration for all API endpoints to protect with reCAPTCHA. If this field is not set, reCAPTCHA will not automatically request tokens on any API endpoints.
+      "protectedEndpoints": [ # Optional. List of API endpoints to automatically protect with reCAPTCHA. If any of these endpoints is invoked from a page where a key bound to this policy is installed, a reCAPTCHA token is automatically generated and attached to the request. If multiple protected endpoints match a given API endpoint, the first one in the list is used.
+        { # Configuration for an API endpoint to protect with reCAPTCHA.
+          "action": "A String", # Required. Action name to be used for token generation for this endpoint. The action name can only contain alphanumeric characters, slashes, and underscores.
+          "path": "A String", # Required. URI path of the API endpoint to protect. Must start with '/'. Supports glob characters '*' to match a single path segment and '**' to match multiple path segments. Standalone root catch-alls ('/*' and '/**') are invalid because it can negatively impact performance to trigger reCAPTCHA on every single request to your backend. Matching is evaluated against the URL path only (domain, scheme, and query parameters are ignored). Examples: - `/login` matches `/login`, `https://example.com/login`, and `/login?query=1`, but not `/login/step1`. - `/products/*` matches `/products/123`, but not `/products/123/456`. - `/content/**` matches `/content/articles/2024/01/01`.
+        },
+      ],
+    },
+  },
+  "name": "A String", # Identifier. Resource name for this policy. Format: "projects/{project}/keys/{key}/policy" for a policy under a key.
+}
+
+  updateMask: string, Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields are updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A complete configuration set containing multiple grouped rules defining the behavior of reCAPTCHA for fraud detection and prevention.
+  "challengeRuleGroups": [ # Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.
+    { # A collection of challenge rules that applies to one or more actions.
+      "actions": [ # Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.
+        "A String",
+      ],
+      "challengeRules": [ # Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.
+        { # A rule to configure the behavior of reCAPTCHA for conditionally presenting a challenge.
+          "challenge": { # An outcome that indicates that a challenge of a specified difficulty should be presented to the user. # Present a challenge to the user.
+            "difficulty": "A String", # Optional. The difficulty of the challenge to present to the user. If unspecified, `BALANCE` is used.
+          },
+          "condition": "A String", # Optional. A CEL condition that must be met for this rule to apply. If unspecified, the rule applies unconditionally. The following fields can be referenced in the condition: * `score` * `user_ip_address` * `user_asn` * `user_agent` * `verified_bots.name` * `verified_bots.bot_type` Examples: * `score < 0.5` * `user_ip_address == "123.45.67.89"` * `user_agent.contains("Chrome")` * `score < 0.5 && user_ip_address == "123.45.67.89"`
+          "noChallenge": { # An outcome that indicates that no challenge should be presented to the user. # Do not present a challenge to the user.
+          },
+        },
+      ],
+    },
+  ],
+  "clientSettings": { # Configuration for clients to protect with reCAPTCHA. # Required. Configuration for clients protected by this policy.
+    "allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
+    "allowedDomains": [ # Optional. Domains or subdomains of websites allowed to use the policy. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com' Each policy supports a maximum of 250 domains. To use a policy on more domains, set `allow_all_domains` to true. When this is set, you are responsible for validating the hostname by checking the `token_properties.hostname` field in each assessment response against your list of allowed domains.
+      "A String",
+    ],
+    "protectedEndpointGroup": { # Configuration for API endpoints to protect with reCAPTCHA. # Optional. Configuration for all API endpoints to protect with reCAPTCHA. If this field is not set, reCAPTCHA will not automatically request tokens on any API endpoints.
+      "protectedEndpoints": [ # Optional. List of API endpoints to automatically protect with reCAPTCHA. If any of these endpoints is invoked from a page where a key bound to this policy is installed, a reCAPTCHA token is automatically generated and attached to the request. If multiple protected endpoints match a given API endpoint, the first one in the list is used.
+        { # Configuration for an API endpoint to protect with reCAPTCHA.
+          "action": "A String", # Required. Action name to be used for token generation for this endpoint. The action name can only contain alphanumeric characters, slashes, and underscores.
+          "path": "A String", # Required. URI path of the API endpoint to protect. Must start with '/'. Supports glob characters '*' to match a single path segment and '**' to match multiple path segments. Standalone root catch-alls ('/*' and '/**') are invalid because it can negatively impact performance to trigger reCAPTCHA on every single request to your backend. Matching is evaluated against the URL path only (domain, scheme, and query parameters are ignored). Examples: - `/login` matches `/login`, `https://example.com/login`, and `/login?query=1`, but not `/login/step1`. - `/products/*` matches `/products/123`, but not `/products/123/456`. - `/content/**` matches `/content/articles/2024/01/01`.
+        },
+      ],
+    },
+  },
+  "name": "A String", # Identifier. Resource name for this policy. Format: "projects/{project}/keys/{key}/policy" for a policy under a key.
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 4e44a387c1..0053f840ca 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -480,6 +480,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getPolicy": { +"description": "Get the policy for a key.", +"flatPath": "v1/projects/{projectsId}/keys/{keysId}/policy", +"httpMethod": "GET", +"id": "recaptchaenterprise.projects.keys.getPolicy", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the policy to get, in the format `projects/{project}/keys/{key}/policy`.", +"location": "path", +"pattern": "^projects/[^/]+/keys/[^/]+/policy$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudRecaptchaenterpriseV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Returns the list of all keys that belong to a project.", "flatPath": "v1/projects/{projectsId}/keys", @@ -666,6 +691,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"updatePolicy": { +"description": "Updates the policy for a key.", +"flatPath": "v1/projects/{projectsId}/keys/{keysId}/policy", +"httpMethod": "PATCH", +"id": "recaptchaenterprise.projects.keys.updatePolicy", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Resource name for this policy. Format: \"projects/{project}/keys/{key}/policy\" for a policy under a key.", +"location": "path", +"pattern": "^projects/[^/]+/keys/[^/]+/policy$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields are updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudRecaptchaenterpriseV1Policy" +}, +"response": { +"$ref": "GoogleCloudRecaptchaenterpriseV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -786,11 +845,11 @@ } } }, -"revision": "20260517", +"revision": "20260719", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { -"description": "Account defender risk assessment.", +"description": "Account defense risk assessment.", "id": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment", "properties": { "accountTakeoverVerdict": { @@ -824,7 +883,7 @@ "type": "object" }, "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountRiskReason": { -"description": "Risk explainability reasons for account defender.", +"description": "Risk explainability reasons for Account defense.", "id": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountRiskReason", "properties": { "reason": { @@ -879,7 +938,7 @@ "type": "object" }, "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountTrustReason": { -"description": "Trust explainability reasons for account defender.", +"description": "Trust explainability reasons for Account defense.", "id": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountTrustReason", "properties": { "reason": { @@ -887,12 +946,16 @@ "enum": [ "TRUST_REASON_UNSPECIFIED", "PROFILE_MATCH", -"ACCOUNT_HISTORY_REPUTABLE" +"ACCOUNT_HISTORY_REPUTABLE", +"IDENTITY_GLOBAL_ACTIVITY_REPUTABLE", +"IDENTITY_HISTORY_REPUTABLE" ], "enumDescriptions": [ "Default unspecified type.", "The request matches a trusted profile associated with this account. Equivalent to `AccountDefenderLabel.PROFILE_MATCH`.", -"The account's historical activity is reputable. It is unlikely that the account has been compromised in the past." +"The account's historical activity is reputable. It is unlikely that the account has been compromised in the past.", +"The identity shows a global pattern of reputable activity based on `userInfo` and associated identifiers.", +"The identity shows a long-standing history of reputable activity based on `userInfo` and associated identifiers." ], "readOnly": true, "type": "string" @@ -1112,7 +1175,7 @@ true "properties": { "accountDefenderAssessment": { "$ref": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment", -"description": "Output only. Assessment returned by account defender when an account identifier is provided.", +"description": "Output only. Assessment returned by Account defense when an account identifier is provided.", "readOnly": true }, "accountVerification": { @@ -1149,7 +1212,12 @@ true }, "phoneFraudAssessment": { "$ref": "GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment", -"description": "Output only. Assessment returned when a site key, a token, and a phone number as `user_id` are provided. Account defender and SMS toll fraud protection need to be enabled.", +"description": "Output only. Assessment returned when a site key, a token, and a phone number as `user_id` are provided. SMS defense needs to be enabled.", +"readOnly": true +}, +"policyEvaluation": { +"$ref": "GoogleCloudRecaptchaenterpriseV1PolicyEvaluation", +"description": "Output only. Provides information about the policy evaluation for this assessment.", "readOnly": true }, "privatePasswordLeakVerification": { @@ -1205,7 +1273,7 @@ true "type": "string" }, "name": { -"description": "Optional. Enumerated string value that indicates the identity of the bot, formatted in kebab-case. Current example values include the following: * google-agent * browser-base * chat-gpt * aws-bedrock * cybaa-bot * cloudflare * payhawk Ensure that your applications can handle identifier values not explicitly listed here. Deprecated values might take some time to stop showing up in responses. New values can be pushed so this list should be taken as non exhaustive.", +"description": "Optional. Enumerated string value that indicates the identity of the bot, formatted in kebab-case. Current example values include the following: * google-agent - AI_AGENT * browser-base - AI_AGENT * chat-gpt - AI_AGENT * aws-bedrock - AI_AGENT * cybaa-bot - AI_AGENT * cloudflare - AI_AGENT * payhawk - AI_AGENT * duck-duck-go - SEARCH_INDEXER * mediaboard - CONTENT_SCRAPER * marker-io - AI_AGENT * broadcom - AI_AGENT * anchor-browser - AI_AGENT * shopify - AI_AGENT * stackscope - CONTENT_SCRAPER * manus - AI_AGENT * kernel-sh - AI_AGENT * zvelo - SEARCH_INDEXER Ensure that your applications can handle identifier values not explicitly listed here. Deprecated values might take some time to stop showing up in responses. New values can be pushed so this list should be taken as non exhaustive.", "type": "string" } }, @@ -1238,6 +1306,103 @@ true }, "type": "object" }, +"GoogleCloudRecaptchaenterpriseV1ChallengeRule": { +"description": "A rule to configure the behavior of reCAPTCHA for conditionally presenting a challenge.", +"id": "GoogleCloudRecaptchaenterpriseV1ChallengeRule", +"properties": { +"challenge": { +"$ref": "GoogleCloudRecaptchaenterpriseV1ChallengeRuleChallengeOutcome", +"description": "Present a challenge to the user." +}, +"condition": { +"description": "Optional. A CEL condition that must be met for this rule to apply. If unspecified, the rule applies unconditionally. The following fields can be referenced in the condition: * `score` * `user_ip_address` * `user_asn` * `user_agent` * `verified_bots.name` * `verified_bots.bot_type` Examples: * `score < 0.5` * `user_ip_address == \"123.45.67.89\"` * `user_agent.contains(\"Chrome\")` * `score < 0.5 && user_ip_address == \"123.45.67.89\"`", +"type": "string" +}, +"noChallenge": { +"$ref": "GoogleCloudRecaptchaenterpriseV1ChallengeRuleNoChallengeOutcome", +"description": "Do not present a challenge to the user." +} +}, +"type": "object" +}, +"GoogleCloudRecaptchaenterpriseV1ChallengeRuleChallengeOutcome": { +"description": "An outcome that indicates that a challenge of a specified difficulty should be presented to the user.", +"id": "GoogleCloudRecaptchaenterpriseV1ChallengeRuleChallengeOutcome", +"properties": { +"difficulty": { +"description": "Optional. The difficulty of the challenge to present to the user. If unspecified, `BALANCE` is used.", +"enum": [ +"CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED", +"USABILITY", +"BALANCE", +"SECURITY" +], +"enumDescriptions": [ +"Default type that indicates this enum hasn't been specified.", +"Key tends to show fewer and easier challenges.", +"Key tends to show balanced (in amount and difficulty) challenges.", +"Key tends to show more and harder challenges." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRecaptchaenterpriseV1ChallengeRuleEvaluation": { +"description": "Information about the evaluation of a `ChallengeRule`.", +"id": "GoogleCloudRecaptchaenterpriseV1ChallengeRuleEvaluation", +"properties": {}, +"type": "object" +}, +"GoogleCloudRecaptchaenterpriseV1ChallengeRuleGroup": { +"description": "A collection of challenge rules that applies to one or more actions.", +"id": "GoogleCloudRecaptchaenterpriseV1ChallengeRuleGroup", +"properties": { +"actions": { +"description": "Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If \"*\" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.", +"items": { +"type": "string" +}, +"type": "array" +}, +"challengeRules": { +"description": "Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.", +"items": { +"$ref": "GoogleCloudRecaptchaenterpriseV1ChallengeRule" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudRecaptchaenterpriseV1ChallengeRuleNoChallengeOutcome": { +"description": "An outcome that indicates that no challenge should be presented to the user.", +"id": "GoogleCloudRecaptchaenterpriseV1ChallengeRuleNoChallengeOutcome", +"properties": {}, +"type": "object" +}, +"GoogleCloudRecaptchaenterpriseV1ClientSettings": { +"description": "Configuration for clients to protect with reCAPTCHA.", +"id": "GoogleCloudRecaptchaenterpriseV1ClientSettings", +"properties": { +"allowAllDomains": { +"description": "Optional. If set to true, it means allowed_domains are not enforced.", +"type": "boolean" +}, +"allowedDomains": { +"description": "Optional. Domains or subdomains of websites allowed to use the policy. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com' Each policy supports a maximum of 250 domains. To use a policy on more domains, set `allow_all_domains` to true. When this is set, you are responsible for validating the hostname by checking the `token_properties.hostname` field in each assessment response against your list of allowed domains.", +"items": { +"type": "string" +}, +"type": "array" +}, +"protectedEndpointGroup": { +"$ref": "GoogleCloudRecaptchaenterpriseV1ProtectedEndpointGroup", +"description": "Optional. Configuration for all API endpoints to protect with reCAPTCHA. If this field is not set, reCAPTCHA will not automatically request tokens on any API endpoints." +} +}, +"type": "object" +}, "GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo": { "description": "Information about a verification endpoint that can be used for 2FA.", "id": "GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo", @@ -1269,7 +1434,7 @@ true "id": "GoogleCloudRecaptchaenterpriseV1Event", "properties": { "expectedAction": { -"description": "Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise.", +"description": "Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise. Required for Universal keys.", "type": "string" }, "express": { @@ -1736,6 +1901,10 @@ true "$ref": "GoogleCloudRecaptchaenterpriseV1TestingOptions", "description": "Optional. Options for user acceptance testing." }, +"universalSettings": { +"$ref": "GoogleCloudRecaptchaenterpriseV1UniversalKeySettings", +"description": "Settings for keys that are configured through their Policy." +}, "wafSettings": { "$ref": "GoogleCloudRecaptchaenterpriseV1WafSettings", "description": "Optional. Settings for Web Application Firewall (WAF)." @@ -1907,6 +2076,40 @@ true }, "type": "object" }, +"GoogleCloudRecaptchaenterpriseV1Policy": { +"description": "A complete configuration set containing multiple grouped rules defining the behavior of reCAPTCHA for fraud detection and prevention.", +"id": "GoogleCloudRecaptchaenterpriseV1Policy", +"properties": { +"challengeRuleGroups": { +"description": "Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.", +"items": { +"$ref": "GoogleCloudRecaptchaenterpriseV1ChallengeRuleGroup" +}, +"type": "array" +}, +"clientSettings": { +"$ref": "GoogleCloudRecaptchaenterpriseV1ClientSettings", +"description": "Required. Configuration for clients protected by this policy." +}, +"name": { +"description": "Identifier. Resource name for this policy. Format: \"projects/{project}/keys/{key}/policy\" for a policy under a key.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRecaptchaenterpriseV1PolicyEvaluation": { +"description": "Information about the policy evaluation.", +"id": "GoogleCloudRecaptchaenterpriseV1PolicyEvaluation", +"properties": { +"challengeRuleEvaluation": { +"$ref": "GoogleCloudRecaptchaenterpriseV1ChallengeRuleEvaluation", +"description": "Output only. Populated if one or more Challenge rules were matched. Its presence in the assessment indicates that at least one challenge rule was matched and determined whether a challenge was presented to the user.", +"readOnly": true +} +}, +"type": "object" +}, "GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification": { "description": "Private password leak verification info.", "id": "GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification", @@ -1939,6 +2142,35 @@ true }, "type": "object" }, +"GoogleCloudRecaptchaenterpriseV1ProtectedEndpoint": { +"description": "Configuration for an API endpoint to protect with reCAPTCHA.", +"id": "GoogleCloudRecaptchaenterpriseV1ProtectedEndpoint", +"properties": { +"action": { +"description": "Required. Action name to be used for token generation for this endpoint. The action name can only contain alphanumeric characters, slashes, and underscores.", +"type": "string" +}, +"path": { +"description": "Required. URI path of the API endpoint to protect. Must start with '/'. Supports glob characters '*' to match a single path segment and '**' to match multiple path segments. Standalone root catch-alls ('/*' and '/**') are invalid because it can negatively impact performance to trigger reCAPTCHA on every single request to your backend. Matching is evaluated against the URL path only (domain, scheme, and query parameters are ignored). Examples: - `/login` matches `/login`, `https://example.com/login`, and `/login?query=1`, but not `/login/step1`. - `/products/*` matches `/products/123`, but not `/products/123/456`. - `/content/**` matches `/content/articles/2024/01/01`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRecaptchaenterpriseV1ProtectedEndpointGroup": { +"description": "Configuration for API endpoints to protect with reCAPTCHA.", +"id": "GoogleCloudRecaptchaenterpriseV1ProtectedEndpointGroup", +"properties": { +"protectedEndpoints": { +"description": "Optional. List of API endpoints to automatically protect with reCAPTCHA. If any of these endpoints is invoked from a page where a key bound to this policy is installed, a reCAPTCHA token is automatically generated and attached to the request. If multiple protected endpoints match a given API endpoint, the first one in the list is used.", +"items": { +"$ref": "GoogleCloudRecaptchaenterpriseV1ProtectedEndpoint" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup": { "description": "A group of related accounts.", "id": "GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup", @@ -2024,7 +2256,7 @@ true "id": "GoogleCloudRecaptchaenterpriseV1RiskAnalysis", "properties": { "challenge": { -"description": "Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys.", +"description": "Output only. Challenge information for Universal, `POLICY_BASED_CHALLENGE` and `INVISIBLE` keys.", "enum": [ "CHALLENGE_UNSPECIFIED", "NOCAPTCHA", @@ -2048,6 +2280,21 @@ true "readOnly": true, "type": "array" }, +"lastChallengeType": { +"description": "Output only. Type of the last challenge presented to the user for Universal, `POLICY_BASED_CHALLENGE` and `INVISIBLE` keys. The field is only set when a challenge was presented to the user.", +"enum": [ +"CHALLENGE_TYPE_UNSPECIFIED", +"CHALLENGE_TYPE_VISUAL", +"CHALLENGE_TYPE_AUDIO" +], +"enumDescriptions": [ +"Default unspecified type.", +"A visual challenge.", +"An audio challenge." +], +"readOnly": true, +"type": "string" +}, "reasons": { "description": "Output only. Reasons contributing to the risk analysis verdict.", "items": { @@ -2456,7 +2703,7 @@ true "id": "GoogleCloudRecaptchaenterpriseV1TransactionDataUser", "properties": { "accountId": { -"description": "Optional. Unique account identifier for this user. If using account defender, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account.", +"description": "Optional. Unique account identifier for this user. If using Account defense, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account.", "type": "string" }, "creationMs": { @@ -2550,6 +2797,12 @@ true }, "type": "object" }, +"GoogleCloudRecaptchaenterpriseV1UniversalKeySettings": { +"description": "Settings for keys that are configured through their Policy.", +"id": "GoogleCloudRecaptchaenterpriseV1UniversalKeySettings", +"properties": {}, +"type": "object" +}, "GoogleCloudRecaptchaenterpriseV1UserId": { "description": "An identifier associated with a user.", "id": "GoogleCloudRecaptchaenterpriseV1UserId", From 84dfda3824a6511139c6db3d1799006bd3e3d4ba Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:08 +0000 Subject: [PATCH 71/84] feat(redis): update the api #### redis:v1 The following keys were added: - schemas.AclPolicy.properties.clusterAclPolicyAttachments (Total Keys: 3) - schemas.AclPolicy.properties.createTime (Total Keys: 3) - schemas.AclPolicy.properties.updateTime (Total Keys: 3) - schemas.AclPolicyInfo (Total Keys: 4) - schemas.Cluster.properties.aclPolicyInfo (Total Keys: 2) - schemas.ClusterAclPolicyAttachment (Total Keys: 4) #### redis:v1beta1 The following keys were added: - schemas.AclPolicy.properties.clusterAclPolicyAttachments (Total Keys: 3) - schemas.AclPolicy.properties.createTime (Total Keys: 3) - schemas.AclPolicy.properties.updateTime (Total Keys: 3) - schemas.AclPolicyInfo (Total Keys: 4) - schemas.Cluster.properties.aclPolicyInfo (Total Keys: 2) - schemas.ClusterAclPolicyAttachment (Total Keys: 4) --- ...dis_v1.projects.locations.aclPolicies.html | 80 ++++++ ...jects.locations.aclPolicies.revisions.html | 221 ++++++++++++++++ .../redis_v1.projects.locations.clusters.html | 52 ++++ ...1beta1.projects.locations.aclPolicies.html | 80 ++++++ ...jects.locations.aclPolicies.revisions.html | 221 ++++++++++++++++ ...s_v1beta1.projects.locations.clusters.html | 52 ++++ .../discovery_cache/documents/redis.v1.json | 248 +++++++++++++++++- .../documents/redis.v1beta1.json | 248 +++++++++++++++++- 8 files changed, 1200 insertions(+), 2 deletions(-) create mode 100644 docs/dyn/redis_v1.projects.locations.aclPolicies.revisions.html create mode 100644 docs/dyn/redis_v1beta1.projects.locations.aclPolicies.revisions.html diff --git a/docs/dyn/redis_v1.projects.locations.aclPolicies.html b/docs/dyn/redis_v1.projects.locations.aclPolicies.html index 8e7d12fe87..5eca59cb5c 100644 --- a/docs/dyn/redis_v1.projects.locations.aclPolicies.html +++ b/docs/dyn/redis_v1.projects.locations.aclPolicies.html @@ -74,6 +74,11 @@

Google Cloud Memorystore for Redis API . projects . locations . aclPolicies

Instance Methods

+

+ revisions() +

+

Returns the revisions Resource.

+

close()

Close httplib2 connections.

@@ -111,6 +116,20 @@

Method Details

The object takes the form of: { # The ACL policy resource. + "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster. + { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}" + }, + ], + "createTime": "A String", # Output only. The timestamp that the ACL policy was created. "etag": "A String", # Output only. Etag for the ACL policy. "name": "A String", # Identifier. Full resource path of the ACL policy. "rules": [ # Required. The ACL rules within the ACL policy. @@ -120,6 +139,7 @@

Method Details

}, ], "state": "A String", # Output only. The state of the ACL policy. + "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated. "version": "A String", # Output only. Deprecated: Used in drift resolution. } @@ -134,6 +154,20 @@

Method Details

An object of the form: { # The ACL policy resource. + "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster. + { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}" + }, + ], + "createTime": "A String", # Output only. The timestamp that the ACL policy was created. "etag": "A String", # Output only. Etag for the ACL policy. "name": "A String", # Identifier. Full resource path of the ACL policy. "rules": [ # Required. The ACL rules within the ACL policy. @@ -143,6 +177,7 @@

Method Details

}, ], "state": "A String", # Output only. The state of the ACL policy. + "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated. "version": "A String", # Output only. Deprecated: Used in drift resolution. }
@@ -199,6 +234,20 @@

Method Details

An object of the form: { # The ACL policy resource. + "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster. + { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}" + }, + ], + "createTime": "A String", # Output only. The timestamp that the ACL policy was created. "etag": "A String", # Output only. Etag for the ACL policy. "name": "A String", # Identifier. Full resource path of the ACL policy. "rules": [ # Required. The ACL rules within the ACL policy. @@ -208,6 +257,7 @@

Method Details

}, ], "state": "A String", # Output only. The state of the ACL policy. + "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated. "version": "A String", # Output only. Deprecated: Used in drift resolution. }
@@ -231,6 +281,20 @@

Method Details

{ # Response for `ListAclPolicies`. "aclPolicies": [ # A list of ACL policies in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. { # The ACL policy resource. + "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster. + { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}" + }, + ], + "createTime": "A String", # Output only. The timestamp that the ACL policy was created. "etag": "A String", # Output only. Etag for the ACL policy. "name": "A String", # Identifier. Full resource path of the ACL policy. "rules": [ # Required. The ACL rules within the ACL policy. @@ -240,6 +304,7 @@

Method Details

}, ], "state": "A String", # Output only. The state of the ACL policy. + "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated. "version": "A String", # Output only. Deprecated: Used in drift resolution. }, ], @@ -274,6 +339,20 @@

Method Details

The object takes the form of: { # The ACL policy resource. + "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster. + { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}" + }, + ], + "createTime": "A String", # Output only. The timestamp that the ACL policy was created. "etag": "A String", # Output only. Etag for the ACL policy. "name": "A String", # Identifier. Full resource path of the ACL policy. "rules": [ # Required. The ACL rules within the ACL policy. @@ -283,6 +362,7 @@

Method Details

}, ], "state": "A String", # Output only. The state of the ACL policy. + "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated. "version": "A String", # Output only. Deprecated: Used in drift resolution. } diff --git a/docs/dyn/redis_v1.projects.locations.aclPolicies.revisions.html b/docs/dyn/redis_v1.projects.locations.aclPolicies.revisions.html new file mode 100644 index 0000000000..c62fdd62bc --- /dev/null +++ b/docs/dyn/redis_v1.projects.locations.aclPolicies.revisions.html @@ -0,0 +1,221 @@ + + + +

Google Cloud Memorystore for Redis API . projects . locations . aclPolicies . revisions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details of a specific ACL policy revision.

+

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

+

Lists all ACL policy revisions in a given ACL policy.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a specific ACL policy revision.
+
+Args:
+  name: string, Required. Redis ACL policy revision resource name using the form: `projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}/revisions/{revision_id}` where `location_id` refers to a GCP region. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The ACL policy revision resource.
+  "attachedClusters": [ # Output only. A list of clusters that are attached to this ACL policy revision.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The timestamp that the revision was created.
+  "name": "A String", # Identifier. The name of the ACL policy revision. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}"
+  "revisionNumber": "A String", # Output only. The revision number of the ACL policy revision.
+  "snapshot": { # The ACL policy resource. # Output only. The snapshot of the ACL policy at the time of revision creation.
+    "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster.
+      { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed.
+        "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster.
+          { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster.
+            "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}"
+            "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to.
+            "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states.
+            "state": "A String", # Output only. AclPolicyRevision state.
+          },
+        ],
+        "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}"
+      },
+    ],
+    "createTime": "A String", # Output only. The timestamp that the ACL policy was created.
+    "etag": "A String", # Output only. Etag for the ACL policy.
+    "name": "A String", # Identifier. Full resource path of the ACL policy.
+    "rules": [ # Required. The ACL rules within the ACL policy.
+      { # A single ACL rule which defines the policy for a user.
+        "rule": "A String", # Required. The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
+        "username": "A String", # Required. Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Redis OSS.
+      },
+    ],
+    "state": "A String", # Output only. The state of the ACL policy.
+    "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated.
+    "version": "A String", # Output only. Deprecated: Used in drift resolution.
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all ACL policy revisions in a given ACL policy.
+
+Args:
+  parent: string, Required. The name of the ACL policy to list revisions for. Format: "projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}" (required)
+  pageSize: integer, Optional. The maximum number of items to return.
+  pageToken: string, Optional. The `next_page_token` value returned from a previous `ListAclPolicyRevisions` request, if any.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for `ListAclPolicyRevisions`.
+  "aclPolicyRevisions": [ # A list of ACL policy revisions.
+    { # The ACL policy revision resource.
+      "attachedClusters": [ # Output only. A list of clusters that are attached to this ACL policy revision.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. The timestamp that the revision was created.
+      "name": "A String", # Identifier. The name of the ACL policy revision. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}"
+      "revisionNumber": "A String", # Output only. The revision number of the ACL policy revision.
+      "snapshot": { # The ACL policy resource. # Output only. The snapshot of the ACL policy at the time of revision creation.
+        "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster.
+          { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed.
+            "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster.
+              { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster.
+                "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}"
+                "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to.
+                "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states.
+                "state": "A String", # Output only. AclPolicyRevision state.
+              },
+            ],
+            "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}"
+          },
+        ],
+        "createTime": "A String", # Output only. The timestamp that the ACL policy was created.
+        "etag": "A String", # Output only. Etag for the ACL policy.
+        "name": "A String", # Identifier. Full resource path of the ACL policy.
+        "rules": [ # Required. The ACL rules within the ACL policy.
+          { # A single ACL rule which defines the policy for a user.
+            "rule": "A String", # Required. The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
+            "username": "A String", # Required. Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Redis OSS.
+          },
+        ],
+        "state": "A String", # Output only. The state of the ACL policy.
+        "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated.
+        "version": "A String", # Output only. Deprecated: Used in drift resolution.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html index c2f8d932a0..59f1c68381 100644 --- a/docs/dyn/redis_v1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1.projects.locations.clusters.html @@ -215,6 +215,19 @@

Method Details

{ # A cluster instance. "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "aclPolicyInSync": True or False, # Optional. Output only. Deprecated: Indicates whether the ACL rules applied to the cluster are in sync. + "aclPolicyInfo": { # Details of the applied ACL policy. # Output only. Details of the applied ACL policy. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "appliedAclPolicy": "A String", # Output only. The resource name of the applied ACL policy. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}" + "appliedAclPolicyRevision": "A String", # Output only. The resource name of the applied ACL policy revision. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "appliedAclPolicyRevisionNumber": "A String", # Output only. The revision number of the applied ACL policy revision. + }, "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. @@ -494,6 +507,19 @@

Method Details

{ # A cluster instance. "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "aclPolicyInSync": True or False, # Optional. Output only. Deprecated: Indicates whether the ACL rules applied to the cluster are in sync. + "aclPolicyInfo": { # Details of the applied ACL policy. # Output only. Details of the applied ACL policy. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "appliedAclPolicy": "A String", # Output only. The resource name of the applied ACL policy. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}" + "appliedAclPolicyRevision": "A String", # Output only. The resource name of the applied ACL policy revision. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "appliedAclPolicyRevisionNumber": "A String", # Output only. The revision number of the applied ACL policy revision. + }, "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. @@ -739,6 +765,19 @@

Method Details

{ # A cluster instance. "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "aclPolicyInSync": True or False, # Optional. Output only. Deprecated: Indicates whether the ACL rules applied to the cluster are in sync. + "aclPolicyInfo": { # Details of the applied ACL policy. # Output only. Details of the applied ACL policy. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "appliedAclPolicy": "A String", # Output only. The resource name of the applied ACL policy. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}" + "appliedAclPolicyRevision": "A String", # Output only. The resource name of the applied ACL policy revision. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "appliedAclPolicyRevisionNumber": "A String", # Output only. The revision number of the applied ACL policy revision. + }, "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. @@ -967,6 +1006,19 @@

Method Details

{ # A cluster instance. "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "aclPolicyInSync": True or False, # Optional. Output only. Deprecated: Indicates whether the ACL rules applied to the cluster are in sync. + "aclPolicyInfo": { # Details of the applied ACL policy. # Output only. Details of the applied ACL policy. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "appliedAclPolicy": "A String", # Output only. The resource name of the applied ACL policy. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}" + "appliedAclPolicyRevision": "A String", # Output only. The resource name of the applied ACL policy revision. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "appliedAclPolicyRevisionNumber": "A String", # Output only. The revision number of the applied ACL policy revision. + }, "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. diff --git a/docs/dyn/redis_v1beta1.projects.locations.aclPolicies.html b/docs/dyn/redis_v1beta1.projects.locations.aclPolicies.html index 89e1bfdbe8..723df85ee5 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.aclPolicies.html +++ b/docs/dyn/redis_v1beta1.projects.locations.aclPolicies.html @@ -74,6 +74,11 @@

Google Cloud Memorystore for Redis API . projects . locations . aclPolicies

Instance Methods

+

+ revisions() +

+

Returns the revisions Resource.

+

close()

Close httplib2 connections.

@@ -111,6 +116,20 @@

Method Details

The object takes the form of: { # The ACL policy resource. + "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster. + { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}" + }, + ], + "createTime": "A String", # Output only. The timestamp that the ACL policy was created. "etag": "A String", # Output only. Etag for the ACL policy. "name": "A String", # Identifier. Full resource path of the ACL policy. "rules": [ # Required. The ACL rules within the ACL policy. @@ -120,6 +139,7 @@

Method Details

}, ], "state": "A String", # Output only. The state of the ACL policy. + "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated. "version": "A String", # Output only. Deprecated: Used in drift resolution. } @@ -134,6 +154,20 @@

Method Details

An object of the form: { # The ACL policy resource. + "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster. + { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}" + }, + ], + "createTime": "A String", # Output only. The timestamp that the ACL policy was created. "etag": "A String", # Output only. Etag for the ACL policy. "name": "A String", # Identifier. Full resource path of the ACL policy. "rules": [ # Required. The ACL rules within the ACL policy. @@ -143,6 +177,7 @@

Method Details

}, ], "state": "A String", # Output only. The state of the ACL policy. + "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated. "version": "A String", # Output only. Deprecated: Used in drift resolution. }
@@ -199,6 +234,20 @@

Method Details

An object of the form: { # The ACL policy resource. + "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster. + { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}" + }, + ], + "createTime": "A String", # Output only. The timestamp that the ACL policy was created. "etag": "A String", # Output only. Etag for the ACL policy. "name": "A String", # Identifier. Full resource path of the ACL policy. "rules": [ # Required. The ACL rules within the ACL policy. @@ -208,6 +257,7 @@

Method Details

}, ], "state": "A String", # Output only. The state of the ACL policy. + "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated. "version": "A String", # Output only. Deprecated: Used in drift resolution. }
@@ -231,6 +281,20 @@

Method Details

{ # Response for `ListAclPolicies`. "aclPolicies": [ # A list of ACL policies in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. { # The ACL policy resource. + "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster. + { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}" + }, + ], + "createTime": "A String", # Output only. The timestamp that the ACL policy was created. "etag": "A String", # Output only. Etag for the ACL policy. "name": "A String", # Identifier. Full resource path of the ACL policy. "rules": [ # Required. The ACL rules within the ACL policy. @@ -240,6 +304,7 @@

Method Details

}, ], "state": "A String", # Output only. The state of the ACL policy. + "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated. "version": "A String", # Output only. Deprecated: Used in drift resolution. }, ], @@ -274,6 +339,20 @@

Method Details

The object takes the form of: { # The ACL policy resource. + "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster. + { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}" + }, + ], + "createTime": "A String", # Output only. The timestamp that the ACL policy was created. "etag": "A String", # Output only. Etag for the ACL policy. "name": "A String", # Identifier. Full resource path of the ACL policy. "rules": [ # Required. The ACL rules within the ACL policy. @@ -283,6 +362,7 @@

Method Details

}, ], "state": "A String", # Output only. The state of the ACL policy. + "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated. "version": "A String", # Output only. Deprecated: Used in drift resolution. } diff --git a/docs/dyn/redis_v1beta1.projects.locations.aclPolicies.revisions.html b/docs/dyn/redis_v1beta1.projects.locations.aclPolicies.revisions.html new file mode 100644 index 0000000000..bc94f14fb4 --- /dev/null +++ b/docs/dyn/redis_v1beta1.projects.locations.aclPolicies.revisions.html @@ -0,0 +1,221 @@ + + + +

Google Cloud Memorystore for Redis API . projects . locations . aclPolicies . revisions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details of a specific ACL policy revision.

+

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

+

Lists all ACL policy revisions in a given ACL policy.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a specific ACL policy revision.
+
+Args:
+  name: string, Required. Redis ACL policy revision resource name using the form: `projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}/revisions/{revision_id}` where `location_id` refers to a GCP region. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The ACL policy revision resource.
+  "attachedClusters": [ # Output only. A list of clusters that are attached to this ACL policy revision.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The timestamp that the revision was created.
+  "name": "A String", # Identifier. The name of the ACL policy revision. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}"
+  "revisionNumber": "A String", # Output only. The revision number of the ACL policy revision.
+  "snapshot": { # The ACL policy resource. # Output only. The snapshot of the ACL policy at the time of revision creation.
+    "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster.
+      { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed.
+        "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster.
+          { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster.
+            "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}"
+            "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to.
+            "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states.
+            "state": "A String", # Output only. AclPolicyRevision state.
+          },
+        ],
+        "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}"
+      },
+    ],
+    "createTime": "A String", # Output only. The timestamp that the ACL policy was created.
+    "etag": "A String", # Output only. Etag for the ACL policy.
+    "name": "A String", # Identifier. Full resource path of the ACL policy.
+    "rules": [ # Required. The ACL rules within the ACL policy.
+      { # A single ACL rule which defines the policy for a user.
+        "rule": "A String", # Required. The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
+        "username": "A String", # Required. Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Redis OSS.
+      },
+    ],
+    "state": "A String", # Output only. The state of the ACL policy.
+    "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated.
+    "version": "A String", # Output only. Deprecated: Used in drift resolution.
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all ACL policy revisions in a given ACL policy.
+
+Args:
+  parent: string, Required. The name of the ACL policy to list revisions for. Format: "projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}" (required)
+  pageSize: integer, Optional. The maximum number of items to return.
+  pageToken: string, Optional. The `next_page_token` value returned from a previous `ListAclPolicyRevisions` request, if any.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for `ListAclPolicyRevisions`.
+  "aclPolicyRevisions": [ # A list of ACL policy revisions.
+    { # The ACL policy revision resource.
+      "attachedClusters": [ # Output only. A list of clusters that are attached to this ACL policy revision.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. The timestamp that the revision was created.
+      "name": "A String", # Identifier. The name of the ACL policy revision. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}"
+      "revisionNumber": "A String", # Output only. The revision number of the ACL policy revision.
+      "snapshot": { # The ACL policy resource. # Output only. The snapshot of the ACL policy at the time of revision creation.
+        "clusterAclPolicyAttachments": [ # Output only. The ACL policy attachment status for each attached cluster.
+          { # ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed.
+            "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster.
+              { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster.
+                "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}"
+                "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to.
+                "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states.
+                "state": "A String", # Output only. AclPolicyRevision state.
+              },
+            ],
+            "cluster": "A String", # Output only. The resource name of the attached Cluster. Format: "projects/{project}/locations/{location}/clusters/{cluster}"
+          },
+        ],
+        "createTime": "A String", # Output only. The timestamp that the ACL policy was created.
+        "etag": "A String", # Output only. Etag for the ACL policy.
+        "name": "A String", # Identifier. Full resource path of the ACL policy.
+        "rules": [ # Required. The ACL rules within the ACL policy.
+          { # A single ACL rule which defines the policy for a user.
+            "rule": "A String", # Required. The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
+            "username": "A String", # Required. Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Redis OSS.
+          },
+        ],
+        "state": "A String", # Output only. The state of the ACL policy.
+        "updateTime": "A String", # Output only. The timestamp that the ACL policy was last updated.
+        "version": "A String", # Output only. Deprecated: Used in drift resolution.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html index d9be0423e8..665d5a5336 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html @@ -215,6 +215,19 @@

Method Details

{ # A cluster instance. "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "aclPolicyInSync": True or False, # Optional. Output only. Deprecated: Indicates whether the ACL rules applied to the cluster are in sync. + "aclPolicyInfo": { # Details of the applied ACL policy. # Output only. Details of the applied ACL policy. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "appliedAclPolicy": "A String", # Output only. The resource name of the applied ACL policy. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}" + "appliedAclPolicyRevision": "A String", # Output only. The resource name of the applied ACL policy revision. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "appliedAclPolicyRevisionNumber": "A String", # Output only. The revision number of the applied ACL policy revision. + }, "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. @@ -494,6 +507,19 @@

Method Details

{ # A cluster instance. "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "aclPolicyInSync": True or False, # Optional. Output only. Deprecated: Indicates whether the ACL rules applied to the cluster are in sync. + "aclPolicyInfo": { # Details of the applied ACL policy. # Output only. Details of the applied ACL policy. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "appliedAclPolicy": "A String", # Output only. The resource name of the applied ACL policy. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}" + "appliedAclPolicyRevision": "A String", # Output only. The resource name of the applied ACL policy revision. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "appliedAclPolicyRevisionNumber": "A String", # Output only. The revision number of the applied ACL policy revision. + }, "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. @@ -739,6 +765,19 @@

Method Details

{ # A cluster instance. "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "aclPolicyInSync": True or False, # Optional. Output only. Deprecated: Indicates whether the ACL rules applied to the cluster are in sync. + "aclPolicyInfo": { # Details of the applied ACL policy. # Output only. Details of the applied ACL policy. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "appliedAclPolicy": "A String", # Output only. The resource name of the applied ACL policy. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}" + "appliedAclPolicyRevision": "A String", # Output only. The resource name of the applied ACL policy revision. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "appliedAclPolicyRevisionNumber": "A String", # Output only. The revision number of the applied ACL policy revision. + }, "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. @@ -967,6 +1006,19 @@

Method Details

{ # A cluster instance. "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "aclPolicyInSync": True or False, # Optional. Output only. Deprecated: Indicates whether the ACL rules applied to the cluster are in sync. + "aclPolicyInfo": { # Details of the applied ACL policy. # Output only. Details of the applied ACL policy. + "aclPolicyRevisionStatuses": [ # Output only. A list of status for various revisions of this ACL policy on the cluster. + { # AclPolicyRevisionStatus stores the per-revision status for an attached cluster. + "aclPolicyRevision": "A String", # Output only. The resource name of the ACL policy revision this status refers to. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "aclPolicyRevisionNumber": "A String", # Output only. The revision number of the ACL policy revision this status refers to. + "errorMessage": "A String", # Output only. Human-readable error message providing more details for FAILED states. + "state": "A String", # Output only. AclPolicyRevision state. + }, + ], + "appliedAclPolicy": "A String", # Output only. The resource name of the applied ACL policy. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}" + "appliedAclPolicyRevision": "A String", # Output only. The resource name of the applied ACL policy revision. Format: "projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}" + "appliedAclPolicyRevisionNumber": "A String", # Output only. The revision number of the applied ACL policy revision. + }, "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 39bd248a02..cde878cd37 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -634,6 +634,75 @@ "https://www.googleapis.com/auth/redis.read-write" ] } +}, +"resources": { +"revisions": { +"methods": { +"get": { +"description": "Gets details of a specific ACL policy revision.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aclPolicies/{aclPoliciesId}/revisions/{revisionsId}", +"httpMethod": "GET", +"id": "redis.projects.locations.aclPolicies.revisions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Redis ACL policy revision resource name using the form: `projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}/revisions/{revision_id}` where `location_id` refers to a GCP region.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/aclPolicies/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "AclPolicyRevision" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, +"list": { +"description": "Lists all ACL policy revisions in a given ACL policy.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aclPolicies/{aclPoliciesId}/revisions", +"httpMethod": "GET", +"id": "redis.projects.locations.aclPolicies.revisions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The `next_page_token` value returned from a previous `ListAclPolicyRevisions` request, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the ACL policy to list revisions for. Format: \"projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/aclPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/revisions", +"response": { +"$ref": "ListAclPolicyRevisionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +} +} +} } }, "backupCollections": { @@ -1845,7 +1914,7 @@ } } }, -"revision": "20260707", +"revision": "20260720", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1875,6 +1944,20 @@ "description": "The ACL policy resource.", "id": "AclPolicy", "properties": { +"clusterAclPolicyAttachments": { +"description": "Output only. The ACL policy attachment status for each attached cluster.", +"items": { +"$ref": "ClusterAclPolicyAttachment" +}, +"readOnly": true, +"type": "array" +}, +"createTime": { +"description": "Output only. The timestamp that the ACL policy was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "etag": { "description": "Output only. Etag for the ACL policy.", "readOnly": true, @@ -1908,6 +1991,12 @@ "readOnly": true, "type": "string" }, +"updateTime": { +"description": "Output only. The timestamp that the ACL policy was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "version": { "deprecated": true, "description": "Output only. Deprecated: Used in drift resolution.", @@ -1918,6 +2007,113 @@ }, "type": "object" }, +"AclPolicyInfo": { +"description": "Details of the applied ACL policy.", +"id": "AclPolicyInfo", +"properties": { +"aclPolicyRevisionStatuses": { +"description": "Output only. A list of status for various revisions of this ACL policy on the cluster.", +"items": { +"$ref": "AclPolicyRevisionStatus" +}, +"readOnly": true, +"type": "array" +}, +"appliedAclPolicy": { +"description": "Output only. The resource name of the applied ACL policy. Format: \"projects/{project}/locations/{location}/aclPolicies/{acl_policy}\"", +"readOnly": true, +"type": "string" +}, +"appliedAclPolicyRevision": { +"description": "Output only. The resource name of the applied ACL policy revision. Format: \"projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}\"", +"readOnly": true, +"type": "string" +}, +"appliedAclPolicyRevisionNumber": { +"description": "Output only. The revision number of the applied ACL policy revision.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AclPolicyRevision": { +"description": "The ACL policy revision resource.", +"id": "AclPolicyRevision", +"properties": { +"attachedClusters": { +"description": "Output only. A list of clusters that are attached to this ACL policy revision.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"createTime": { +"description": "Output only. The timestamp that the revision was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The name of the ACL policy revision. Format: \"projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}\"", +"type": "string" +}, +"revisionNumber": { +"description": "Output only. The revision number of the ACL policy revision.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"snapshot": { +"$ref": "AclPolicy", +"description": "Output only. The snapshot of the ACL policy at the time of revision creation.", +"readOnly": true +} +}, +"type": "object" +}, +"AclPolicyRevisionStatus": { +"description": "AclPolicyRevisionStatus stores the per-revision status for an attached cluster.", +"id": "AclPolicyRevisionStatus", +"properties": { +"aclPolicyRevision": { +"description": "Output only. The resource name of the ACL policy revision this status refers to. Format: \"projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}\"", +"readOnly": true, +"type": "string" +}, +"aclPolicyRevisionNumber": { +"description": "Output only. The revision number of the ACL policy revision this status refers to.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"errorMessage": { +"description": "Output only. Human-readable error message providing more details for FAILED states.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. AclPolicyRevision state.", +"enum": [ +"STATE_UNSPECIFIED", +"APPLYING", +"APPLIED", +"FAILED" +], +"enumDescriptions": [ +"Not set.", +"The cluster is attempting to apply this revision.", +"The cluster has successfully applied this revision.", +"The cluster failed to apply this revision." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "AclRule": { "description": "A single ACL rule which defines the policy for a user.", "id": "AclRule", @@ -2429,6 +2625,11 @@ "readOnly": true, "type": "boolean" }, +"aclPolicyInfo": { +"$ref": "AclPolicyInfo", +"description": "Output only. Details of the applied ACL policy.", +"readOnly": true +}, "allowFewerZonesDeployment": { "deprecated": true, "description": "Optional. Immutable. Deprecated, do not use.", @@ -2719,6 +2920,26 @@ }, "type": "object" }, +"ClusterAclPolicyAttachment": { +"description": "ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed.", +"id": "ClusterAclPolicyAttachment", +"properties": { +"aclPolicyRevisionStatuses": { +"description": "Output only. A list of status for various revisions of this ACL policy on the cluster.", +"items": { +"$ref": "AclPolicyRevisionStatus" +}, +"readOnly": true, +"type": "array" +}, +"cluster": { +"description": "Output only. The resource name of the attached Cluster. Format: \"projects/{project}/locations/{location}/clusters/{cluster}\"", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ClusterEndpoint": { "description": "ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster.", "id": "ClusterEndpoint", @@ -5030,6 +5251,31 @@ false }, "type": "object" }, +"ListAclPolicyRevisionsResponse": { +"description": "Response for `ListAclPolicyRevisions`.", +"id": "ListAclPolicyRevisionsResponse", +"properties": { +"aclPolicyRevisions": { +"description": "A list of ACL policy revisions.", +"items": { +"$ref": "AclPolicyRevision" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListAuthTokensResponse": { "description": "Response message for ListAuthTokens.", "id": "ListAuthTokensResponse", diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index 8bae44cab4..35fdb50f95 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -634,6 +634,75 @@ "https://www.googleapis.com/auth/redis.read-write" ] } +}, +"resources": { +"revisions": { +"methods": { +"get": { +"description": "Gets details of a specific ACL policy revision.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/aclPolicies/{aclPoliciesId}/revisions/{revisionsId}", +"httpMethod": "GET", +"id": "redis.projects.locations.aclPolicies.revisions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Redis ACL policy revision resource name using the form: `projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}/revisions/{revision_id}` where `location_id` refers to a GCP region.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/aclPolicies/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "AclPolicyRevision" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +}, +"list": { +"description": "Lists all ACL policy revisions in a given ACL policy.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/aclPolicies/{aclPoliciesId}/revisions", +"httpMethod": "GET", +"id": "redis.projects.locations.aclPolicies.revisions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The `next_page_token` value returned from a previous `ListAclPolicyRevisions` request, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the ACL policy to list revisions for. Format: \"projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/aclPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/revisions", +"response": { +"$ref": "ListAclPolicyRevisionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/redis.read-write" +] +} +} +} } }, "backupCollections": { @@ -1841,7 +1910,7 @@ } } }, -"revision": "20260707", +"revision": "20260720", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1871,6 +1940,20 @@ "description": "The ACL policy resource.", "id": "AclPolicy", "properties": { +"clusterAclPolicyAttachments": { +"description": "Output only. The ACL policy attachment status for each attached cluster.", +"items": { +"$ref": "ClusterAclPolicyAttachment" +}, +"readOnly": true, +"type": "array" +}, +"createTime": { +"description": "Output only. The timestamp that the ACL policy was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "etag": { "description": "Output only. Etag for the ACL policy.", "readOnly": true, @@ -1904,6 +1987,12 @@ "readOnly": true, "type": "string" }, +"updateTime": { +"description": "Output only. The timestamp that the ACL policy was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "version": { "deprecated": true, "description": "Output only. Deprecated: Used in drift resolution.", @@ -1914,6 +2003,113 @@ }, "type": "object" }, +"AclPolicyInfo": { +"description": "Details of the applied ACL policy.", +"id": "AclPolicyInfo", +"properties": { +"aclPolicyRevisionStatuses": { +"description": "Output only. A list of status for various revisions of this ACL policy on the cluster.", +"items": { +"$ref": "AclPolicyRevisionStatus" +}, +"readOnly": true, +"type": "array" +}, +"appliedAclPolicy": { +"description": "Output only. The resource name of the applied ACL policy. Format: \"projects/{project}/locations/{location}/aclPolicies/{acl_policy}\"", +"readOnly": true, +"type": "string" +}, +"appliedAclPolicyRevision": { +"description": "Output only. The resource name of the applied ACL policy revision. Format: \"projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}\"", +"readOnly": true, +"type": "string" +}, +"appliedAclPolicyRevisionNumber": { +"description": "Output only. The revision number of the applied ACL policy revision.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AclPolicyRevision": { +"description": "The ACL policy revision resource.", +"id": "AclPolicyRevision", +"properties": { +"attachedClusters": { +"description": "Output only. A list of clusters that are attached to this ACL policy revision.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"createTime": { +"description": "Output only. The timestamp that the revision was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The name of the ACL policy revision. Format: \"projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}\"", +"type": "string" +}, +"revisionNumber": { +"description": "Output only. The revision number of the ACL policy revision.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"snapshot": { +"$ref": "AclPolicy", +"description": "Output only. The snapshot of the ACL policy at the time of revision creation.", +"readOnly": true +} +}, +"type": "object" +}, +"AclPolicyRevisionStatus": { +"description": "AclPolicyRevisionStatus stores the per-revision status for an attached cluster.", +"id": "AclPolicyRevisionStatus", +"properties": { +"aclPolicyRevision": { +"description": "Output only. The resource name of the ACL policy revision this status refers to. Format: \"projects/{project}/locations/{location}/aclPolicies/{acl_policy}/revisions/{revision}\"", +"readOnly": true, +"type": "string" +}, +"aclPolicyRevisionNumber": { +"description": "Output only. The revision number of the ACL policy revision this status refers to.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"errorMessage": { +"description": "Output only. Human-readable error message providing more details for FAILED states.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. AclPolicyRevision state.", +"enum": [ +"STATE_UNSPECIFIED", +"APPLYING", +"APPLIED", +"FAILED" +], +"enumDescriptions": [ +"Not set.", +"The cluster is attempting to apply this revision.", +"The cluster has successfully applied this revision.", +"The cluster failed to apply this revision." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "AclRule": { "description": "A single ACL rule which defines the policy for a user.", "id": "AclRule", @@ -2425,6 +2621,11 @@ "readOnly": true, "type": "boolean" }, +"aclPolicyInfo": { +"$ref": "AclPolicyInfo", +"description": "Output only. Details of the applied ACL policy.", +"readOnly": true +}, "allowFewerZonesDeployment": { "deprecated": true, "description": "Optional. Immutable. Deprecated, do not use.", @@ -2715,6 +2916,26 @@ }, "type": "object" }, +"ClusterAclPolicyAttachment": { +"description": "ClusterAclPolicyAttachment stores the ACL policy status for an attached cluster for the revisions successfully applied, under application or failed.", +"id": "ClusterAclPolicyAttachment", +"properties": { +"aclPolicyRevisionStatuses": { +"description": "Output only. A list of status for various revisions of this ACL policy on the cluster.", +"items": { +"$ref": "AclPolicyRevisionStatus" +}, +"readOnly": true, +"type": "array" +}, +"cluster": { +"description": "Output only. The resource name of the attached Cluster. Format: \"projects/{project}/locations/{location}/clusters/{cluster}\"", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ClusterEndpoint": { "description": "ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster.", "id": "ClusterEndpoint", @@ -5033,6 +5254,31 @@ false }, "type": "object" }, +"ListAclPolicyRevisionsResponse": { +"description": "Response for `ListAclPolicyRevisions`.", +"id": "ListAclPolicyRevisionsResponse", +"properties": { +"aclPolicyRevisions": { +"description": "A list of ACL policy revisions.", +"items": { +"$ref": "AclPolicyRevision" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListAuthTokensResponse": { "description": "Response message for ListAuthTokens.", "id": "ListAuthTokensResponse", From c190ec7f3ae378ea0f53d01a0681d4d3ccfeaa07 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:09 +0000 Subject: [PATCH 72/84] feat(run): update the api #### run:v1 The following keys were changed: - endpoints (Total Keys: 1) #### run:v2 The following keys were added: - schemas.GoogleCloudRunV2Condition.properties.instanceReason (Total Keys: 2) - schemas.GoogleCloudRunV2Service.properties.sshEnabled.type (Total Keys: 1) The following keys were changed: - endpoints (Total Keys: 1) --- .../run_v2.projects.locations.instances.html | 8 ++++ ...v2.projects.locations.jobs.executions.html | 2 + ...jects.locations.jobs.executions.tasks.html | 2 + docs/dyn/run_v2.projects.locations.jobs.html | 8 ++++ .../run_v2.projects.locations.services.html | 20 ++++++++-- ...projects.locations.services.revisions.html | 6 ++- ...run_v2.projects.locations.workerPools.html | 8 ++++ ...jects.locations.workerPools.revisions.html | 6 ++- .../discovery_cache/documents/run.v1.json | 12 +++++- .../discovery_cache/documents/run.v2.json | 37 ++++++++++++++++++- 10 files changed, 98 insertions(+), 11 deletions(-) diff --git a/docs/dyn/run_v2.projects.locations.instances.html b/docs/dyn/run_v2.projects.locations.instances.html index dedac33587..c8508815c2 100644 --- a/docs/dyn/run_v2.projects.locations.instances.html +++ b/docs/dyn/run_v2.projects.locations.instances.html @@ -139,6 +139,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Instance does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -324,6 +325,7 @@

Method Details

"serviceAccount": "A String", "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Instance, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -485,6 +487,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Instance does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -670,6 +673,7 @@

Method Details

"serviceAccount": "A String", "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Instance, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -817,6 +821,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Instance does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -1002,6 +1007,7 @@

Method Details

"serviceAccount": "A String", "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Instance, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -1108,6 +1114,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Instance does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -1293,6 +1300,7 @@

Method Details

"serviceAccount": "A String", "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Instance, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.html b/docs/dyn/run_v2.projects.locations.jobs.executions.html index 05593020fe..0df2d1c609 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.html @@ -247,6 +247,7 @@

Method Details

"conditions": [ # Output only. The Condition of this Execution, containing its readiness status, and detailed error information in case it did not reach the desired state. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -513,6 +514,7 @@

Method Details

"conditions": [ # Output only. The Condition of this Execution, containing its readiness status, and detailed error information in case it did not reach the desired state. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. 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 0f30ebcdfd..db59aff439 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html @@ -114,6 +114,7 @@

Method Details

"conditions": [ # Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -385,6 +386,7 @@

Method Details

"conditions": [ # Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. diff --git a/docs/dyn/run_v2.projects.locations.jobs.html b/docs/dyn/run_v2.projects.locations.jobs.html index 9aa568dec3..193ece577c 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.html +++ b/docs/dyn/run_v2.projects.locations.jobs.html @@ -141,6 +141,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -388,6 +389,7 @@

Method Details

}, "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -496,6 +498,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -743,6 +746,7 @@

Method Details

}, "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -837,6 +841,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -1084,6 +1089,7 @@

Method Details

}, "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -1137,6 +1143,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -1384,6 +1391,7 @@

Method Details

}, "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index bce54ebecc..f406ed1d43 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -151,6 +151,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -197,6 +198,7 @@

Method Details

"minInstanceCount": 42, # Optional. total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving. "scalingMode": "A String", # Optional. The scaling mode for the service. }, + "sshEnabled": True or False, # Optional. Enables SSH access to the Service. "template": { # RevisionTemplate describes the data a revision should have when created from a template. # Required. The template used to create revisions for this Service. "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 RevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules. "a_key": "A String", @@ -357,7 +359,7 @@

Method Details

"revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name. "scaling": { # Settings for revision-level scaling settings. # Optional. Scaling settings for this Revision. "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable concurrency utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. - "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. + "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, @@ -420,6 +422,7 @@

Method Details

}, "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -563,6 +566,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -609,6 +613,7 @@

Method Details

"minInstanceCount": 42, # Optional. total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving. "scalingMode": "A String", # Optional. The scaling mode for the service. }, + "sshEnabled": True or False, # Optional. Enables SSH access to the Service. "template": { # RevisionTemplate describes the data a revision should have when created from a template. # Required. The template used to create revisions for this Service. "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 RevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules. "a_key": "A String", @@ -769,7 +774,7 @@

Method Details

"revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name. "scaling": { # Settings for revision-level scaling settings. # Optional. Scaling settings for this Revision. "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable concurrency utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. - "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. + "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, @@ -832,6 +837,7 @@

Method Details

}, "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -962,6 +968,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -1008,6 +1015,7 @@

Method Details

"minInstanceCount": 42, # Optional. total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving. "scalingMode": "A String", # Optional. The scaling mode for the service. }, + "sshEnabled": True or False, # Optional. Enables SSH access to the Service. "template": { # RevisionTemplate describes the data a revision should have when created from a template. # Required. The template used to create revisions for this Service. "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 RevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules. "a_key": "A String", @@ -1168,7 +1176,7 @@

Method Details

"revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name. "scaling": { # Settings for revision-level scaling settings. # Optional. Scaling settings for this Revision. "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable concurrency utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. - "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. + "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, @@ -1231,6 +1239,7 @@

Method Details

}, "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -1321,6 +1330,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -1367,6 +1377,7 @@

Method Details

"minInstanceCount": 42, # Optional. total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving. "scalingMode": "A String", # Optional. The scaling mode for the service. }, + "sshEnabled": True or False, # Optional. Enables SSH access to the Service. "template": { # RevisionTemplate describes the data a revision should have when created from a template. # Required. The template used to create revisions for this Service. "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 RevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules. "a_key": "A String", @@ -1527,7 +1538,7 @@

Method Details

"revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name. "scaling": { # Settings for revision-level scaling settings. # Optional. Scaling settings for this Revision. "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable concurrency utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. - "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. + "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, @@ -1590,6 +1601,7 @@

Method Details

}, "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. diff --git a/docs/dyn/run_v2.projects.locations.services.revisions.html b/docs/dyn/run_v2.projects.locations.services.revisions.html index e0281b832b..4521c8050e 100644 --- a/docs/dyn/run_v2.projects.locations.services.revisions.html +++ b/docs/dyn/run_v2.projects.locations.services.revisions.html @@ -194,6 +194,7 @@

Method Details

"conditions": [ # Output only. The Condition of this Revision, containing its readiness status, and detailed error information in case it did not reach a serving state. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -367,7 +368,7 @@

Method Details

"satisfiesPzs": True or False, # Output only. Reserved for future use. "scaling": { # Settings for revision-level scaling settings. # Scaling settings for this revision. "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable concurrency utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. - "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. + "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, @@ -465,6 +466,7 @@

Method Details

"conditions": [ # Output only. The Condition of this Revision, containing its readiness status, and detailed error information in case it did not reach a serving state. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -638,7 +640,7 @@

Method Details

"satisfiesPzs": True or False, # Output only. Reserved for future use. "scaling": { # Settings for revision-level scaling settings. # Scaling settings for this revision. "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable concurrency utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. - "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. + "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, diff --git a/docs/dyn/run_v2.projects.locations.workerPools.html b/docs/dyn/run_v2.projects.locations.workerPools.html index e8d9d72996..120f7253a7 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.html @@ -138,6 +138,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -397,6 +398,7 @@

Method Details

}, "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -506,6 +508,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -765,6 +768,7 @@

Method Details

}, "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -861,6 +865,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -1120,6 +1125,7 @@

Method Details

}, "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -1173,6 +1179,7 @@

Method Details

"conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -1432,6 +1439,7 @@

Method Details

}, "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html index 9c04353ea9..bd4028c966 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html @@ -155,6 +155,7 @@

Method Details

"conditions": [ # Output only. The Condition of this Revision, containing its readiness status, and detailed error information in case it did not reach a serving state. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -328,7 +329,7 @@

Method Details

"satisfiesPzs": True or False, # Output only. Reserved for future use. "scaling": { # Settings for revision-level scaling settings. # Scaling settings for this revision. "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable concurrency utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. - "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. + "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, @@ -426,6 +427,7 @@

Method Details

"conditions": [ # Output only. The Condition of this Revision, containing its readiness status, and detailed error information in case it did not reach a serving state. { # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. + "instanceReason": "A String", # Output only. A reason for the instance condition. "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. "message": "A String", # Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. @@ -599,7 +601,7 @@

Method Details

"satisfiesPzs": True or False, # Output only. Reserved for future use. "scaling": { # Settings for revision-level scaling settings. # Scaling settings for this revision. "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable concurrency utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. - "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. + "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled. "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index f1402f637d..66424f0203 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -79,6 +79,11 @@ }, { "description": "Locational Endpoint", +"endpointUrl": "https://asia-southeast4-run.googleapis.com/", +"location": "asia-southeast4" +}, +{ +"description": "Locational Endpoint", "endpointUrl": "https://australia-southeast1-run.googleapis.com/", "location": "australia-southeast1" }, @@ -314,6 +319,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://run.asia-southeast4.rep.googleapis.com/", +"location": "asia-southeast4" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://run.australia-southeast1.rep.googleapis.com/", "location": "australia-southeast1" }, @@ -3642,7 +3652,7 @@ } } }, -"revision": "20260629", +"revision": "20260713", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 45364945e7..c9b3176948 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -79,6 +79,11 @@ }, { "description": "Locational Endpoint", +"endpointUrl": "https://asia-southeast4-run.googleapis.com/", +"location": "asia-southeast4" +}, +{ +"description": "Locational Endpoint", "endpointUrl": "https://australia-southeast1-run.googleapis.com/", "location": "australia-southeast1" }, @@ -314,6 +319,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://run.asia-southeast4.rep.googleapis.com/", +"location": "asia-southeast4" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://run.australia-southeast1.rep.googleapis.com/", "location": "australia-southeast1" }, @@ -2613,7 +2623,7 @@ } } }, -"revision": "20260619", +"revision": "20260717", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2814,6 +2824,25 @@ "readOnly": true, "type": "string" }, +"instanceReason": { +"description": "Output only. A reason for the instance condition.", +"enum": [ +"INSTANCE_REASON_UNSPECIFIED", +"INSTANCE_DELETED", +"INSTANCE_STOPPED", +"INSTANCE_STOPPING", +"INSTANCE_NON_ZERO_EXIT_CODE" +], +"enumDescriptions": [ +"Default value.", +"Instance deleted.", +"Instance stopped.", +"Instance stopping.", +"Instance exited with a non-zero exit code." +], +"readOnly": true, +"type": "string" +}, "lastTransitionTime": { "description": "Last time the condition transitioned from one status to another.", "format": "google-datetime", @@ -4651,7 +4680,7 @@ "type": "number" }, "cpuUtilization": { -"description": "Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled.", +"description": "Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled.", "format": "float", "type": "number" }, @@ -5046,6 +5075,10 @@ "$ref": "GoogleCloudRunV2ServiceScaling", "description": "Optional. Specifies service-level scaling settings" }, +"sshEnabled": { +"description": "Optional. Enables SSH access to the Service.", +"type": "boolean" +}, "template": { "$ref": "GoogleCloudRunV2RevisionTemplate", "description": "Required. The template used to create revisions for this Service." From 3b21321128fa984a1087c799704fc43aa92c890b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:09 +0000 Subject: [PATCH 73/84] fix(saasservicemgmt): update the api #### saasservicemgmt:v1 The following keys were changed: - resources.projects.resources.locations.resources.releases.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.releases.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.releases.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.releases.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.releases.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rolloutKinds.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rolloutKinds.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rolloutKinds.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rolloutKinds.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rolloutKinds.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rollouts.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rollouts.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rollouts.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rollouts.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rollouts.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saas.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saas.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saas.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saas.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saas.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.tenants.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.tenants.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.tenants.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.tenants.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.tenants.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitKinds.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitKinds.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitKinds.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitKinds.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitKinds.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitOperations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitOperations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitOperations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitOperations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitOperations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.units.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.units.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.units.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.units.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.units.methods.patch.scopes (Total Keys: 1) #### saasservicemgmt:v1beta1 The following keys were changed: - resources.projects.resources.locations.resources.flagAttributes.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flagAttributes.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flagAttributes.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flagAttributes.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flagAttributes.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flagReleases.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flagReleases.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flagReleases.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flagReleases.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flagReleases.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flags.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flags.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flags.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flags.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.flags.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.releases.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.releases.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.releases.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.releases.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.releases.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rolloutKinds.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rolloutKinds.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rolloutKinds.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rolloutKinds.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rolloutKinds.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rollouts.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rollouts.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rollouts.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rollouts.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rollouts.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saas.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saas.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saas.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saas.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saas.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saasReleases.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saasReleases.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saasReleases.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saasReleases.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.saasReleases.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.tenants.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.tenants.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.tenants.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.tenants.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.tenants.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitGroupOperations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitGroupOperations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitGroupOperations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitGroupOperations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitGroupOperations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitGroups.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitGroups.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitGroups.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitGroups.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitGroups.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitKinds.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitKinds.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitKinds.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitKinds.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitKinds.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitOperations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitOperations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitOperations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitOperations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.unitOperations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.units.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.units.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.units.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.units.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.units.methods.patch.scopes (Total Keys: 1) --- .../documents/saasservicemgmt.v1.json | 144 +++++++--- .../documents/saasservicemgmt.v1beta1.json | 257 ++++++++++++------ 2 files changed, 284 insertions(+), 117 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json index deb4e9fb53..2e0a861314 100644 --- a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json +++ b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json @@ -4,6 +4,12 @@ "scopes": { "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." +}, +"https://www.googleapis.com/auth/saasservicemgmt.read-write": { +"description": "See, edit, configure, and delete your Google Cloud App Lifecycle Management data and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/saasservicemgmt.readonly": { +"description": "See your Google Cloud App Lifecycle Management data and the email address of your Google Account" } } } @@ -225,7 +231,8 @@ "$ref": "Release" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -265,7 +272,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -290,7 +298,9 @@ "$ref": "Release" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -336,7 +346,9 @@ "$ref": "ListReleasesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -380,7 +392,8 @@ "$ref": "Release" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -427,7 +440,8 @@ "$ref": "RolloutKind" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -467,7 +481,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -492,7 +507,9 @@ "$ref": "RolloutKind" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -538,7 +555,9 @@ "$ref": "ListRolloutKindsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -582,7 +601,8 @@ "$ref": "RolloutKind" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -629,7 +649,8 @@ "$ref": "Rollout" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -669,7 +690,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -694,7 +716,9 @@ "$ref": "Rollout" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -740,7 +764,9 @@ "$ref": "ListRolloutsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -784,7 +810,8 @@ "$ref": "Rollout" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -831,7 +858,8 @@ "$ref": "Saas" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -871,7 +899,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -896,7 +925,9 @@ "$ref": "Saas" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -942,7 +973,9 @@ "$ref": "ListSaasResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -986,7 +1019,8 @@ "$ref": "Saas" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -1033,7 +1067,8 @@ "$ref": "Tenant" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -1073,7 +1108,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -1098,7 +1134,9 @@ "$ref": "Tenant" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -1144,7 +1182,9 @@ "$ref": "ListTenantsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -1188,7 +1228,8 @@ "$ref": "Tenant" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -1235,7 +1276,8 @@ "$ref": "UnitKind" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -1275,7 +1317,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -1300,7 +1343,9 @@ "$ref": "UnitKind" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -1346,7 +1391,9 @@ "$ref": "ListUnitKindsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -1390,7 +1437,8 @@ "$ref": "UnitKind" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -1437,7 +1485,8 @@ "$ref": "UnitOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -1477,7 +1526,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -1502,7 +1552,9 @@ "$ref": "UnitOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -1548,7 +1600,9 @@ "$ref": "ListUnitOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -1592,7 +1646,8 @@ "$ref": "UnitOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -1639,7 +1694,8 @@ "$ref": "Unit" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -1679,7 +1735,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -1704,7 +1761,9 @@ "$ref": "Unit" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -1750,7 +1809,9 @@ "$ref": "ListUnitsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -1794,7 +1855,8 @@ "$ref": "Unit" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -1804,7 +1866,7 @@ } } }, -"revision": "20260610", +"revision": "20260708", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { diff --git a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json index 899588cccb..64ac79cfd7 100644 --- a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json @@ -4,6 +4,12 @@ "scopes": { "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." +}, +"https://www.googleapis.com/auth/saasservicemgmt.read-write": { +"description": "See, edit, configure, and delete your Google Cloud App Lifecycle Management data and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/saasservicemgmt.readonly": { +"description": "See your Google Cloud App Lifecycle Management data and the email address of your Google Account" } } } @@ -225,7 +231,8 @@ "$ref": "FlagAttribute" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -265,7 +272,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -290,7 +298,9 @@ "$ref": "FlagAttribute" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -336,7 +346,9 @@ "$ref": "ListFlagAttributesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -380,7 +392,8 @@ "$ref": "FlagAttribute" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -427,7 +440,8 @@ "$ref": "FlagRelease" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -467,7 +481,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -492,7 +507,9 @@ "$ref": "FlagRelease" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -538,7 +555,9 @@ "$ref": "ListFlagReleasesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -582,7 +601,8 @@ "$ref": "FlagRelease" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -629,7 +649,8 @@ "$ref": "FlagRevision" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -669,7 +690,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -694,7 +716,9 @@ "$ref": "FlagRevision" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -740,7 +764,9 @@ "$ref": "ListFlagRevisionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -784,7 +810,8 @@ "$ref": "FlagRevision" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -831,7 +858,8 @@ "$ref": "Flag" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -871,7 +899,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -896,7 +925,9 @@ "$ref": "Flag" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -942,7 +973,9 @@ "$ref": "ListFlagsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -986,7 +1019,8 @@ "$ref": "Flag" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -1033,7 +1067,8 @@ "$ref": "Release" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -1073,7 +1108,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -1098,7 +1134,9 @@ "$ref": "Release" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -1144,7 +1182,9 @@ "$ref": "ListReleasesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -1188,7 +1228,8 @@ "$ref": "Release" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -1235,7 +1276,8 @@ "$ref": "RolloutKind" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -1275,7 +1317,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -1300,7 +1343,9 @@ "$ref": "RolloutKind" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -1346,7 +1391,9 @@ "$ref": "ListRolloutKindsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -1390,7 +1437,8 @@ "$ref": "RolloutKind" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -1437,7 +1485,8 @@ "$ref": "Rollout" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -1477,7 +1526,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -1502,7 +1552,9 @@ "$ref": "Rollout" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -1548,7 +1600,9 @@ "$ref": "ListRolloutsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -1592,7 +1646,8 @@ "$ref": "Rollout" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -1639,7 +1694,8 @@ "$ref": "Saas" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -1679,7 +1735,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -1704,7 +1761,9 @@ "$ref": "Saas" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -1750,7 +1809,9 @@ "$ref": "ListSaasResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -1794,7 +1855,8 @@ "$ref": "Saas" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -1841,7 +1903,8 @@ "$ref": "SaasRelease" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -1881,7 +1944,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -1906,7 +1970,8 @@ "$ref": "SaasRelease" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "list": { @@ -1952,7 +2017,8 @@ "$ref": "ListSaasReleasesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "patch": { @@ -1996,7 +2062,8 @@ "$ref": "SaasRelease" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -2043,7 +2110,8 @@ "$ref": "Tenant" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -2083,7 +2151,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -2108,7 +2177,9 @@ "$ref": "Tenant" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -2154,7 +2225,9 @@ "$ref": "ListTenantsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -2198,7 +2271,8 @@ "$ref": "Tenant" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -2245,7 +2319,8 @@ "$ref": "UnitGroupOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -2285,7 +2360,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -2310,7 +2386,8 @@ "$ref": "UnitGroupOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "list": { @@ -2356,7 +2433,8 @@ "$ref": "ListUnitGroupOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "patch": { @@ -2400,7 +2478,8 @@ "$ref": "UnitGroupOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -2447,7 +2526,8 @@ "$ref": "UnitGroup" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -2487,7 +2567,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -2512,7 +2593,8 @@ "$ref": "UnitGroup" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "list": { @@ -2558,7 +2640,8 @@ "$ref": "ListUnitGroupsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "patch": { @@ -2602,7 +2685,8 @@ "$ref": "UnitGroup" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -2649,7 +2733,8 @@ "$ref": "UnitKind" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -2689,7 +2774,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -2714,7 +2800,9 @@ "$ref": "UnitKind" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -2760,7 +2848,9 @@ "$ref": "ListUnitKindsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -2804,7 +2894,8 @@ "$ref": "UnitKind" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -2851,7 +2942,8 @@ "$ref": "UnitOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -2891,7 +2983,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -2916,7 +3009,9 @@ "$ref": "UnitOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -2962,7 +3057,9 @@ "$ref": "ListUnitOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -3006,7 +3103,8 @@ "$ref": "UnitOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -3053,7 +3151,8 @@ "$ref": "Unit" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "delete": { @@ -3093,7 +3192,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "get": { @@ -3118,7 +3218,9 @@ "$ref": "Unit" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "list": { @@ -3164,7 +3266,9 @@ "$ref": "ListUnitsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write", +"https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { @@ -3208,7 +3312,8 @@ "$ref": "Unit" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/saasservicemgmt.read-write" ] } } @@ -3218,7 +3323,7 @@ } } }, -"revision": "20260624", +"revision": "20260708", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { From 1d3fc4bb473482a41ac251b8a9b70aa01bdd40e0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:12 +0000 Subject: [PATCH 74/84] feat(searchads360): update the api #### searchads360:v0 The following keys were added: - schemas.GoogleAdsSearchads360V0Common__SyntheticContentAttestation (Total Keys: 4) - schemas.GoogleAdsSearchads360V0Common__SyntheticContentInfo (Total Keys: 5) - schemas.GoogleAdsSearchads360V0Resources__Ad.properties.syntheticContentInfo.$ref (Total Keys: 1) - schemas.GoogleAdsSearchads360V0Resources__Asset.properties.syntheticContentInfo.$ref (Total Keys: 1) #### searchads360:v23 The following keys were added: - resources.customers.methods.uploadCallConversions (Total Keys: 12) - resources.customers.methods.uploadClickConversions (Total Keys: 12) - resources.customers.methods.uploadConversionAdjustments (Total Keys: 12) - resources.customers.resources.searchAds360Campaigns.methods.mutate (Total Keys: 12) - schemas.GoogleAdsSearchads360V23Common__Segments.properties.mobileDevicePlatform.type (Total Keys: 1) - schemas.GoogleAdsSearchads360V23Common__SyntheticContentAttestation (Total Keys: 4) - schemas.GoogleAdsSearchads360V23Common__SyntheticContentInfo (Total Keys: 5) - schemas.GoogleAdsSearchads360V23Resources__Ad.properties.syntheticContentInfo.$ref (Total Keys: 1) - schemas.GoogleAdsSearchads360V23Resources__Asset.properties.syntheticContentInfo.$ref (Total Keys: 1) - schemas.GoogleAdsSearchads360V23Services_CartData_Item (Total Keys: 7) - schemas.GoogleAdsSearchads360V23Services__CallConversion (Total Keys: 18) - schemas.GoogleAdsSearchads360V23Services__CartData (Total Keys: 10) - schemas.GoogleAdsSearchads360V23Services__ClickConversion (Total Keys: 33) - schemas.GoogleAdsSearchads360V23Services__ConversionAdjustment (Total Keys: 18) - schemas.GoogleAdsSearchads360V23Services__CustomVariable (Total Keys: 4) - schemas.GoogleAdsSearchads360V23Services__ExternalAttributionData (Total Keys: 5) - schemas.GoogleAdsSearchads360V23Services__GclidDateTimePair (Total Keys: 4) - schemas.GoogleAdsSearchads360V23Services__MutateSearchAds360CampaignsRequest (Total Keys: 7) - schemas.GoogleAdsSearchads360V23Services__MutateSearchAds360CampaignsResponse (Total Keys: 4) - schemas.GoogleAdsSearchads360V23Services__RestatementValue (Total Keys: 5) - schemas.GoogleAdsSearchads360V23Services__SessionAttributeKeyValuePair (Total Keys: 4) - schemas.GoogleAdsSearchads360V23Services__SessionAttributesKeyValuePairs (Total Keys: 4) - schemas.GoogleAdsSearchads360V23Services__UploadCallConversionsRequest (Total Keys: 6) - schemas.GoogleAdsSearchads360V23Services__UploadCallConversionsResponse (Total Keys: 5) - schemas.GoogleAdsSearchads360V23Services__UploadClickConversionsRequest (Total Keys: 8) - schemas.GoogleAdsSearchads360V23Services__UploadClickConversionsResponse (Total Keys: 7) - schemas.GoogleAdsSearchads360V23Services__UploadConversionAdjustmentsRequest (Total Keys: 8) - schemas.GoogleAdsSearchads360V23Services__UploadConversionAdjustmentsResponse (Total Keys: 7) --- ...earchads360_v0.customers.searchAds360.html | 172 ++-- ...searchads360_v23.customers.adGroupAds.html | 42 +- docs/dyn/searchads360_v23.customers.ads.html | 28 +- .../searchads360_v23.customers.assets.html | 30 + .../searchads360_v23.customers.batchJobs.html | 110 +- ...chads360_v23.customers.customerLabels.html | 6 +- ...chads360_v23.customers.experimentArms.html | 6 +- docs/dyn/searchads360_v23.customers.html | 294 ++++++ ...hads360_v23.customers.recommendations.html | 220 +++- ...archads360_v23.customers.searchAds360.html | 744 +++++++++++--- ...0_v23.customers.searchAds360Campaigns.html | 134 +++ .../documents/searchads360.v0.json | 161 ++- .../documents/searchads360.v23.json | 971 +++++++++++++++++- 13 files changed, 2560 insertions(+), 358 deletions(-) create mode 100644 docs/dyn/searchads360_v23.customers.searchAds360Campaigns.html diff --git a/docs/dyn/searchads360_v0.customers.searchAds360.html b/docs/dyn/searchads360_v0.customers.searchAds360.html index 288d199614..e444190f42 100644 --- a/docs/dyn/searchads360_v0.customers.searchAds360.html +++ b/docs/dyn/searchads360_v0.customers.searchAds360.html @@ -221,7 +221,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "expandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "expandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -264,6 +264,16 @@

Method Details

"path1": "A String", # Text appended to the auto-generated visible URL with a delimiter. "path2": "A String", # Text appended to path1 with a delimiter. }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAd": { # A Search Ads 360 text ad. # Immutable. Details pertaining to a text ad. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. @@ -417,7 +427,7 @@

Method Details

"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label. "resourceName": "A String", # Immutable. The resource name of the ad group label. Ad group label resource names have the form: `customers/{owner_customer_id}/adGroupLabels/{ad_group_id}~{label_id}` }, - "ageRangeView": { # An age range view. # The age range view referenced in the query. + "ageRangeView": { # An age range view. Represents the view of a customer's performance metrics (like impressions and clicks) aggregated by age range. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API. # The age range view referenced in the query. "resourceName": "A String", # Output only. The resource name of the age range view. Age range view resource names have the form: `customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}` }, "asset": { # Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc. Assets are immutable and cannot be removed. To stop an asset from serving, remove the asset from the entity that is using it. # The asset referenced in the query. @@ -524,6 +534,16 @@

Method Details

"useSearcherTimeZone": True or False, # Whether to show the sitelink asset in search user's time zone. Applies to Microsoft Ads. }, "status": "A String", # Output only. The status of the asset. + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Output only. A text asset. "text": "A String", # Text content of the text asset. }, @@ -1081,7 +1101,7 @@

Method Details

"landingPage": "A String", # Output only. The dynamically selected landing page URL of the impression. This field is read-only. "resourceName": "A String", # Output only. The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form: `customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}~{search_term_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}` }, - "genderView": { # A gender view. The gender_view resource reflects the effective serving state, rather than what criteria were added. An ad group without gender criteria by default shows to all genders, so all genders appear in gender_view with stats. # The gender view referenced in the query. + "genderView": { # A gender view resource. Represents the view of a customer's performance metrics aggregated by gender. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API. # The gender view referenced in the query. "resourceName": "A String", # Output only. The resource name of the gender view. Gender view resource names have the form: `customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}` }, "geoTargetConstant": { # A geo target constant. # The geo target constant referenced in the query. @@ -1120,7 +1140,7 @@

Method Details

"metrics": { # Metrics data. # The metrics. "absoluteTopImpressionPercentage": 3.14, # Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position. "allConversions": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. - "allConversionsByConversionDate": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "allConversionsByConversionDate": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611). "allConversionsFromClickToCall": 3.14, # The number of times people clicked the "Call" button to call a business during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only. "allConversionsFromDirections": 3.14, # The number of times people clicked a "Get directions" button to navigate to a business after clicking an ad. This metric applies to feed items only. "allConversionsFromInteractionsRate": 3.14, # All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions. @@ -1131,25 +1151,25 @@

Method Details

"allConversionsFromStoreVisit": 3.14, # Estimated number of times people visited a business after clicking an ad. This metric applies to feed items only. "allConversionsFromStoreWebsite": 3.14, # The number of times that people were taken to a business's URL after clicking an ad. This metric applies to feed items only. "allConversionsValue": 3.14, # The value of all conversions. - "allConversionsValueByConversionDate": 3.14, # The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "allConversionsValueByConversionDate": 3.14, # The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611). "allConversionsValuePerCost": 3.14, # The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads). "averageCartSize": 3.14, # Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data. "averageCost": 3.14, # The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions. - "averageCpc": 3.14, # The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "averageCpc": 3.14, # The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "averageImpressionFrequencyPerUser": 3.14, # The average number of times a unique user saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App. "averageOrderValueMicros": "A String", # Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is $15 = ($10 + $15 + $20)/3. This metric is only available if you report conversions with cart data. "averageQualityScore": 3.14, # The average quality score. "clicks": "A String", # The number of clicks. - "clientAccountConversions": 3.14, # The number of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "clientAccountConversionsValue": 3.14, # The value of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "clientAccountCrossSellCostOfGoodsSoldMicros": "A String", # Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountCrossSellGrossProfitMicros": "A String", # Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountCrossSellRevenueMicros": "A String", # Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "clientAccountConversions": 3.14, # The number of client account conversions. This only includes conversion actions which `include_in_client_account_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "clientAccountConversionsValue": 3.14, # The value of client account conversions. This only includes conversion actions which `include_in_client_account_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "clientAccountCrossSellCostOfGoodsSoldMicros": "A String", # Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountCrossSellGrossProfitMicros": "A String", # Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountCrossSellRevenueMicros": "A String", # Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "clientAccountCrossSellUnitsSold": 3.14, # Client account cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data. - "clientAccountLeadCostOfGoodsSoldMicros": "A String", # Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountLeadGrossProfitMicros": "A String", # Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountLeadRevenueMicros": "A String", # Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "clientAccountLeadCostOfGoodsSoldMicros": "A String", # Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountLeadGrossProfitMicros": "A String", # Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountLeadRevenueMicros": "A String", # Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "clientAccountLeadUnitsSold": 3.14, # Client account lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data. "clientAccountViewThroughConversions": "A String", # The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad. "contentBudgetLostImpressionShare": 3.14, # The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. @@ -1165,28 +1185,28 @@

Method Details

}, ], "conversions": 3.14, # The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "conversionsByConversionDate": 3.14, # The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in date column means the conversion date. + "conversionsByConversionDate": 3.14, # The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in the date column mean the conversion date. "conversionsFromInteractionsRate": 3.14, # Average biddable conversions (from interaction) per conversion eligible interaction. Shows how often, on average, an ad interaction leads to a biddable conversion. - "conversionsFromInteractionsValuePerInteraction": 3.14, # The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "conversionsFromInteractionsValuePerInteraction": 3.14, # The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. "conversionsValue": 3.14, # The sum of conversion values for the conversions included in the "conversions" field. This metric is useful only if you entered a value for your conversion actions. "conversionsValueByConversionDate": 3.14, # The sum of biddable conversions value by conversion date. When this column is selected with date, the values in date column means the conversion date. "conversionsValuePerCost": 3.14, # The value of biddable conversion divided by the total cost of conversion eligible interactions. - "costMicros": "A String", # The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "costMicros": "A String", # The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause) for more details. "costOfGoodsSoldMicros": "A String", # Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data. "costPerAllConversions": 3.14, # The cost of ad interactions divided by all conversions. "costPerConversion": 3.14, # Average conversion eligible cost per biddable conversion. - "costPerCurrentModelAttributedConversion": 3.14, # The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "crossDeviceConversions": 3.14, # Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions. - "crossDeviceConversionsByConversionDate": 3.14, # The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "costPerCurrentModelAttributedConversion": 3.14, # The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "crossDeviceConversions": 3.14, # Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in `all_conversions`. + "crossDeviceConversionsByConversionDate": 3.14, # The number of cross-device conversions by conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611) "crossDeviceConversionsValue": 3.14, # The sum of the value of cross-device conversions. - "crossDeviceConversionsValueByConversionDate": 3.14, # The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. - "crossSellCostOfGoodsSoldMicros": "A String", # Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "crossSellGrossProfitMicros": "A String", # Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "crossSellRevenueMicros": "A String", # Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "crossDeviceConversionsValueByConversionDate": 3.14, # The sum of cross-device conversions value by conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611) + "crossSellCostOfGoodsSoldMicros": "A String", # Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "crossSellGrossProfitMicros": "A String", # Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "crossSellRevenueMicros": "A String", # Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "crossSellUnitsSold": 3.14, # Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data. "ctr": 3.14, # The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions). - "generalInvalidClickRate": 3.14, # The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details. - "generalInvalidClicks": "A String", # Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details. + "generalInvalidClickRate": 3.14, # The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504). + "generalInvalidClicks": "A String", # Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504). "grossProfitMargin": 3.14, # Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced $20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = ($10 - $3)/$10 x 100%. This metric is only available if you report conversions with cart data. "grossProfitMicros": "A String", # Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data. "historicalCreativeQualityScore": "A String", # The creative historical quality score. @@ -1201,9 +1221,9 @@

Method Details

"interactions": "A String", # The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on. "invalidClickRate": 3.14, # The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period. "invalidClicks": "A String", # Number of clicks Google considers illegitimate and doesn't charge you for. - "leadCostOfGoodsSoldMicros": "A String", # Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "leadGrossProfitMicros": "A String", # Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "leadRevenueMicros": "A String", # Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "leadCostOfGoodsSoldMicros": "A String", # Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "leadGrossProfitMicros": "A String", # Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "leadRevenueMicros": "A String", # Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "leadUnitsSold": 3.14, # Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data. "mobileFriendlyClicksPercentage": 3.14, # The percentage of mobile clicks that go to a mobile-friendly page. "orders": 3.14, # Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data. @@ -1217,10 +1237,10 @@

Method Details

}, ], "revenueMicros": "A String", # Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is $25 = ($10 + $20) - $5. This metric is only available if you report conversions with cart data. - "searchAbsoluteTopImpressionShare": 3.14, # The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/sa360/answer/9566729 for details. Any value below 0.1 is reported as 0.0999. + "searchAbsoluteTopImpressionShare": 3.14, # The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See [About top and absolute top metrics](https://support.google.com/sa360/answer/9566729) for details. Any value below 0.1 is reported as 0.0999. "searchBudgetLostAbsoluteTopImpressionShare": 3.14, # The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. "searchBudgetLostImpressionShare": 3.14, # The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. - "searchBudgetLostTopImpressionShare": 3.14, # The number estimating how often your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. + "searchBudgetLostTopImpressionShare": 3.14, # The estimated percent of times that your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. "searchClickShare": 3.14, # The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. "searchExactMatchImpressionShare": 3.14, # The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. "searchImpressionShare": 3.14, # The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. @@ -1232,7 +1252,7 @@

Method Details

"uniqueUsers": "A String", # The number of unique users who saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App. "unitsSold": 3.14, # Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The units sold in this order is 3. This metric is only available if you report conversions with cart data. "valuePerAllConversions": 3.14, # The value of all conversions divided by the number of all conversions. - "valuePerAllConversionsByConversionDate": 3.14, # The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "valuePerAllConversionsByConversionDate": 3.14, # The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611). "valuePerConversion": 3.14, # The value of biddable conversion divided by the number of biddable conversions. Shows how much, on average, each of the biddable conversions is worth. "valuePerConversionsByConversionDate": 3.14, # Biddable conversions value by conversion date divided by biddable conversions by conversion date. Shows how much, on average, each of the biddable conversions is worth (by conversion date). When this column is selected with date, the values in date column means the conversion date. "visits": 3.14, # Clicks that Search Ads 360 has successfully recorded and forwarded to an advertiser's landing page. @@ -1457,7 +1477,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "expandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "expandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -1500,6 +1520,16 @@

Method Details

"path1": "A String", # Text appended to the auto-generated visible URL with a delimiter. "path2": "A String", # Text appended to path1 with a delimiter. }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAd": { # A Search Ads 360 text ad. # Immutable. Details pertaining to a text ad. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. @@ -1653,7 +1683,7 @@

Method Details

"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label. "resourceName": "A String", # Immutable. The resource name of the ad group label. Ad group label resource names have the form: `customers/{owner_customer_id}/adGroupLabels/{ad_group_id}~{label_id}` }, - "ageRangeView": { # An age range view. # The age range view referenced in the query. + "ageRangeView": { # An age range view. Represents the view of a customer's performance metrics (like impressions and clicks) aggregated by age range. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API. # The age range view referenced in the query. "resourceName": "A String", # Output only. The resource name of the age range view. Age range view resource names have the form: `customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}` }, "asset": { # Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc. Assets are immutable and cannot be removed. To stop an asset from serving, remove the asset from the entity that is using it. # The asset referenced in the query. @@ -1760,6 +1790,16 @@

Method Details

"useSearcherTimeZone": True or False, # Whether to show the sitelink asset in search user's time zone. Applies to Microsoft Ads. }, "status": "A String", # Output only. The status of the asset. + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Output only. A text asset. "text": "A String", # Text content of the text asset. }, @@ -2317,7 +2357,7 @@

Method Details

"landingPage": "A String", # Output only. The dynamically selected landing page URL of the impression. This field is read-only. "resourceName": "A String", # Output only. The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form: `customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}~{search_term_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}` }, - "genderView": { # A gender view. The gender_view resource reflects the effective serving state, rather than what criteria were added. An ad group without gender criteria by default shows to all genders, so all genders appear in gender_view with stats. # The gender view referenced in the query. + "genderView": { # A gender view resource. Represents the view of a customer's performance metrics aggregated by gender. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API. # The gender view referenced in the query. "resourceName": "A String", # Output only. The resource name of the gender view. Gender view resource names have the form: `customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}` }, "geoTargetConstant": { # A geo target constant. # The geo target constant referenced in the query. @@ -2356,7 +2396,7 @@

Method Details

"metrics": { # Metrics data. # The metrics. "absoluteTopImpressionPercentage": 3.14, # Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position. "allConversions": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. - "allConversionsByConversionDate": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "allConversionsByConversionDate": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611). "allConversionsFromClickToCall": 3.14, # The number of times people clicked the "Call" button to call a business during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only. "allConversionsFromDirections": 3.14, # The number of times people clicked a "Get directions" button to navigate to a business after clicking an ad. This metric applies to feed items only. "allConversionsFromInteractionsRate": 3.14, # All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions. @@ -2367,25 +2407,25 @@

Method Details

"allConversionsFromStoreVisit": 3.14, # Estimated number of times people visited a business after clicking an ad. This metric applies to feed items only. "allConversionsFromStoreWebsite": 3.14, # The number of times that people were taken to a business's URL after clicking an ad. This metric applies to feed items only. "allConversionsValue": 3.14, # The value of all conversions. - "allConversionsValueByConversionDate": 3.14, # The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "allConversionsValueByConversionDate": 3.14, # The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611). "allConversionsValuePerCost": 3.14, # The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads). "averageCartSize": 3.14, # Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data. "averageCost": 3.14, # The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions. - "averageCpc": 3.14, # The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "averageCpc": 3.14, # The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "averageImpressionFrequencyPerUser": 3.14, # The average number of times a unique user saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App. "averageOrderValueMicros": "A String", # Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is $15 = ($10 + $15 + $20)/3. This metric is only available if you report conversions with cart data. "averageQualityScore": 3.14, # The average quality score. "clicks": "A String", # The number of clicks. - "clientAccountConversions": 3.14, # The number of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "clientAccountConversionsValue": 3.14, # The value of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "clientAccountCrossSellCostOfGoodsSoldMicros": "A String", # Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountCrossSellGrossProfitMicros": "A String", # Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountCrossSellRevenueMicros": "A String", # Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "clientAccountConversions": 3.14, # The number of client account conversions. This only includes conversion actions which `include_in_client_account_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "clientAccountConversionsValue": 3.14, # The value of client account conversions. This only includes conversion actions which `include_in_client_account_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "clientAccountCrossSellCostOfGoodsSoldMicros": "A String", # Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountCrossSellGrossProfitMicros": "A String", # Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountCrossSellRevenueMicros": "A String", # Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "clientAccountCrossSellUnitsSold": 3.14, # Client account cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data. - "clientAccountLeadCostOfGoodsSoldMicros": "A String", # Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountLeadGrossProfitMicros": "A String", # Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountLeadRevenueMicros": "A String", # Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "clientAccountLeadCostOfGoodsSoldMicros": "A String", # Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountLeadGrossProfitMicros": "A String", # Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountLeadRevenueMicros": "A String", # Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "clientAccountLeadUnitsSold": 3.14, # Client account lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data. "clientAccountViewThroughConversions": "A String", # The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad. "contentBudgetLostImpressionShare": 3.14, # The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. @@ -2401,28 +2441,28 @@

Method Details

}, ], "conversions": 3.14, # The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "conversionsByConversionDate": 3.14, # The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in date column means the conversion date. + "conversionsByConversionDate": 3.14, # The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in the date column mean the conversion date. "conversionsFromInteractionsRate": 3.14, # Average biddable conversions (from interaction) per conversion eligible interaction. Shows how often, on average, an ad interaction leads to a biddable conversion. - "conversionsFromInteractionsValuePerInteraction": 3.14, # The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "conversionsFromInteractionsValuePerInteraction": 3.14, # The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. "conversionsValue": 3.14, # The sum of conversion values for the conversions included in the "conversions" field. This metric is useful only if you entered a value for your conversion actions. "conversionsValueByConversionDate": 3.14, # The sum of biddable conversions value by conversion date. When this column is selected with date, the values in date column means the conversion date. "conversionsValuePerCost": 3.14, # The value of biddable conversion divided by the total cost of conversion eligible interactions. - "costMicros": "A String", # The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "costMicros": "A String", # The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause) for more details. "costOfGoodsSoldMicros": "A String", # Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data. "costPerAllConversions": 3.14, # The cost of ad interactions divided by all conversions. "costPerConversion": 3.14, # Average conversion eligible cost per biddable conversion. - "costPerCurrentModelAttributedConversion": 3.14, # The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "crossDeviceConversions": 3.14, # Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions. - "crossDeviceConversionsByConversionDate": 3.14, # The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "costPerCurrentModelAttributedConversion": 3.14, # The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "crossDeviceConversions": 3.14, # Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in `all_conversions`. + "crossDeviceConversionsByConversionDate": 3.14, # The number of cross-device conversions by conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611) "crossDeviceConversionsValue": 3.14, # The sum of the value of cross-device conversions. - "crossDeviceConversionsValueByConversionDate": 3.14, # The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. - "crossSellCostOfGoodsSoldMicros": "A String", # Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "crossSellGrossProfitMicros": "A String", # Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "crossSellRevenueMicros": "A String", # Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "crossDeviceConversionsValueByConversionDate": 3.14, # The sum of cross-device conversions value by conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611) + "crossSellCostOfGoodsSoldMicros": "A String", # Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "crossSellGrossProfitMicros": "A String", # Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "crossSellRevenueMicros": "A String", # Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "crossSellUnitsSold": 3.14, # Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data. "ctr": 3.14, # The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions). - "generalInvalidClickRate": 3.14, # The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details. - "generalInvalidClicks": "A String", # Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details. + "generalInvalidClickRate": 3.14, # The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504). + "generalInvalidClicks": "A String", # Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504). "grossProfitMargin": 3.14, # Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced $20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = ($10 - $3)/$10 x 100%. This metric is only available if you report conversions with cart data. "grossProfitMicros": "A String", # Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data. "historicalCreativeQualityScore": "A String", # The creative historical quality score. @@ -2437,9 +2477,9 @@

Method Details

"interactions": "A String", # The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on. "invalidClickRate": 3.14, # The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period. "invalidClicks": "A String", # Number of clicks Google considers illegitimate and doesn't charge you for. - "leadCostOfGoodsSoldMicros": "A String", # Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "leadGrossProfitMicros": "A String", # Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "leadRevenueMicros": "A String", # Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "leadCostOfGoodsSoldMicros": "A String", # Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "leadGrossProfitMicros": "A String", # Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "leadRevenueMicros": "A String", # Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "leadUnitsSold": 3.14, # Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data. "mobileFriendlyClicksPercentage": 3.14, # The percentage of mobile clicks that go to a mobile-friendly page. "orders": 3.14, # Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data. @@ -2453,10 +2493,10 @@

Method Details

}, ], "revenueMicros": "A String", # Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is $25 = ($10 + $20) - $5. This metric is only available if you report conversions with cart data. - "searchAbsoluteTopImpressionShare": 3.14, # The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/sa360/answer/9566729 for details. Any value below 0.1 is reported as 0.0999. + "searchAbsoluteTopImpressionShare": 3.14, # The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See [About top and absolute top metrics](https://support.google.com/sa360/answer/9566729) for details. Any value below 0.1 is reported as 0.0999. "searchBudgetLostAbsoluteTopImpressionShare": 3.14, # The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. "searchBudgetLostImpressionShare": 3.14, # The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. - "searchBudgetLostTopImpressionShare": 3.14, # The number estimating how often your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. + "searchBudgetLostTopImpressionShare": 3.14, # The estimated percent of times that your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. "searchClickShare": 3.14, # The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. "searchExactMatchImpressionShare": 3.14, # The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. "searchImpressionShare": 3.14, # The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. @@ -2468,7 +2508,7 @@

Method Details

"uniqueUsers": "A String", # The number of unique users who saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App. "unitsSold": 3.14, # Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The units sold in this order is 3. This metric is only available if you report conversions with cart data. "valuePerAllConversions": 3.14, # The value of all conversions divided by the number of all conversions. - "valuePerAllConversionsByConversionDate": 3.14, # The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "valuePerAllConversionsByConversionDate": 3.14, # The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611). "valuePerConversion": 3.14, # The value of biddable conversion divided by the number of biddable conversions. Shows how much, on average, each of the biddable conversions is worth. "valuePerConversionsByConversionDate": 3.14, # Biddable conversions value by conversion date divided by biddable conversions by conversion date. Shows how much, on average, each of the biddable conversions is worth (by conversion date). When this column is selected with date, the values in date column means the conversion date. "visits": 3.14, # Clicks that Search Ads 360 has successfully recorded and forwarded to an advertiser's landing page. diff --git a/docs/dyn/searchads360_v23.customers.adGroupAds.html b/docs/dyn/searchads360_v23.customers.adGroupAds.html index 3b39ebfd84..6732884d27 100644 --- a/docs/dyn/searchads360_v23.customers.adGroupAds.html +++ b/docs/dyn/searchads360_v23.customers.adGroupAds.html @@ -1666,7 +1666,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -2441,7 +2441,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -2789,6 +2789,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -4492,7 +4502,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -5267,7 +5277,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -5615,6 +5625,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -7334,7 +7354,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -8109,7 +8129,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -8457,6 +8477,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. diff --git a/docs/dyn/searchads360_v23.customers.ads.html b/docs/dyn/searchads360_v23.customers.ads.html index 10d7ec2d7f..66feb7abb6 100644 --- a/docs/dyn/searchads360_v23.customers.ads.html +++ b/docs/dyn/searchads360_v23.customers.ads.html @@ -1670,7 +1670,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -2445,7 +2445,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -2793,6 +2793,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -4411,7 +4421,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -5186,7 +5196,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -5534,6 +5544,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. diff --git a/docs/dyn/searchads360_v23.customers.assets.html b/docs/dyn/searchads360_v23.customers.assets.html index 7ec46f94db..2f0de8f945 100644 --- a/docs/dyn/searchads360_v23.customers.assets.html +++ b/docs/dyn/searchads360_v23.customers.assets.html @@ -743,6 +743,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -1404,6 +1414,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -2093,6 +2113,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, diff --git a/docs/dyn/searchads360_v23.customers.batchJobs.html b/docs/dyn/searchads360_v23.customers.batchJobs.html index cf4216a5e9..86ee3df5ff 100644 --- a/docs/dyn/searchads360_v23.customers.batchJobs.html +++ b/docs/dyn/searchads360_v23.customers.batchJobs.html @@ -1680,7 +1680,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -2455,7 +2455,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -2803,6 +2803,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -4506,7 +4516,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -5281,7 +5291,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -5629,6 +5639,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -8348,7 +8368,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -9123,7 +9143,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -9471,6 +9491,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -10613,6 +10643,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -11274,6 +11314,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -13428,8 +13478,8 @@

Method Details

}, "customerLabelOperation": { # A single operation (create, remove) on a customer-label relationship. # A customer label mutate operation. "create": { # Represents a relationship between a customer and a label. This customer may not have access to all the labels attached to it. Additional CustomerLabels may be returned by increasing permissions with login-customer-id. # Create operation: No resource name is expected for the new customer-label relationship. - "customer": "A String", # Output only. The resource name of the customer to which the label is attached. Read only. - "label": "A String", # Output only. The resource name of the label assigned to the customer. Note: the Customer ID portion of the label resource name is not validated when creating a new CustomerLabel. + "customer": "A String", # Output only. The resource name of the customer to which the label is attached. This field should not be set when creating a new `CustomerLabel`. + "label": "A String", # Output only. The resource name of the label assigned to the customer. This field should not be set when creating a new `CustomerLabel`. Note: the Customer ID portion of the label resource name is not validated when creating a new `CustomerLabel`. "resourceName": "A String", # Immutable. Name of the resource. Customer label resource names have the form: `customers/{customer_id}/customerLabels/{label_id}` }, "remove": "A String", # Remove operation: A resource name for the customer-label relationship being removed, in this format: `customers/{customer_id}/customerLabels/{label_id}` @@ -13591,7 +13641,7 @@

Method Details

}, "experimentArmOperation": { # A single operation on an experiment arm. # An experiment arm mutate operation. "create": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # Create operation - "assetGroups": [ # List of asset groups in the experiment arm. + "assetGroups": [ # List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID. { # Holds the asset groups included in an arm of an Optimize Assets experiment. "assetGroup": "A String", # Asset group resource name. "assetGroupAssets": [ # List of asset group assets under the asset group. @@ -13616,7 +13666,7 @@

Method Details

}, "remove": "A String", # Remove operation: The experiment arm is expected to have a valid resource name, in this format: `customers/{customer_id}/experiments/{campaign_experiment_id}` "update": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # Update operation: The experiment arm is expected to have a valid resource name. - "assetGroups": [ # List of asset groups in the experiment arm. + "assetGroups": [ # List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID. { # Holds the asset groups included in an arm of an Optimize Assets experiment. "assetGroup": "A String", # Asset group resource name. "assetGroupAssets": [ # List of asset group assets under the asset group. @@ -15859,7 +15909,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -16634,7 +16684,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -16982,6 +17032,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -19201,7 +19261,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -19976,7 +20036,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -20324,6 +20384,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -21107,6 +21177,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -22396,7 +22476,7 @@

Method Details

}, "experimentArmResult": { # The result for the experiment arm mutate. # The result for the experiment arm mutate. "experimentArm": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # The mutated experiment arm with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE". - "assetGroups": [ # List of asset groups in the experiment arm. + "assetGroups": [ # List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID. { # Holds the asset groups included in an arm of an Optimize Assets experiment. "assetGroup": "A String", # Asset group resource name. "assetGroupAssets": [ # List of asset group assets under the asset group. diff --git a/docs/dyn/searchads360_v23.customers.customerLabels.html b/docs/dyn/searchads360_v23.customers.customerLabels.html index 3b9ec2c307..b22a09b8d2 100644 --- a/docs/dyn/searchads360_v23.customers.customerLabels.html +++ b/docs/dyn/searchads360_v23.customers.customerLabels.html @@ -95,12 +95,12 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Request message for CustomerLabelService.MutateCustomerLabels. +{ # Request message for CustomerLabelService.MutateCustomerLabels. A single `MutateCustomerLabelsRequest` can only modify labels for the single customer account specified in the request. To apply a label to multiple different accounts, separate `MutateCustomerLabelsRequest` calls must be made. "operations": [ # Required. The list of operations to perform on customer-label relationships. { # A single operation (create, remove) on a customer-label relationship. "create": { # Represents a relationship between a customer and a label. This customer may not have access to all the labels attached to it. Additional CustomerLabels may be returned by increasing permissions with login-customer-id. # Create operation: No resource name is expected for the new customer-label relationship. - "customer": "A String", # Output only. The resource name of the customer to which the label is attached. Read only. - "label": "A String", # Output only. The resource name of the label assigned to the customer. Note: the Customer ID portion of the label resource name is not validated when creating a new CustomerLabel. + "customer": "A String", # Output only. The resource name of the customer to which the label is attached. This field should not be set when creating a new `CustomerLabel`. + "label": "A String", # Output only. The resource name of the label assigned to the customer. This field should not be set when creating a new `CustomerLabel`. Note: the Customer ID portion of the label resource name is not validated when creating a new `CustomerLabel`. "resourceName": "A String", # Immutable. Name of the resource. Customer label resource names have the form: `customers/{customer_id}/customerLabels/{label_id}` }, "remove": "A String", # Remove operation: A resource name for the customer-label relationship being removed, in this format: `customers/{customer_id}/customerLabels/{label_id}` diff --git a/docs/dyn/searchads360_v23.customers.experimentArms.html b/docs/dyn/searchads360_v23.customers.experimentArms.html index 6aed422b62..7114d3b6bb 100644 --- a/docs/dyn/searchads360_v23.customers.experimentArms.html +++ b/docs/dyn/searchads360_v23.customers.experimentArms.html @@ -99,7 +99,7 @@

Method Details

"operations": [ # Required. The list of operations to perform on individual experiment arm. { # A single operation on an experiment arm. "create": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # Create operation - "assetGroups": [ # List of asset groups in the experiment arm. + "assetGroups": [ # List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID. { # Holds the asset groups included in an arm of an Optimize Assets experiment. "assetGroup": "A String", # Asset group resource name. "assetGroupAssets": [ # List of asset group assets under the asset group. @@ -124,7 +124,7 @@

Method Details

}, "remove": "A String", # Remove operation: The experiment arm is expected to have a valid resource name, in this format: `customers/{customer_id}/experiments/{campaign_experiment_id}` "update": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # Update operation: The experiment arm is expected to have a valid resource name. - "assetGroups": [ # List of asset groups in the experiment arm. + "assetGroups": [ # List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID. { # Holds the asset groups included in an arm of an Optimize Assets experiment. "assetGroup": "A String", # Asset group resource name. "assetGroupAssets": [ # List of asset group assets under the asset group. @@ -176,7 +176,7 @@

Method Details

"results": [ # All results for the mutate. { # The result for the experiment arm mutate. "experimentArm": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # The mutated experiment arm with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE". - "assetGroups": [ # List of asset groups in the experiment arm. + "assetGroups": [ # List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID. { # Holds the asset groups included in an arm of an Optimize Assets experiment. "assetGroup": "A String", # Asset group resource name. "assetGroupAssets": [ # List of asset group assets under the asset group. diff --git a/docs/dyn/searchads360_v23.customers.html b/docs/dyn/searchads360_v23.customers.html index e00ddd8099..6b01cff12c 100644 --- a/docs/dyn/searchads360_v23.customers.html +++ b/docs/dyn/searchads360_v23.customers.html @@ -504,6 +504,11 @@

Instance Methods

Returns the searchAds360 Resource.

+

+ searchAds360Campaigns() +

+

Returns the searchAds360Campaigns Resource.

+

sharedCriteria()

@@ -609,6 +614,15 @@

Instance Methods

suggestTravelAssets(customerId, body=None, x__xgafv=None)

Returns Travel Asset suggestions. Asset suggestions are returned on a best-effort basis. There are no guarantees that all possible asset types will be returned for any given hotel property.

+

+ uploadCallConversions(customerId, body=None, x__xgafv=None)

+

Processes the given call conversions. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()

+

+ uploadClickConversions(customerId, body=None, x__xgafv=None)

+

Processes the given click conversions. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ConversionUploadError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()

+

+ uploadConversionAdjustments(customerId, body=None, x__xgafv=None)

+

Processes the given conversion adjustments. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()

uploadUserData(customerId, body=None, x__xgafv=None)

Uploads the given user data. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [OfflineUserDataJobError]() [QuotaError]() [RequestError]() [UserDataError]()

@@ -4252,6 +4266,286 @@

Method Details

}
+
+ uploadCallConversions(customerId, body=None, x__xgafv=None) +
Processes the given call conversions. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()
+
+Args:
+  customerId: string, Required. The ID of the customer performing the upload. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConversionUploadService.UploadCallConversions.
+  "conversions": [ # Required. The conversions that are being uploaded.
+    { # A call conversion.
+      "callStartDateTime": "A String", # The date time at which the call occurred. The timezone must be specified. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
+      "callerId": "A String", # The caller id from which this call was placed. Caller id is expected to be in E.164 format with preceding '+' sign, for example, "+16502531234".
+      "consent": { # Consent # The consent setting for the event.
+        "adPersonalization": "A String", # This represents consent for ad personalization. This can only be set for OfflineUserDataJobService and UserDataService.
+        "adUserData": "A String", # This represents consent for ad user data.
+      },
+      "conversionAction": "A String", # Resource name of the conversion action associated with this conversion. Note: Although this resource name consists of a customer id and a conversion action id, validation will ignore the customer id and use the conversion action id as the sole identifier of the conversion action.
+      "conversionDateTime": "A String", # The date time at which the conversion occurred. Must be after the call time. The timezone must be specified. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
+      "conversionValue": 3.14, # The value of the conversion for the advertiser.
+      "currencyCode": "A String", # Currency associated with the conversion value. This is the ISO 4217 3-character currency code. For example: USD, EUR.
+      "customVariables": [ # The custom variables associated with this conversion.
+        { # A custom variable.
+          "conversionCustomVariable": "A String", # Resource name of the custom variable associated with this conversion. Note: Although this resource name consists of a customer id and a conversion custom variable id, validation will ignore the customer id and use the conversion custom variable id as the sole identifier of the conversion custom variable.
+          "value": "A String", # The value string of this custom variable. The value of the custom variable should not contain private customer data, such as email addresses or phone numbers.
+        },
+      ],
+    },
+  ],
+  "partialFailure": True or False, # Required. If `true`, successful operations will be carried out and invalid operations will return errors. If `false`, all operations will be carried out in one transaction if and only if they are all valid. This should always be set to `true`.
+  "validateOnly": True or False, # If true, the request is validated but not executed. Only errors are returned, not results.
+}
+
+  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 ConversionUploadService.UploadCallConversions.
+  "partialFailureError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Errors that pertain to conversion failures in the partial failure mode. Returned when all errors occur inside the conversions. If any errors occur outside the conversions (for example, auth errors), we return an RPC level error.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "results": [ # Returned for successfully processed conversions. Proto will be empty for rows that received an error. Results are not returned when `validate_only` is `true`.
+    { # Identifying information for a successfully processed CallConversionUpload.
+      "callStartDateTime": "A String", # The date time at which the call occurred. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
+      "callerId": "A String", # The caller id from which this call was placed. Caller id is expected to be in E.164 format with preceding '+' sign.
+      "conversionAction": "A String", # Resource name of the conversion action associated with this conversion.
+      "conversionDateTime": "A String", # The date time at which the conversion occurred. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
+    },
+  ],
+}
+
+ +
+ uploadClickConversions(customerId, body=None, x__xgafv=None) +
Processes the given click conversions. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ConversionUploadError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()
+
+Args:
+  customerId: string, Required. The ID of the customer performing the upload. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConversionUploadService.UploadClickConversions.
+  "conversions": [ # Required. The conversions that are being uploaded.
+    { # A click conversion.
+      "cartData": { # Contains additional information about cart data. # The cart data associated with this conversion.
+        "feedCountryCode": "A String", # The country code associated with the feed where the items are uploaded.
+        "feedLanguageCode": "A String", # The language code associated with the feed where the items are uploaded.
+        "items": [ # Data of the items purchased.
+          { # Contains data of the items purchased.
+            "productId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier.
+            "quantity": 42, # Number of items sold.
+            "unitPrice": 3.14, # Unit price excluding tax, shipping, and any transaction level discounts. The currency code is the same as that in the `ClickConversion` message.
+          },
+        ],
+        "localTransactionCost": 3.14, # Sum of all transaction level discounts, such as free shipping and coupon discounts for the whole cart. The currency code is the same as that in the `ClickConversion` message.
+        "merchantId": "A String", # The Merchant Center ID where the items are uploaded.
+      },
+      "consent": { # Consent # The consent setting for the event.
+        "adPersonalization": "A String", # This represents consent for ad personalization. This can only be set for OfflineUserDataJobService and UserDataService.
+        "adUserData": "A String", # This represents consent for ad user data.
+      },
+      "conversionAction": "A String", # Resource name of the conversion action associated with this conversion. Note: Although this resource name consists of a customer id and a conversion action id, validation will ignore the customer id and use the conversion action id as the sole identifier of the conversion action.
+      "conversionDateTime": "A String", # The date time at which the conversion occurred. Must be after the click time. The timezone must be specified. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
+      "conversionEnvironment": "A String", # The environment this conversion was recorded on, for example, App or Web.
+      "conversionValue": 3.14, # The value of the conversion for the advertiser.
+      "currencyCode": "A String", # Currency associated with the conversion value. This is the ISO 4217 3-character currency code. For example: USD, EUR.
+      "customVariables": [ # The custom variables associated with this conversion.
+        { # A custom variable.
+          "conversionCustomVariable": "A String", # Resource name of the custom variable associated with this conversion. Note: Although this resource name consists of a customer id and a conversion custom variable id, validation will ignore the customer id and use the conversion custom variable id as the sole identifier of the conversion custom variable.
+          "value": "A String", # The value string of this custom variable. The value of the custom variable should not contain private customer data, such as email addresses or phone numbers.
+        },
+      ],
+      "customerType": "A String", # Type of the customer associated with the conversion (new or returning).
+      "externalAttributionData": { # Contains additional information about externally attributed conversions. # Additional data about externally attributed conversions. This field is required for conversions with an externally attributed conversion action, but should not be set otherwise.
+        "externalAttributionCredit": 3.14, # Represents the fraction of the conversion that is attributed to the Google Ads click.
+        "externalAttributionModel": "A String", # Specifies the attribution model name.
+      },
+      "gbraid": "A String", # The URL parameter for clicks associated with app conversions.
+      "gclid": "A String", # The Google click ID (gclid) associated with this conversion.
+      "orderId": "A String", # The order ID associated with the conversion. An order id can only be used for one conversion per conversion action.
+      "sessionAttributesEncoded": "A String", # The session attributes for the event, represented as a base64-encoded JSON string. The content should be generated by Google-provided library. To set session attributes individually, use session_attributes_key_value_pairs instead. This field is only available to allowlisted users. To include this field in conversion imports, upgrade to the Data Manager API.
+      "sessionAttributesKeyValuePairs": { # Contains session attributes of the conversion, represented as key-value pairs. # The session attributes for the event, represented as key-value pairs. This field is only available to allowlisted users. To include this field in conversion imports, upgrade to the Data Manager API.
+        "keyValuePairs": [ # Required. The session attributes for the conversion.
+          { # Contains one session attribute of the conversion.
+            "sessionAttributeKey": "A String", # Required. The name of the session attribute.
+            "sessionAttributeValue": "A String", # Required. The value of the session attribute.
+          },
+        ],
+      },
+      "userIdentifiers": [ # The user identifiers associated with this conversion. Only hashed_email and hashed_phone_number are supported for conversion uploads. The maximum number of user identifiers for each conversion is 5.
+        { # identifying information.
+          "addressInfo": { # Address identifier of offline data. # Address information.
+            "city": "A String", # City of the address. Only accepted for Store Sales.
+            "countryCode": "A String", # 2-letter country code in ISO-3166-1 alpha-2 of the user's address.
+            "hashedFirstName": "A String", # First name of the user, which is hashed as SHA-256 after normalized (Lowercase all characters; Remove any extra spaces before, after, and in between).
+            "hashedLastName": "A String", # Last name of the user, which is hashed as SHA-256 after normalized (lower case only and no punctuation).
+            "hashedStreetAddress": "A String", # The street address of the user hashed using SHA-256 hash function after normalization (lower case only). Only accepted for ConversionAdjustmentUploadService.
+            "postalCode": "A String", # Postal code of the user's address.
+            "state": "A String", # State code of the address. Only accepted for Store Sales.
+          },
+          "hashedEmail": "A String", # Hashed email address using SHA-256 hash function after normalization.
+          "hashedPhoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
+          "mobileId": "A String", # Mobile device ID (advertising ID/IDFA).
+          "thirdPartyUserId": "A String", # Advertiser-assigned user ID for Customer Match upload, or third-party-assigned user ID for
+          "userIdentifierSource": "A String", # Source of the user identifier when the upload is from Store Sales
+        },
+      ],
+      "userIpAddress": "A String", # The IP address of the customer when they arrived on the landing page after an ad click but before a conversion event. This is the IP address of the customer's device, not the advertiser's server. Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See [About offline conversion imports](//support.google.com/google-ads/answer/2998031) page for more details. This field is only available to allowlisted users. To include this field in conversion imports, upgrade to the Data Manager API.
+      "wbraid": "A String", # The URL parameter for clicks associated with web conversions.
+    },
+  ],
+  "jobId": 42, # Optional. Optional input to set job ID. Must be a non-negative number that is less than 2^31 if provided. If this field is not provided, the API will generate a job ID in the range [2^31, (2^63)-1]. The API will return the value for this request in the `job_id` field of the `UploadClickConversionsResponse`.
+  "partialFailure": True or False, # Required. If `true`, successful operations will be carried out and invalid operations will return errors. If `false`, all operations will be carried out in one transaction if and only if they are all valid. This should always be set to `true`.
+  "validateOnly": True or False, # If `true`, the request is validated but not executed. Only errors are returned, not results.
+}
+
+  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 ConversionUploadService.UploadClickConversions.
+  "jobId": "A String", # Job ID for the upload batch.
+  "partialFailureError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Errors that pertain to conversion failures in the partial failure mode. Returned when all errors occur inside the conversions. If any errors occur outside the conversions (for example, auth errors), we return an RPC level error.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "results": [ # Returned for successfully processed conversions. Proto will be empty for rows that received an error. Results are not returned when `validate_only` is `true`.
+    { # Identifying information for a successfully processed `ClickConversion`.
+      "conversionAction": "A String", # Resource name of the conversion action associated with this conversion.
+      "conversionDateTime": "A String", # The date time at which the conversion occurred. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
+      "gbraid": "A String", # The URL parameter for clicks associated with app conversions.
+      "gclid": "A String", # The Google Click ID (gclid) associated with this conversion.
+      "userIdentifiers": [ # The user identifiers associated with this conversion. Only hashed_email and hashed_phone_number are supported for conversion uploads. The maximum number of user identifiers for each conversion is 5.
+        { # identifying information.
+          "addressInfo": { # Address identifier of offline data. # Address information.
+            "city": "A String", # City of the address. Only accepted for Store Sales.
+            "countryCode": "A String", # 2-letter country code in ISO-3166-1 alpha-2 of the user's address.
+            "hashedFirstName": "A String", # First name of the user, which is hashed as SHA-256 after normalized (Lowercase all characters; Remove any extra spaces before, after, and in between).
+            "hashedLastName": "A String", # Last name of the user, which is hashed as SHA-256 after normalized (lower case only and no punctuation).
+            "hashedStreetAddress": "A String", # The street address of the user hashed using SHA-256 hash function after normalization (lower case only). Only accepted for ConversionAdjustmentUploadService.
+            "postalCode": "A String", # Postal code of the user's address.
+            "state": "A String", # State code of the address. Only accepted for Store Sales.
+          },
+          "hashedEmail": "A String", # Hashed email address using SHA-256 hash function after normalization.
+          "hashedPhoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
+          "mobileId": "A String", # Mobile device ID (advertising ID/IDFA).
+          "thirdPartyUserId": "A String", # Advertiser-assigned user ID for Customer Match upload, or third-party-assigned user ID for
+          "userIdentifierSource": "A String", # Source of the user identifier when the upload is from Store Sales
+        },
+      ],
+      "wbraid": "A String", # The URL parameter for clicks associated with web conversions.
+    },
+  ],
+}
+
+ +
+ uploadConversionAdjustments(customerId, body=None, x__xgafv=None) +
Processes the given conversion adjustments. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()
+
+Args:
+  customerId: string, Required. The ID of the customer performing the upload. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConversionAdjustmentUploadService.UploadConversionAdjustments.
+  "conversionAdjustments": [ # Required. The conversion adjustments that are being uploaded.
+    { # A conversion adjustment.
+      "adjustmentDateTime": "A String", # The date time at which the adjustment occurred. Must be after the conversion_date_time. The timezone must be specified. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
+      "adjustmentType": "A String", # The adjustment type.
+      "conversionAction": "A String", # Resource name of the conversion action associated with this conversion adjustment. Note: Although this resource name consists of a customer id and a conversion action id, validation will ignore the customer id and use the conversion action id as the sole identifier of the conversion action.
+      "gclidDateTimePair": { # Uniquely identifies a conversion that was reported without an order ID specified. # For adjustments, uniquely identifies a conversion that was reported without an order ID specified. If the adjustment_type is ENHANCEMENT, this value is optional but may be set in addition to the order_id.
+        "conversionDateTime": "A String", # The date time at which the original conversion for this adjustment occurred. The timezone must be specified. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
+        "gclid": "A String", # Google click ID (gclid) associated with the original conversion for this adjustment.
+      },
+      "orderId": "A String", # The order ID of the conversion to be adjusted. If the conversion was reported with an order ID specified, that order ID must be used as the identifier here. The order ID is required for enhancements.
+      "restatementValue": { # Contains information needed to restate a conversion's value. # Information needed to restate the conversion's value. Required for restatements. Should not be supplied for retractions. An error will be returned if provided for a retraction. NOTE: If you want to upload a second restatement with a different adjusted value, it must have a new, more recent, adjustment occurrence time. Otherwise, it will be treated as a duplicate of the previous restatement and ignored.
+        "adjustedValue": 3.14, # The restated conversion value. This is the value of the conversion after restatement. For example, to change the value of a conversion from 100 to 70, an adjusted value of 70 should be reported. NOTE: If you want to upload a second restatement with a different adjusted value, it must have a new, more recent, adjustment occurrence time. Otherwise, it will be treated as a duplicate of the previous restatement and ignored.
+        "currencyCode": "A String", # The currency of the restated value. If not provided, then the default currency from the conversion action is used, and if that is not set then the account currency is used. This is the ISO 4217 3-character currency code for example, USD or EUR.
+      },
+      "userAgent": "A String", # The user agent to enhance the original conversion. This can be found in your user's HTTP request header when they convert on your web page. Example, "Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 like Mac OS X)". User agent can only be specified in enhancements with user identifiers.
+      "userIdentifiers": [ # The user identifiers to enhance the original conversion. ConversionAdjustmentUploadService only accepts user identifiers in enhancements. The maximum number of user identifiers for each enhancement is 5.
+        { # identifying information.
+          "addressInfo": { # Address identifier of offline data. # Address information.
+            "city": "A String", # City of the address. Only accepted for Store Sales.
+            "countryCode": "A String", # 2-letter country code in ISO-3166-1 alpha-2 of the user's address.
+            "hashedFirstName": "A String", # First name of the user, which is hashed as SHA-256 after normalized (Lowercase all characters; Remove any extra spaces before, after, and in between).
+            "hashedLastName": "A String", # Last name of the user, which is hashed as SHA-256 after normalized (lower case only and no punctuation).
+            "hashedStreetAddress": "A String", # The street address of the user hashed using SHA-256 hash function after normalization (lower case only). Only accepted for ConversionAdjustmentUploadService.
+            "postalCode": "A String", # Postal code of the user's address.
+            "state": "A String", # State code of the address. Only accepted for Store Sales.
+          },
+          "hashedEmail": "A String", # Hashed email address using SHA-256 hash function after normalization.
+          "hashedPhoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
+          "mobileId": "A String", # Mobile device ID (advertising ID/IDFA).
+          "thirdPartyUserId": "A String", # Advertiser-assigned user ID for Customer Match upload, or third-party-assigned user ID for
+          "userIdentifierSource": "A String", # Source of the user identifier when the upload is from Store Sales
+        },
+      ],
+    },
+  ],
+  "jobId": 42, # Optional. Optional input to set job ID. Must be a non-negative number that is less than 2^31 if provided. If this field is not provided, the API will generate a job ID in the range [2^31, (2^63)-1]. The API will return the value for this request in the `job_id` field of the `UploadConversionAdjustmentsResponse`.
+  "partialFailure": True or False, # Required. If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. This should always be set to true. See https://developers.google.com/google-ads/api/docs/best-practices/partial-failures for more information about partial failure.
+  "validateOnly": True or False, # If true, the request is validated but not executed. Only errors are returned, not results.
+}
+
+  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 ConversionAdjustmentUploadService.UploadConversionAdjustments.
+  "jobId": "A String", # Job ID for the upload batch.
+  "partialFailureError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Errors that pertain to conversion adjustment failures in the partial failure mode. Returned when all errors occur inside the adjustments. If any errors occur outside the adjustments (for example, auth errors), we return an RPC level error. See https://developers.google.com/google-ads/api/docs/best-practices/partial-failures for more information about partial failure.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "results": [ # Returned for successfully processed conversion adjustments. Proto will be empty for rows that received an error. Results are not returned when validate_only is true.
+    { # Information identifying a successfully processed ConversionAdjustment.
+      "adjustmentDateTime": "A String", # The date time at which the adjustment occurred. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
+      "adjustmentType": "A String", # The adjustment type.
+      "conversionAction": "A String", # Resource name of the conversion action associated with this conversion adjustment.
+      "gclidDateTimePair": { # Uniquely identifies a conversion that was reported without an order ID specified. # The gclid and conversion date time of the conversion.
+        "conversionDateTime": "A String", # The date time at which the original conversion for this adjustment occurred. The timezone must be specified. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
+        "gclid": "A String", # Google click ID (gclid) associated with the original conversion for this adjustment.
+      },
+      "orderId": "A String", # The order ID of the conversion to be adjusted.
+    },
+  ],
+}
+
+
uploadUserData(customerId, body=None, x__xgafv=None)
Uploads the given user data. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [OfflineUserDataJobError]() [QuotaError]() [RequestError]() [UserDataError]()
diff --git a/docs/dyn/searchads360_v23.customers.recommendations.html b/docs/dyn/searchads360_v23.customers.recommendations.html
index e5cd4f97b6..b9fe8f5ecb 100644
--- a/docs/dyn/searchads360_v23.customers.recommendations.html
+++ b/docs/dyn/searchads360_v23.customers.recommendations.html
@@ -750,6 +750,16 @@ 

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -1433,6 +1443,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -2127,6 +2147,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -3723,7 +3753,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -4498,7 +4528,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -4846,6 +4876,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -6438,7 +6478,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -7213,7 +7253,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -7561,6 +7601,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -9153,7 +9203,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -9928,7 +9978,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -10276,6 +10326,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -10965,6 +11025,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -12578,7 +12648,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -13353,7 +13423,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -13701,6 +13771,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -14552,6 +14632,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -15215,6 +15305,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -17048,7 +17148,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -17823,7 +17923,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -18171,6 +18271,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -19761,7 +19871,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -20536,7 +20646,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -20884,6 +20994,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -22476,7 +22596,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -23251,7 +23371,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -23599,6 +23719,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -25189,7 +25319,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -25964,7 +26094,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -26312,6 +26442,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -27904,7 +28044,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -28679,7 +28819,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -29027,6 +29167,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -29834,6 +29984,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -30497,6 +30657,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -32109,7 +32279,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -32884,7 +33054,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -33232,6 +33402,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. diff --git a/docs/dyn/searchads360_v23.customers.searchAds360.html b/docs/dyn/searchads360_v23.customers.searchAds360.html index 8b74a387e4..70baacb7d2 100644 --- a/docs/dyn/searchads360_v23.customers.searchAds360.html +++ b/docs/dyn/searchads360_v23.customers.searchAds360.html @@ -1679,7 +1679,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -2454,7 +2454,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -2802,6 +2802,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -4505,7 +4515,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -5280,7 +5290,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -5628,6 +5638,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -8347,7 +8367,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -9122,7 +9142,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -9470,6 +9490,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -10612,6 +10642,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -11273,6 +11313,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -13427,8 +13477,8 @@

Method Details

}, "customerLabelOperation": { # A single operation (create, remove) on a customer-label relationship. # A customer label mutate operation. "create": { # Represents a relationship between a customer and a label. This customer may not have access to all the labels attached to it. Additional CustomerLabels may be returned by increasing permissions with login-customer-id. # Create operation: No resource name is expected for the new customer-label relationship. - "customer": "A String", # Output only. The resource name of the customer to which the label is attached. Read only. - "label": "A String", # Output only. The resource name of the label assigned to the customer. Note: the Customer ID portion of the label resource name is not validated when creating a new CustomerLabel. + "customer": "A String", # Output only. The resource name of the customer to which the label is attached. This field should not be set when creating a new `CustomerLabel`. + "label": "A String", # Output only. The resource name of the label assigned to the customer. This field should not be set when creating a new `CustomerLabel`. Note: the Customer ID portion of the label resource name is not validated when creating a new `CustomerLabel`. "resourceName": "A String", # Immutable. Name of the resource. Customer label resource names have the form: `customers/{customer_id}/customerLabels/{label_id}` }, "remove": "A String", # Remove operation: A resource name for the customer-label relationship being removed, in this format: `customers/{customer_id}/customerLabels/{label_id}` @@ -13590,7 +13640,7 @@

Method Details

}, "experimentArmOperation": { # A single operation on an experiment arm. # An experiment arm mutate operation. "create": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # Create operation - "assetGroups": [ # List of asset groups in the experiment arm. + "assetGroups": [ # List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID. { # Holds the asset groups included in an arm of an Optimize Assets experiment. "assetGroup": "A String", # Asset group resource name. "assetGroupAssets": [ # List of asset group assets under the asset group. @@ -13615,7 +13665,7 @@

Method Details

}, "remove": "A String", # Remove operation: The experiment arm is expected to have a valid resource name, in this format: `customers/{customer_id}/experiments/{campaign_experiment_id}` "update": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # Update operation: The experiment arm is expected to have a valid resource name. - "assetGroups": [ # List of asset groups in the experiment arm. + "assetGroups": [ # List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID. { # Holds the asset groups included in an arm of an Optimize Assets experiment. "assetGroup": "A String", # Asset group resource name. "assetGroupAssets": [ # List of asset group assets under the asset group. @@ -15826,7 +15876,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -16601,7 +16651,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -16949,6 +16999,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -19168,7 +19228,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -19943,7 +20003,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -20291,6 +20351,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -21074,6 +21144,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -22363,7 +22443,7 @@

Method Details

}, "experimentArmResult": { # The result for the experiment arm mutate. # The result for the experiment arm mutate. "experimentArm": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # The mutated experiment arm with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE". - "assetGroups": [ # List of asset groups in the experiment arm. + "assetGroups": [ # List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID. { # Holds the asset groups included in an arm of an Optimize Assets experiment. "assetGroup": "A String", # Asset group resource name. "assetGroupAssets": [ # List of asset group assets under the asset group. @@ -24285,7 +24365,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -25060,7 +25140,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -25408,6 +25488,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -27105,7 +27195,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -27880,7 +27970,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -28228,6 +28318,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -28995,7 +29095,7 @@

Method Details

"adScheduleView": { # An ad schedule view summarizes the performance of campaigns by AdSchedule criteria. # The ad schedule view referenced in the query. "resourceName": "A String", # Output only. The resource name of the ad schedule view. AdSchedule view resource names have the form: `customers/{customer_id}/adScheduleViews/{campaign_id}~{criterion_id}` }, - "ageRangeView": { # An age range view. # The age range view referenced in the query. + "ageRangeView": { # An age range view. Represents the view of a customer's performance metrics (like impressions and clicks) aggregated by age range. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API. # The age range view referenced in the query. "resourceName": "A String", # Output only. The resource name of the age range view. Age range view resource names have the form: `customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}` }, "aiMaxSearchTermAdCombinationView": { # AiMaxSearchTermAdCombinationView Resource. # The AI Max search term ad combination view referenced in the query. @@ -29674,6 +29774,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -32585,7 +32695,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -33360,7 +33470,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -33708,6 +33818,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -35405,7 +35525,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -36180,7 +36300,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -36528,6 +36648,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -37672,6 +37802,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -39918,7 +40058,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -40693,7 +40833,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -41041,6 +41181,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -42738,7 +42888,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -43513,7 +43663,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -43861,6 +44011,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -45005,6 +45165,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -46158,8 +46328,8 @@

Method Details

}, }, "customerLabel": { # Represents a relationship between a customer and a label. This customer may not have access to all the labels attached to it. Additional CustomerLabels may be returned by increasing permissions with login-customer-id. # The customer label referenced in the query. - "customer": "A String", # Output only. The resource name of the customer to which the label is attached. Read only. - "label": "A String", # Output only. The resource name of the label assigned to the customer. Note: the Customer ID portion of the label resource name is not validated when creating a new CustomerLabel. + "customer": "A String", # Output only. The resource name of the customer to which the label is attached. This field should not be set when creating a new `CustomerLabel`. + "label": "A String", # Output only. The resource name of the label assigned to the customer. This field should not be set when creating a new `CustomerLabel`. Note: the Customer ID portion of the label resource name is not validated when creating a new `CustomerLabel`. "resourceName": "A String", # Immutable. Name of the resource. Customer label resource names have the form: `customers/{customer_id}/customerLabels/{label_id}` }, "customerLifecycleGoal": { # Account level customer lifecycle goal settings. # The customer lifecycle goal referenced in the query. @@ -46256,7 +46426,7 @@

Method Details

"resourceName": "A String", # Output only. The resource name of the detail content suitability placement view. Detail content suitability placement view resource names have the form: `customers/{customer_id}/detailContentSuitabilityPlacementViews/{placement_fingerprint}` "targetUrl": "A String", # Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL. }, - "detailPlacementView": { # A view with metrics aggregated by ad group and URL or YouTube video. This view primarily surfaces placement data from the Google Display Network. While you can select segments like `segments.ad_network_type`, this view generally does not include placement data from other networks, such as the Search Partners network. To understand performance on Search Partners, consider other reports and segmentations. # The detail placement view referenced in the query. + "detailPlacementView": { # A view with metrics aggregated by ad group and URL or YouTube video. Provides granular performance data about specific URLs, YouTube videos, and apps where your ads showed. This offers a more detailed breakdown compared to the group_placement_view. This view primarily surfaces placement data from the Google Display Network. While you can select segments like `segments.ad_network_type`, this view generally does not include placement data from other networks, such as the Search Partners network. To understand performance on Search Partners, consider other reports and segmentations. Data for low-traffic placements may be aggregated. # The detail placement view referenced in the query. "displayName": "A String", # Output only. The display name is URL name for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps. "groupPlacementTargetUrl": "A String", # Output only. URL of the group placement, for example, domain, link to the mobile application in app store, or a YouTube channel URL. "placement": "A String", # Output only. The automatic placement string at detail level, e. g. website URL, mobile application ID, or a YouTube video ID. @@ -46333,7 +46503,7 @@

Method Details

"type": "A String", # Required. The product/feature that uses this experiment. }, "experimentArm": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # The experiment arm referenced in the query. - "assetGroups": [ # List of asset groups in the experiment arm. + "assetGroups": [ # List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID. { # Holds the asset groups included in an arm of an Optimize Assets experiment. "assetGroup": "A String", # Asset group resource name. "assetGroupAssets": [ # List of asset group assets under the asset group. @@ -46366,7 +46536,7 @@

Method Details

"resourceName": "A String", # Output only. The resource name of the FinalUrlExpansionAsset. "status": "A String", # Output only. Status of the FinalUrlExpansionAsset. }, - "genderView": { # A gender view. The gender_view resource reflects the effective serving state, rather than what criteria were added. An ad group without gender criteria by default shows to all genders, so all genders appear in gender_view with stats. # The gender view referenced in the query. + "genderView": { # A gender view resource. Represents the view of a customer's performance metrics aggregated by gender. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API. # The gender view referenced in the query. "resourceName": "A String", # Output only. The resource name of the gender view. Gender view resource names have the form: `customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}` }, "geoTargetConstant": { # A geo target constant. # The geo target constant referenced in the query. @@ -46404,7 +46574,7 @@

Method Details

"resourceName": "A String", # Output only. The resource name of the group content suitability placement view. Group content suitability placement view resource names have the form: `customers/{customer_id}/groupContentSuitabilityPlacementViews/{placement_fingerprint}` "targetUrl": "A String", # Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL. }, - "groupPlacementView": { # A group placement view. # The group placement view referenced in the query. + "groupPlacementView": { # A view showing performance data for where your ads actually served on the Display Network and YouTube, including both targeted (managed) and automatic placements. Data for low-traffic placements may be aggregated. The scope of placements shown is influenced by the ad group's `TargetingSetting` for the `PLACEMENT` dimension. # The group placement view referenced in the query. "displayName": "A String", # Output only. Domain name for websites and YouTube channel name for YouTube channels. "placement": "A String", # Output only. The automatic placement string at group level, e. g. web domain, mobile app ID, or a YouTube channel ID. "placementType": "A String", # Output only. Type of the placement, for example, Website, YouTube Channel, Mobile Application. @@ -46694,7 +46864,7 @@

Method Details

"locationView": { # A location view summarizes the performance of campaigns by a Location criterion. # The location view referenced in the query. "resourceName": "A String", # Output only. The resource name of the location view. Location view resource names have the form: `customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}` }, - "managedPlacementView": { # A managed placement view. # The managed placement view referenced in the query. + "managedPlacementView": { # A view providing performance data for placements explicitly targeted in your ad groups. # The managed placement view referenced in the query. "resourceName": "A String", # Output only. The resource name of the Managed Placement view. Managed placement view resource names have the form: `customers/{customer_id}/managedPlacementViews/{ad_group_id}~{criterion_id}` }, "matchedLocationInterestView": { # A view that reports metrics for locations where users showed interest, and which matched the advertiser's location interest targeting (defined as geo targets at the AdGroup level). The data is aggregated at the country level by default. This view is currently only available for AI Max campaigns. # The matched location interest view referenced in the query. @@ -46730,7 +46900,7 @@

Method Details

"metrics": { # Metrics data. # The metrics. "absoluteTopImpressionPercentage": 3.14, # Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position. "allConversions": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. - "allConversionsByConversionDate": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "allConversionsByConversionDate": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611). "allConversionsFromClickToCall": 3.14, # The number of times people clicked the "Call" button to call a business during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only. "allConversionsFromDirections": 3.14, # The number of times people clicked a "Get directions" button to navigate to a business after clicking an ad. This metric applies to feed items only. "allConversionsFromInteractionsRate": 3.14, # All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions. @@ -46741,25 +46911,25 @@

Method Details

"allConversionsFromStoreVisit": 3.14, # Estimated number of times people visited a business after clicking an ad. This metric applies to feed items only. "allConversionsFromStoreWebsite": 3.14, # The number of times that people were taken to a business's URL after clicking an ad. This metric applies to feed items only. "allConversionsValue": 3.14, # The value of all conversions. - "allConversionsValueByConversionDate": 3.14, # The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "allConversionsValueByConversionDate": 3.14, # The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611). "allConversionsValuePerCost": 3.14, # The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads). "averageCartSize": 3.14, # Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data. "averageCost": 3.14, # The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions. - "averageCpc": 3.14, # The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "averageCpc": 3.14, # The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "averageImpressionFrequencyPerUser": 3.14, # The average number of times a unique user saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App. "averageOrderValueMicros": "A String", # Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is $15 = ($10 + $15 + $20)/3. This metric is only available if you report conversions with cart data. "averageQualityScore": 3.14, # The average quality score. "clicks": "A String", # The number of clicks. - "clientAccountConversions": 3.14, # The number of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "clientAccountConversionsValue": 3.14, # The value of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "clientAccountCrossSellCostOfGoodsSoldMicros": "A String", # Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountCrossSellGrossProfitMicros": "A String", # Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountCrossSellRevenueMicros": "A String", # Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "clientAccountConversions": 3.14, # The number of client account conversions. This only includes conversion actions which `include_in_client_account_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "clientAccountConversionsValue": 3.14, # The value of client account conversions. This only includes conversion actions which `include_in_client_account_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "clientAccountCrossSellCostOfGoodsSoldMicros": "A String", # Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountCrossSellGrossProfitMicros": "A String", # Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountCrossSellRevenueMicros": "A String", # Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "clientAccountCrossSellUnitsSold": 3.14, # Client account cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data. - "clientAccountLeadCostOfGoodsSoldMicros": "A String", # Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountLeadGrossProfitMicros": "A String", # Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountLeadRevenueMicros": "A String", # Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "clientAccountLeadCostOfGoodsSoldMicros": "A String", # Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountLeadGrossProfitMicros": "A String", # Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountLeadRevenueMicros": "A String", # Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "clientAccountLeadUnitsSold": 3.14, # Client account lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data. "clientAccountViewThroughConversions": "A String", # The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad. "contentBudgetLostImpressionShare": 3.14, # The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. @@ -46775,28 +46945,28 @@

Method Details

}, ], "conversions": 3.14, # The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "conversionsByConversionDate": 3.14, # The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in date column means the conversion date. + "conversionsByConversionDate": 3.14, # The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in the date column mean the conversion date. "conversionsFromInteractionsRate": 3.14, # Average biddable conversions (from interaction) per conversion eligible interaction. Shows how often, on average, an ad interaction leads to a biddable conversion. - "conversionsFromInteractionsValuePerInteraction": 3.14, # The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "conversionsFromInteractionsValuePerInteraction": 3.14, # The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. "conversionsValue": 3.14, # The sum of conversion values for the conversions included in the "conversions" field. This metric is useful only if you entered a value for your conversion actions. "conversionsValueByConversionDate": 3.14, # The sum of biddable conversions value by conversion date. When this column is selected with date, the values in date column means the conversion date. "conversionsValuePerCost": 3.14, # The value of biddable conversion divided by the total cost of conversion eligible interactions. - "costMicros": "A String", # The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "costMicros": "A String", # The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause) for more details. "costOfGoodsSoldMicros": "A String", # Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data. "costPerAllConversions": 3.14, # The cost of ad interactions divided by all conversions. "costPerConversion": 3.14, # Average conversion eligible cost per biddable conversion. - "costPerCurrentModelAttributedConversion": 3.14, # The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "crossDeviceConversions": 3.14, # Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions. - "crossDeviceConversionsByConversionDate": 3.14, # The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "costPerCurrentModelAttributedConversion": 3.14, # The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "crossDeviceConversions": 3.14, # Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in `all_conversions`. + "crossDeviceConversionsByConversionDate": 3.14, # The number of cross-device conversions by conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611) "crossDeviceConversionsValue": 3.14, # The sum of the value of cross-device conversions. - "crossDeviceConversionsValueByConversionDate": 3.14, # The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. - "crossSellCostOfGoodsSoldMicros": "A String", # Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "crossSellGrossProfitMicros": "A String", # Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "crossSellRevenueMicros": "A String", # Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "crossDeviceConversionsValueByConversionDate": 3.14, # The sum of cross-device conversions value by conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611) + "crossSellCostOfGoodsSoldMicros": "A String", # Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "crossSellGrossProfitMicros": "A String", # Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "crossSellRevenueMicros": "A String", # Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "crossSellUnitsSold": 3.14, # Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data. "ctr": 3.14, # The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions). - "generalInvalidClickRate": 3.14, # The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details. - "generalInvalidClicks": "A String", # Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details. + "generalInvalidClickRate": 3.14, # The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504). + "generalInvalidClicks": "A String", # Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504). "grossProfitMargin": 3.14, # Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced $20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = ($10 - $3)/$10 x 100%. This metric is only available if you report conversions with cart data. "grossProfitMicros": "A String", # Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data. "historicalCreativeQualityScore": "A String", # The creative historical quality score. @@ -46811,9 +46981,9 @@

Method Details

"interactions": "A String", # The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on. "invalidClickRate": 3.14, # The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period. "invalidClicks": "A String", # Number of clicks Google considers illegitimate and doesn't charge you for. - "leadCostOfGoodsSoldMicros": "A String", # Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "leadGrossProfitMicros": "A String", # Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "leadRevenueMicros": "A String", # Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "leadCostOfGoodsSoldMicros": "A String", # Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "leadGrossProfitMicros": "A String", # Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "leadRevenueMicros": "A String", # Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "leadUnitsSold": 3.14, # Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data. "mobileFriendlyClicksPercentage": 3.14, # The percentage of mobile clicks that go to a mobile-friendly page. "orders": 3.14, # Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data. @@ -46827,10 +46997,10 @@

Method Details

}, ], "revenueMicros": "A String", # Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is $25 = ($10 + $20) - $5. This metric is only available if you report conversions with cart data. - "searchAbsoluteTopImpressionShare": 3.14, # The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/sa360/answer/9566729 for details. Any value below 0.1 is reported as 0.0999. + "searchAbsoluteTopImpressionShare": 3.14, # The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See [About top and absolute top metrics](https://support.google.com/sa360/answer/9566729) for details. Any value below 0.1 is reported as 0.0999. "searchBudgetLostAbsoluteTopImpressionShare": 3.14, # The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. "searchBudgetLostImpressionShare": 3.14, # The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. - "searchBudgetLostTopImpressionShare": 3.14, # The number estimating how often your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. + "searchBudgetLostTopImpressionShare": 3.14, # The estimated percent of times that your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. "searchClickShare": 3.14, # The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. "searchExactMatchImpressionShare": 3.14, # The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. "searchImpressionShare": 3.14, # The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. @@ -46842,7 +47012,7 @@

Method Details

"uniqueUsers": "A String", # The number of unique users who saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App. "unitsSold": 3.14, # Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The units sold in this order is 3. This metric is only available if you report conversions with cart data. "valuePerAllConversions": 3.14, # The value of all conversions divided by the number of all conversions. - "valuePerAllConversionsByConversionDate": 3.14, # The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "valuePerAllConversionsByConversionDate": 3.14, # The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611). "valuePerConversion": 3.14, # The value of biddable conversion divided by the number of biddable conversions. Shows how much, on average, each of the biddable conversions is worth. "valuePerConversionsByConversionDate": 3.14, # Biddable conversions value by conversion date divided by biddable conversions by conversion date. Shows how much, on average, each of the biddable conversions is worth (by conversion date). When this column is selected with date, the values in date column means the conversion date. "visits": 3.14, # Clicks that Search Ads 360 has successfully recorded and forwarded to an advertiser's landing page. @@ -47723,6 +47893,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -48386,6 +48566,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -50219,7 +50409,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -50994,7 +51184,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -51342,6 +51532,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -52932,7 +53132,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -53707,7 +53907,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -54055,6 +54255,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -55647,7 +55857,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -56422,7 +56632,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -56770,6 +56980,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -58360,7 +58580,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -59135,7 +59355,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -59483,6 +59703,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -61075,7 +61305,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -61850,7 +62080,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -62198,6 +62428,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -63005,6 +63245,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -63668,6 +63918,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -65280,7 +65540,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -66055,7 +66315,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -66403,6 +66663,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -66520,6 +66790,7 @@

Method Details

"text": "A String", # The text of the keyword (at most 80 characters and 10 words). }, }, + "mobileDevicePlatform": "A String", # Mobile device platform to which metrics apply. "month": "A String", # Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd. "productBiddingCategoryLevel1": "A String", # Bidding category (level 1) of the product. "productBiddingCategoryLevel2": "A String", # Bidding category (level 2) of the product. @@ -66737,7 +67008,7 @@

Method Details

}, "topicConstant": { # Use topics to target or exclude placements in the Google Display Network based on the category into which the placement falls (for example, "Pets & Animals/Pets/Dogs"). # The topic constant referenced in the query. "id": "A String", # Output only. The ID of the topic. - "path": [ # Output only. The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, {"Pets & Animals", "Pets", "Dogs"} represents the "Pets & Animals/Pets/Dogs" category. List of available topic categories at https://developers.google.com/google-ads/api/reference/data/verticals + "path": [ # Output only. The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, {"Pets & Animals", "Pets", "Dogs"} represents the "Pets & Animals/Pets/Dogs" category. List of available topic categories at https://developers.google.com/google-ads/api/data/topics "A String", ], "resourceName": "A String", # Output only. The resource name of the topic constant. topic constant resource names have the form: `topicConstants/{topic_id}` @@ -68603,7 +68874,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -69378,7 +69649,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -69726,6 +69997,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -71423,7 +71704,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -72198,7 +72479,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -72546,6 +72827,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -73313,7 +73604,7 @@

Method Details

"adScheduleView": { # An ad schedule view summarizes the performance of campaigns by AdSchedule criteria. # The ad schedule view referenced in the query. "resourceName": "A String", # Output only. The resource name of the ad schedule view. AdSchedule view resource names have the form: `customers/{customer_id}/adScheduleViews/{campaign_id}~{criterion_id}` }, - "ageRangeView": { # An age range view. # The age range view referenced in the query. + "ageRangeView": { # An age range view. Represents the view of a customer's performance metrics (like impressions and clicks) aggregated by age range. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API. # The age range view referenced in the query. "resourceName": "A String", # Output only. The resource name of the age range view. Age range view resource names have the form: `customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}` }, "aiMaxSearchTermAdCombinationView": { # AiMaxSearchTermAdCombinationView Resource. # The AI Max search term ad combination view referenced in the query. @@ -73992,6 +74283,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -76903,7 +77204,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -77678,7 +77979,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -78026,6 +78327,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -79723,7 +80034,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -80498,7 +80809,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -80846,6 +81157,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -81990,6 +82311,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -84236,7 +84567,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -85011,7 +85342,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -85359,6 +85690,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -87056,7 +87397,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -87831,7 +88172,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -88179,6 +88520,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -89323,6 +89674,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -90476,8 +90837,8 @@

Method Details

}, }, "customerLabel": { # Represents a relationship between a customer and a label. This customer may not have access to all the labels attached to it. Additional CustomerLabels may be returned by increasing permissions with login-customer-id. # The customer label referenced in the query. - "customer": "A String", # Output only. The resource name of the customer to which the label is attached. Read only. - "label": "A String", # Output only. The resource name of the label assigned to the customer. Note: the Customer ID portion of the label resource name is not validated when creating a new CustomerLabel. + "customer": "A String", # Output only. The resource name of the customer to which the label is attached. This field should not be set when creating a new `CustomerLabel`. + "label": "A String", # Output only. The resource name of the label assigned to the customer. This field should not be set when creating a new `CustomerLabel`. Note: the Customer ID portion of the label resource name is not validated when creating a new `CustomerLabel`. "resourceName": "A String", # Immutable. Name of the resource. Customer label resource names have the form: `customers/{customer_id}/customerLabels/{label_id}` }, "customerLifecycleGoal": { # Account level customer lifecycle goal settings. # The customer lifecycle goal referenced in the query. @@ -90574,7 +90935,7 @@

Method Details

"resourceName": "A String", # Output only. The resource name of the detail content suitability placement view. Detail content suitability placement view resource names have the form: `customers/{customer_id}/detailContentSuitabilityPlacementViews/{placement_fingerprint}` "targetUrl": "A String", # Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL. }, - "detailPlacementView": { # A view with metrics aggregated by ad group and URL or YouTube video. This view primarily surfaces placement data from the Google Display Network. While you can select segments like `segments.ad_network_type`, this view generally does not include placement data from other networks, such as the Search Partners network. To understand performance on Search Partners, consider other reports and segmentations. # The detail placement view referenced in the query. + "detailPlacementView": { # A view with metrics aggregated by ad group and URL or YouTube video. Provides granular performance data about specific URLs, YouTube videos, and apps where your ads showed. This offers a more detailed breakdown compared to the group_placement_view. This view primarily surfaces placement data from the Google Display Network. While you can select segments like `segments.ad_network_type`, this view generally does not include placement data from other networks, such as the Search Partners network. To understand performance on Search Partners, consider other reports and segmentations. Data for low-traffic placements may be aggregated. # The detail placement view referenced in the query. "displayName": "A String", # Output only. The display name is URL name for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps. "groupPlacementTargetUrl": "A String", # Output only. URL of the group placement, for example, domain, link to the mobile application in app store, or a YouTube channel URL. "placement": "A String", # Output only. The automatic placement string at detail level, e. g. website URL, mobile application ID, or a YouTube video ID. @@ -90651,7 +91012,7 @@

Method Details

"type": "A String", # Required. The product/feature that uses this experiment. }, "experimentArm": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # The experiment arm referenced in the query. - "assetGroups": [ # List of asset groups in the experiment arm. + "assetGroups": [ # List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID. { # Holds the asset groups included in an arm of an Optimize Assets experiment. "assetGroup": "A String", # Asset group resource name. "assetGroupAssets": [ # List of asset group assets under the asset group. @@ -90684,7 +91045,7 @@

Method Details

"resourceName": "A String", # Output only. The resource name of the FinalUrlExpansionAsset. "status": "A String", # Output only. Status of the FinalUrlExpansionAsset. }, - "genderView": { # A gender view. The gender_view resource reflects the effective serving state, rather than what criteria were added. An ad group without gender criteria by default shows to all genders, so all genders appear in gender_view with stats. # The gender view referenced in the query. + "genderView": { # A gender view resource. Represents the view of a customer's performance metrics aggregated by gender. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API. # The gender view referenced in the query. "resourceName": "A String", # Output only. The resource name of the gender view. Gender view resource names have the form: `customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}` }, "geoTargetConstant": { # A geo target constant. # The geo target constant referenced in the query. @@ -90722,7 +91083,7 @@

Method Details

"resourceName": "A String", # Output only. The resource name of the group content suitability placement view. Group content suitability placement view resource names have the form: `customers/{customer_id}/groupContentSuitabilityPlacementViews/{placement_fingerprint}` "targetUrl": "A String", # Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL. }, - "groupPlacementView": { # A group placement view. # The group placement view referenced in the query. + "groupPlacementView": { # A view showing performance data for where your ads actually served on the Display Network and YouTube, including both targeted (managed) and automatic placements. Data for low-traffic placements may be aggregated. The scope of placements shown is influenced by the ad group's `TargetingSetting` for the `PLACEMENT` dimension. # The group placement view referenced in the query. "displayName": "A String", # Output only. Domain name for websites and YouTube channel name for YouTube channels. "placement": "A String", # Output only. The automatic placement string at group level, e. g. web domain, mobile app ID, or a YouTube channel ID. "placementType": "A String", # Output only. Type of the placement, for example, Website, YouTube Channel, Mobile Application. @@ -91012,7 +91373,7 @@

Method Details

"locationView": { # A location view summarizes the performance of campaigns by a Location criterion. # The location view referenced in the query. "resourceName": "A String", # Output only. The resource name of the location view. Location view resource names have the form: `customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}` }, - "managedPlacementView": { # A managed placement view. # The managed placement view referenced in the query. + "managedPlacementView": { # A view providing performance data for placements explicitly targeted in your ad groups. # The managed placement view referenced in the query. "resourceName": "A String", # Output only. The resource name of the Managed Placement view. Managed placement view resource names have the form: `customers/{customer_id}/managedPlacementViews/{ad_group_id}~{criterion_id}` }, "matchedLocationInterestView": { # A view that reports metrics for locations where users showed interest, and which matched the advertiser's location interest targeting (defined as geo targets at the AdGroup level). The data is aggregated at the country level by default. This view is currently only available for AI Max campaigns. # The matched location interest view referenced in the query. @@ -91048,7 +91409,7 @@

Method Details

"metrics": { # Metrics data. # The metrics. "absoluteTopImpressionPercentage": 3.14, # Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position. "allConversions": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. - "allConversionsByConversionDate": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "allConversionsByConversionDate": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611). "allConversionsFromClickToCall": 3.14, # The number of times people clicked the "Call" button to call a business during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only. "allConversionsFromDirections": 3.14, # The number of times people clicked a "Get directions" button to navigate to a business after clicking an ad. This metric applies to feed items only. "allConversionsFromInteractionsRate": 3.14, # All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions. @@ -91059,25 +91420,25 @@

Method Details

"allConversionsFromStoreVisit": 3.14, # Estimated number of times people visited a business after clicking an ad. This metric applies to feed items only. "allConversionsFromStoreWebsite": 3.14, # The number of times that people were taken to a business's URL after clicking an ad. This metric applies to feed items only. "allConversionsValue": 3.14, # The value of all conversions. - "allConversionsValueByConversionDate": 3.14, # The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "allConversionsValueByConversionDate": 3.14, # The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611). "allConversionsValuePerCost": 3.14, # The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads). "averageCartSize": 3.14, # Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data. "averageCost": 3.14, # The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions. - "averageCpc": 3.14, # The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "averageCpc": 3.14, # The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "averageImpressionFrequencyPerUser": 3.14, # The average number of times a unique user saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App. "averageOrderValueMicros": "A String", # Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is $15 = ($10 + $15 + $20)/3. This metric is only available if you report conversions with cart data. "averageQualityScore": 3.14, # The average quality score. "clicks": "A String", # The number of clicks. - "clientAccountConversions": 3.14, # The number of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "clientAccountConversionsValue": 3.14, # The value of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "clientAccountCrossSellCostOfGoodsSoldMicros": "A String", # Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountCrossSellGrossProfitMicros": "A String", # Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountCrossSellRevenueMicros": "A String", # Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "clientAccountConversions": 3.14, # The number of client account conversions. This only includes conversion actions which `include_in_client_account_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "clientAccountConversionsValue": 3.14, # The value of client account conversions. This only includes conversion actions which `include_in_client_account_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "clientAccountCrossSellCostOfGoodsSoldMicros": "A String", # Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountCrossSellGrossProfitMicros": "A String", # Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountCrossSellRevenueMicros": "A String", # Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "clientAccountCrossSellUnitsSold": 3.14, # Client account cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data. - "clientAccountLeadCostOfGoodsSoldMicros": "A String", # Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountLeadGrossProfitMicros": "A String", # Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "clientAccountLeadRevenueMicros": "A String", # Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "clientAccountLeadCostOfGoodsSoldMicros": "A String", # Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountLeadGrossProfitMicros": "A String", # Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "clientAccountLeadRevenueMicros": "A String", # Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "clientAccountLeadUnitsSold": 3.14, # Client account lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data. "clientAccountViewThroughConversions": "A String", # The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad. "contentBudgetLostImpressionShare": 3.14, # The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. @@ -91093,28 +91454,28 @@

Method Details

}, ], "conversions": 3.14, # The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "conversionsByConversionDate": 3.14, # The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in date column means the conversion date. + "conversionsByConversionDate": 3.14, # The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in the date column mean the conversion date. "conversionsFromInteractionsRate": 3.14, # Average biddable conversions (from interaction) per conversion eligible interaction. Shows how often, on average, an ad interaction leads to a biddable conversion. - "conversionsFromInteractionsValuePerInteraction": 3.14, # The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "conversionsFromInteractionsValuePerInteraction": 3.14, # The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. "conversionsValue": 3.14, # The sum of conversion values for the conversions included in the "conversions" field. This metric is useful only if you entered a value for your conversion actions. "conversionsValueByConversionDate": 3.14, # The sum of biddable conversions value by conversion date. When this column is selected with date, the values in date column means the conversion date. "conversionsValuePerCost": 3.14, # The value of biddable conversion divided by the total cost of conversion eligible interactions. - "costMicros": "A String", # The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "costMicros": "A String", # The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause) for more details. "costOfGoodsSoldMicros": "A String", # Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data. "costPerAllConversions": 3.14, # The cost of ad interactions divided by all conversions. "costPerConversion": 3.14, # Average conversion eligible cost per biddable conversion. - "costPerCurrentModelAttributedConversion": 3.14, # The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. - "crossDeviceConversions": 3.14, # Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions. - "crossDeviceConversionsByConversionDate": 3.14, # The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "costPerCurrentModelAttributedConversion": 3.14, # The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions. + "crossDeviceConversions": 3.14, # Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in `all_conversions`. + "crossDeviceConversionsByConversionDate": 3.14, # The number of cross-device conversions by conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611) "crossDeviceConversionsValue": 3.14, # The sum of the value of cross-device conversions. - "crossDeviceConversionsValueByConversionDate": 3.14, # The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. - "crossSellCostOfGoodsSoldMicros": "A String", # Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "crossSellGrossProfitMicros": "A String", # Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "crossSellRevenueMicros": "A String", # Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "crossDeviceConversionsValueByConversionDate": 3.14, # The sum of cross-device conversions value by conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611) + "crossSellCostOfGoodsSoldMicros": "A String", # Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "crossSellGrossProfitMicros": "A String", # Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "crossSellRevenueMicros": "A String", # Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "crossSellUnitsSold": 3.14, # Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data. "ctr": 3.14, # The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions). - "generalInvalidClickRate": 3.14, # The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details. - "generalInvalidClicks": "A String", # Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details. + "generalInvalidClickRate": 3.14, # The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504). + "generalInvalidClicks": "A String", # Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504). "grossProfitMargin": 3.14, # Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced $20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = ($10 - $3)/$10 x 100%. This metric is only available if you report conversions with cart data. "grossProfitMicros": "A String", # Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data. "historicalCreativeQualityScore": "A String", # The creative historical quality score. @@ -91129,9 +91490,9 @@

Method Details

"interactions": "A String", # The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on. "invalidClickRate": 3.14, # The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period. "invalidClicks": "A String", # Number of clicks Google considers illegitimate and doesn't charge you for. - "leadCostOfGoodsSoldMicros": "A String", # Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "leadGrossProfitMicros": "A String", # Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause - "leadRevenueMicros": "A String", # Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "leadCostOfGoodsSoldMicros": "A String", # Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "leadGrossProfitMicros": "A String", # Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). + "leadRevenueMicros": "A String", # Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause). "leadUnitsSold": 3.14, # Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data. "mobileFriendlyClicksPercentage": 3.14, # The percentage of mobile clicks that go to a mobile-friendly page. "orders": 3.14, # Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data. @@ -91145,10 +91506,10 @@

Method Details

}, ], "revenueMicros": "A String", # Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is $25 = ($10 + $20) - $5. This metric is only available if you report conversions with cart data. - "searchAbsoluteTopImpressionShare": 3.14, # The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/sa360/answer/9566729 for details. Any value below 0.1 is reported as 0.0999. + "searchAbsoluteTopImpressionShare": 3.14, # The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See [About top and absolute top metrics](https://support.google.com/sa360/answer/9566729) for details. Any value below 0.1 is reported as 0.0999. "searchBudgetLostAbsoluteTopImpressionShare": 3.14, # The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. "searchBudgetLostImpressionShare": 3.14, # The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. - "searchBudgetLostTopImpressionShare": 3.14, # The number estimating how often your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. + "searchBudgetLostTopImpressionShare": 3.14, # The estimated percent of times that your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. "searchClickShare": 3.14, # The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. "searchExactMatchImpressionShare": 3.14, # The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. "searchImpressionShare": 3.14, # The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. @@ -91160,7 +91521,7 @@

Method Details

"uniqueUsers": "A String", # The number of unique users who saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App. "unitsSold": 3.14, # Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The units sold in this order is 3. This metric is only available if you report conversions with cart data. "valuePerAllConversions": 3.14, # The value of all conversions divided by the number of all conversions. - "valuePerAllConversionsByConversionDate": 3.14, # The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + "valuePerAllConversionsByConversionDate": 3.14, # The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611). "valuePerConversion": 3.14, # The value of biddable conversion divided by the number of biddable conversions. Shows how much, on average, each of the biddable conversions is worth. "valuePerConversionsByConversionDate": 3.14, # Biddable conversions value by conversion date divided by biddable conversions by conversion date. Shows how much, on average, each of the biddable conversions is worth (by conversion date). When this column is selected with date, the values in date column means the conversion date. "visits": 3.14, # Clicks that Search Ads 360 has successfully recorded and forwarded to an advertiser's landing page. @@ -92041,6 +92402,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -92704,6 +93075,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -94537,7 +94918,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -95312,7 +95693,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -95660,6 +96041,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -97250,7 +97641,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -98025,7 +98416,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -98373,6 +98764,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -99965,7 +100366,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -100740,7 +101141,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -101088,6 +101489,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -102678,7 +103089,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -103453,7 +103864,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -103801,6 +104212,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -105393,7 +105814,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -106168,7 +106589,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -106516,6 +106937,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -107323,6 +107754,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -107986,6 +108427,16 @@

Method Details

"A String", ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "textAsset": { # A Text asset. # Immutable. A text asset. "text": "A String", # Text content of the text asset. }, @@ -109598,7 +110049,7 @@

Method Details

"description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. }, - "expandedTextAd": { # An expanded text ad. # Details pertaining to an expanded text ad. + "expandedTextAd": { # An expanded text ad. Expanded text ads are deprecated. # Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead. "description": "A String", # The description of the ad. "description2": "A String", # The second description of the ad. "headlinePart1": "A String", # The first part of the ad's headline. @@ -110373,7 +110824,7 @@

Method Details

"description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. }, - "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad. + "searchAds360ExpandedTextAd": { # A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead. # Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead. "adTrackingId": "A String", # The tracking id of the ad. "description1": "A String", # The first line of the ad's description. "description2": "A String", # The second line of the ad's description. @@ -110721,6 +111172,16 @@

Method Details

}, ], }, + "syntheticContentInfo": { # Container for synthetic content attestations from different sources, such as the advertiser and Google systems. # Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD` + "advertiserAttestation": { # Represents an attestation about synthetic content from a single source. # Input provided by the advertiser. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + "systemAttestation": { # Represents an attestation about synthetic content from a single source. # Output only. Information about synthetic content generated by Google's systems. + "source": "A String", # The source of the synthetic content attestation. + "status": "A String", # Indicates whether the content is considered synthetic by this source. + }, + }, "systemManagedResourceSource": "A String", # Output only. If this ad is system managed, then this field will indicate the source. This field is read-only. "textAd": { # A text ad. # Immutable. Details pertaining to a text ad. "description1": "A String", # The first line of the ad's description. @@ -110838,6 +111299,7 @@

Method Details

"text": "A String", # The text of the keyword (at most 80 characters and 10 words). }, }, + "mobileDevicePlatform": "A String", # Mobile device platform to which metrics apply. "month": "A String", # Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd. "productBiddingCategoryLevel1": "A String", # Bidding category (level 1) of the product. "productBiddingCategoryLevel2": "A String", # Bidding category (level 2) of the product. @@ -111055,7 +111517,7 @@

Method Details

}, "topicConstant": { # Use topics to target or exclude placements in the Google Display Network based on the category into which the placement falls (for example, "Pets & Animals/Pets/Dogs"). # The topic constant referenced in the query. "id": "A String", # Output only. The ID of the topic. - "path": [ # Output only. The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, {"Pets & Animals", "Pets", "Dogs"} represents the "Pets & Animals/Pets/Dogs" category. List of available topic categories at https://developers.google.com/google-ads/api/reference/data/verticals + "path": [ # Output only. The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, {"Pets & Animals", "Pets", "Dogs"} represents the "Pets & Animals/Pets/Dogs" category. List of available topic categories at https://developers.google.com/google-ads/api/data/topics "A String", ], "resourceName": "A String", # Output only. The resource name of the topic constant. topic constant resource names have the form: `topicConstants/{topic_id}` diff --git a/docs/dyn/searchads360_v23.customers.searchAds360Campaigns.html b/docs/dyn/searchads360_v23.customers.searchAds360Campaigns.html new file mode 100644 index 0000000000..1307f202f7 --- /dev/null +++ b/docs/dyn/searchads360_v23.customers.searchAds360Campaigns.html @@ -0,0 +1,134 @@ + + + +

Search Ads 360 Reporting API . customers . searchAds360Campaigns

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ mutate(customerId, body=None, x__xgafv=None)

+

Updates Search Ads 360 campaigns. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ mutate(customerId, body=None, x__xgafv=None) +
Updates Search Ads 360 campaigns. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()
+
+Args:
+  customerId: string, Required. The ID of the customer whose Search Ads 360 campaigns are being modified. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SearchAds360CampaignService.MutateSearchAds360Campaigns.
+  "operations": [ # Required. The list of operations to perform on individual Search Ads 360 campaigns.
+    { # A single operation (update) on a Search Ads 360 campaign.
+      "update": { # A Search Ads 360 campaign. # Update operation: The Search Ads 360 campaign is expected to have a valid resource name.
+        "productAttributionFilterType": "A String", # The type of product attribution filtering to apply to this campaign.
+        "resourceName": "A String", # Immutable. The resource name of the Search Ads 360 campaign. Search Ads 360 campaign resource names have the form: `customers/{customer_id}/searchAds360Campaigns/{campaign_id}`
+      },
+      "updateMask": "A String", # FieldMask that determines which resource fields are modified in an update.
+    },
+  ],
+  "partialFailure": True or False, # If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
+  "responseContentType": "A String", # The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.
+  "validateOnly": True or False, # If true, the request is validated but not executed. Only errors are returned, not results.
+}
+
+  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 Search Ads 360 campaign mutate.
+  "results": [ # All results for the mutate.
+    { # The result for the Search Ads 360 campaign mutate.
+      "resourceName": "A String", # Returned for successful operations.
+      "searchAds360Campaign": { # A Search Ads 360 campaign. # The mutated Search Ads 360 campaign with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
+        "productAttributionFilterType": "A String", # The type of product attribution filtering to apply to this campaign.
+        "resourceName": "A String", # Immutable. The resource name of the Search Ads 360 campaign. Search Ads 360 campaign resource names have the form: `customers/{customer_id}/searchAds360Campaigns/{campaign_id}`
+      },
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/searchads360.v0.json b/googleapiclient/discovery_cache/documents/searchads360.v0.json index 300318b168..9852ec10e9 100644 --- a/googleapiclient/discovery_cache/documents/searchads360.v0.json +++ b/googleapiclient/discovery_cache/documents/searchads360.v0.json @@ -260,7 +260,7 @@ } } }, -"revision": "20260413", +"revision": "20260729", "rootUrl": "https://searchads360.googleapis.com/", "schemas": { "GoogleAdsSearchads360V0Common__AdScheduleInfo": { @@ -981,7 +981,7 @@ "type": "number" }, "allConversionsByConversionDate": { -"description": "The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.", +"description": "The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the \"All conversions\" column](https://support.google.com/sa360/answer/9250611).", "format": "double", "type": "number" }, @@ -1036,7 +1036,7 @@ "type": "number" }, "allConversionsValueByConversionDate": { -"description": "The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.", +"description": "The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the \"All conversions\" column](https://support.google.com/sa360/answer/9250611).", "format": "double", "type": "number" }, @@ -1056,12 +1056,12 @@ "type": "number" }, "averageCpc": { -"description": "The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "double", "type": "number" }, "averageCpm": { -"description": "Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "double", "type": "number" }, @@ -1086,27 +1086,27 @@ "type": "string" }, "clientAccountConversions": { -"description": "The number of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", +"description": "The number of client account conversions. This only includes conversion actions which `include_in_client_account_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", "format": "double", "type": "number" }, "clientAccountConversionsValue": { -"description": "The value of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", +"description": "The value of client account conversions. This only includes conversion actions which `include_in_client_account_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", "format": "double", "type": "number" }, "clientAccountCrossSellCostOfGoodsSoldMicros": { -"description": "Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "clientAccountCrossSellGrossProfitMicros": { -"description": "Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "clientAccountCrossSellRevenueMicros": { -"description": "Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, @@ -1116,17 +1116,17 @@ "type": "number" }, "clientAccountLeadCostOfGoodsSoldMicros": { -"description": "Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "clientAccountLeadGrossProfitMicros": { -"description": "Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "clientAccountLeadRevenueMicros": { -"description": "Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, @@ -1168,7 +1168,7 @@ "type": "number" }, "conversionsByConversionDate": { -"description": "The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in date column means the conversion date.", +"description": "The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in the date column mean the conversion date.", "format": "double", "type": "number" }, @@ -1178,7 +1178,7 @@ "type": "number" }, "conversionsFromInteractionsValuePerInteraction": { -"description": "The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", +"description": "The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", "format": "double", "type": "number" }, @@ -1198,7 +1198,7 @@ "type": "number" }, "costMicros": { -"description": "The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause) for more details.", "format": "int64", "type": "string" }, @@ -1218,17 +1218,17 @@ "type": "number" }, "costPerCurrentModelAttributedConversion": { -"description": "The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", +"description": "The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", "format": "double", "type": "number" }, "crossDeviceConversions": { -"description": "Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.", +"description": "Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in `all_conversions`.", "format": "double", "type": "number" }, "crossDeviceConversionsByConversionDate": { -"description": "The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.", +"description": "The number of cross-device conversions by conversion date. Details for the `by_conversion_date` columns are available at [About the \"All conversions\" column](https://support.google.com/sa360/answer/9250611)", "format": "double", "type": "number" }, @@ -1238,22 +1238,22 @@ "type": "number" }, "crossDeviceConversionsValueByConversionDate": { -"description": "The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.", +"description": "The sum of cross-device conversions value by conversion date. Details for the `by_conversion_date` columns are available at [About the \"All conversions\" column](https://support.google.com/sa360/answer/9250611)", "format": "double", "type": "number" }, "crossSellCostOfGoodsSoldMicros": { -"description": "Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "crossSellGrossProfitMicros": { -"description": "Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "crossSellRevenueMicros": { -"description": "Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, @@ -1268,12 +1268,12 @@ "type": "number" }, "generalInvalidClickRate": { -"description": "The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.", +"description": "The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504).", "format": "double", "type": "number" }, "generalInvalidClicks": { -"description": "Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.", +"description": "Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504).", "format": "int64", "type": "string" }, @@ -1395,17 +1395,17 @@ "type": "string" }, "leadCostOfGoodsSoldMicros": { -"description": "Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "leadGrossProfitMicros": { -"description": "Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "leadRevenueMicros": { -"description": "Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, @@ -1437,7 +1437,7 @@ "type": "string" }, "searchAbsoluteTopImpressionShare": { -"description": "The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/sa360/answer/9566729 for details. Any value below 0.1 is reported as 0.0999.", +"description": "The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See [About top and absolute top metrics](https://support.google.com/sa360/answer/9566729) for details. Any value below 0.1 is reported as 0.0999.", "format": "double", "type": "number" }, @@ -1452,7 +1452,7 @@ "type": "number" }, "searchBudgetLostTopImpressionShare": { -"description": "The number estimating how often your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.", +"description": "The estimated percent of times that your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.", "format": "double", "type": "number" }, @@ -1512,7 +1512,7 @@ "type": "number" }, "valuePerAllConversionsByConversionDate": { -"description": "The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.", +"description": "The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the \"All conversions\" column](https://support.google.com/sa360/answer/9250611).", "format": "double", "type": "number" }, @@ -1609,7 +1609,7 @@ "type": "object" }, "GoogleAdsSearchads360V0Common__SearchAds360ExpandedTextAdInfo": { -"description": "A Search Ads 360 expanded text ad.", +"description": "A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead.", "id": "GoogleAdsSearchads360V0Common__SearchAds360ExpandedTextAdInfo", "properties": { "adTrackingId": { @@ -2235,6 +2235,63 @@ }, "type": "object" }, +"GoogleAdsSearchads360V0Common__SyntheticContentAttestation": { +"description": "Represents an attestation about synthetic content from a single source.", +"id": "GoogleAdsSearchads360V0Common__SyntheticContentAttestation", +"properties": { +"source": { +"description": "The source of the synthetic content attestation.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"ADVERTISER_ATTESTED", +"GOOGLE_GENERATED_ADVERTISER_REVIEWED", +"GOOGLE_GENERATED_FULLY_AUTOMATED" +], +"enumDescriptions": [ +"Not specified.", +"Used for return values only. Represents value unknown in this version.", +"Attestation provided by the advertiser.", +"Google-generated content with advertiser review or input.", +"Google-autogenerated content without advertiser review." +], +"type": "string" +}, +"status": { +"description": "Indicates whether the content is considered synthetic by this source.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NOT_SYNTHETIC", +"IS_SYNTHETIC" +], +"enumDescriptions": [ +"Not specified.", +"Used for return values only. Represents value unknown in this version.", +"The content is attested as not synthetic.", +"The content is attested as synthetic." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V0Common__SyntheticContentInfo": { +"description": "Container for synthetic content attestations from different sources, such as the advertiser and Google systems.", +"id": "GoogleAdsSearchads360V0Common__SyntheticContentInfo", +"properties": { +"advertiserAttestation": { +"$ref": "GoogleAdsSearchads360V0Common__SyntheticContentAttestation", +"description": "Input provided by the advertiser." +}, +"systemAttestation": { +"$ref": "GoogleAdsSearchads360V0Common__SyntheticContentAttestation", +"description": "Output only. Information about synthetic content generated by Google's systems.", +"readOnly": true +} +}, +"type": "object" +}, "GoogleAdsSearchads360V0Common__TargetCpa": { "description": "An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.", "id": "GoogleAdsSearchads360V0Common__TargetCpa", @@ -2942,7 +2999,8 @@ "START_DATE_AFTER_END_DATE", "CANNOT_SET_DATE_TO_PAST", "AFTER_MAXIMUM_ALLOWABLE_DATE", -"CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED" +"CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED", +"REQUESTED_DATE_GRANULARITY_NOT_SUPPORTED" ], "enumDescriptions": [ "Enum unspecified.", @@ -2951,7 +3009,8 @@ "The start date was after the end date.", "Cannot set date to past time", "A date was used that is past the system \"last\" date.", -"Trying to change start date on a resource that has started." +"Trying to change start date on a resource that has started.", +"The requested time granularity is not supported for the date range in the query. Metrics with daily, hourly, or weekly segmentation are only available for the last 37 months." ], "type": "string" }, @@ -4094,7 +4153,7 @@ }, "expandedTextAd": { "$ref": "GoogleAdsSearchads360V0Common__SearchAds360ExpandedTextAdInfo", -"description": "Immutable. Details pertaining to an expanded text ad." +"description": "Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead." }, "finalAppUrls": { "description": "A list of final app URLs that will be used on mobile if the user has the specific app installed.", @@ -4143,6 +4202,10 @@ "$ref": "GoogleAdsSearchads360V0Common__SearchAds360ResponsiveSearchAdInfo", "description": "Immutable. Details pertaining to a responsive search ad." }, +"syntheticContentInfo": { +"$ref": "GoogleAdsSearchads360V0Common__SyntheticContentInfo", +"description": "Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD`" +}, "textAd": { "$ref": "GoogleAdsSearchads360V0Common__SearchAds360TextAdInfo", "description": "Immutable. Details pertaining to a text ad." @@ -4191,7 +4254,7 @@ "No value has been specified.", "The received value is not known in this version. This is a response-only value.", "The ad is a text ad.", -"The ad is an expanded text ad.", +"The ad is an expanded text ad. Expanded text ads are deprecated.", "The ad is a call only ad.", "The ad is an expanded dynamic search ad.", "The ad is a hotel ad.", @@ -5143,7 +5206,7 @@ false "type": "object" }, "GoogleAdsSearchads360V0Resources__AgeRangeView": { -"description": "An age range view.", +"description": "An age range view. Represents the view of a customer's performance metrics (like impressions and clicks) aggregated by age range. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API.", "id": "GoogleAdsSearchads360V0Resources__AgeRangeView", "properties": { "resourceName": { @@ -5282,6 +5345,10 @@ false "readOnly": true, "type": "string" }, +"syntheticContentInfo": { +"$ref": "GoogleAdsSearchads360V0Common__SyntheticContentInfo", +"description": "Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO`" +}, "textAsset": { "$ref": "GoogleAdsSearchads360V0Common__TextAsset", "description": "Output only. A text asset.", @@ -7345,7 +7412,7 @@ false "Floodlight activity that tracks the number of sales made or the number of items purchased. Can also capture the total value of each sale. Read only.", "Conversions that track local actions from Google's products and services after interacting with an ad. Read only.", "Conversions reported when a user submits a lead form. Read only.", -"Deprecated: The Salesforce integration will be going away and replaced with an improved way to import your conversions from Salesforce. - see https://support.google.com/google-ads/answer/14728349", +"Deprecated: The Salesforce integration ended on May 31, 2025. See [Legacy Salesforce integration for conversions upgrade FAQ](//support.google.com/google-ads/answer/14728349).", "Conversions imported from Search Ads 360 Floodlight data. Read only.", "Call conversions that occur on Smart campaign Ads without call tracking setup, using Smart campaign custom criteria. Read only.", "The user clicks on a call element within Google Maps. Smart campaign only. Read only.", @@ -8080,7 +8147,7 @@ false "type": "object" }, "GoogleAdsSearchads360V0Resources__GenderView": { -"description": "A gender view. The gender_view resource reflects the effective serving state, rather than what criteria were added. An ad group without gender criteria by default shows to all genders, so all genders appear in gender_view with stats.", +"description": "A gender view resource. Represents the view of a customer's performance metrics aggregated by gender. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API.", "id": "GoogleAdsSearchads360V0Resources__GenderView", "properties": { "resourceName": { @@ -10975,7 +11042,10 @@ false "ACCESS_DENIED_FOR_ACCOUNT_TYPE", "METRIC_ACCESS_DENIED", "CLOUD_PROJECT_NOT_UNDER_ORGANIZATION", -"ACTION_NOT_PERMITTED_FOR_SUSPENDED_ACCOUNT" +"ACTION_NOT_PERMITTED_FOR_SUSPENDED_ACCOUNT", +"SEARCH_ADS360_OTHER_ENGINE_MUTATE_DENIED", +"SEARCH_ADS360_MUTATE_ALLOWLIST_DENIED", +"SEARCH_ADS360_MUTATE_FIELD_DENIED" ], "enumDescriptions": [ "Enum unspecified.", @@ -10995,7 +11065,10 @@ false "The customer (or login customer) isn't allowed in Search Ads 360 API. It belongs to another ads system.", "The developer does not have access to the metrics queried.", "The Google Cloud project is not under the required organization.", -"The user does not have permission to perform this action on the resource or method because the Google Ads account is suspended." +"The user does not have permission to perform this action on the resource or method because the Google Ads account is suspended.", +"The user does not have permission to perform mutates on accounts that are not owned by Search Ads 360.", +"This account does not have permission to perform mutates using the Search Ads 360 API.", +"This field is not allowed for mutates." ], "type": "string" }, @@ -12926,7 +12999,8 @@ false "START_DATE_AFTER_END_DATE", "CANNOT_SET_DATE_TO_PAST", "AFTER_MAXIMUM_ALLOWABLE_DATE", -"CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED" +"CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED", +"REQUESTED_DATE_GRANULARITY_NOT_SUPPORTED" ], "enumDescriptions": [ "Enum unspecified.", @@ -12935,7 +13009,8 @@ false "The start date was after the end date.", "Cannot set date to past time", "A date was used that is past the system \"last\" date.", -"Trying to change start date on a resource that has started." +"Trying to change start date on a resource that has started.", +"The requested time granularity is not supported for the date range in the query. Metrics with daily, hourly, or weekly segmentation are only available for the last 37 months." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/searchads360.v23.json b/googleapiclient/discovery_cache/documents/searchads360.v23.json index 56a05265ea..929f276052 100644 --- a/googleapiclient/discovery_cache/documents/searchads360.v23.json +++ b/googleapiclient/discovery_cache/documents/searchads360.v23.json @@ -757,6 +757,90 @@ "https://www.googleapis.com/auth/doubleclicksearch" ] }, +"uploadCallConversions": { +"description": "Processes the given call conversions. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()", +"flatPath": "v23/customers/{customersId}:uploadCallConversions", +"httpMethod": "POST", +"id": "searchads360.customers.uploadCallConversions", +"parameterOrder": [ +"customerId" +], +"parameters": { +"customerId": { +"description": "Required. The ID of the customer performing the upload.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v23/customers/{+customerId}:uploadCallConversions", +"request": { +"$ref": "GoogleAdsSearchads360V23Services__UploadCallConversionsRequest" +}, +"response": { +"$ref": "GoogleAdsSearchads360V23Services__UploadCallConversionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/doubleclicksearch" +] +}, +"uploadClickConversions": { +"description": "Processes the given click conversions. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ConversionUploadError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()", +"flatPath": "v23/customers/{customersId}:uploadClickConversions", +"httpMethod": "POST", +"id": "searchads360.customers.uploadClickConversions", +"parameterOrder": [ +"customerId" +], +"parameters": { +"customerId": { +"description": "Required. The ID of the customer performing the upload.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v23/customers/{+customerId}:uploadClickConversions", +"request": { +"$ref": "GoogleAdsSearchads360V23Services__UploadClickConversionsRequest" +}, +"response": { +"$ref": "GoogleAdsSearchads360V23Services__UploadClickConversionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/doubleclicksearch" +] +}, +"uploadConversionAdjustments": { +"description": "Processes the given conversion adjustments. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()", +"flatPath": "v23/customers/{customersId}:uploadConversionAdjustments", +"httpMethod": "POST", +"id": "searchads360.customers.uploadConversionAdjustments", +"parameterOrder": [ +"customerId" +], +"parameters": { +"customerId": { +"description": "Required. The ID of the customer performing the upload.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v23/customers/{+customerId}:uploadConversionAdjustments", +"request": { +"$ref": "GoogleAdsSearchads360V23Services__UploadConversionAdjustmentsRequest" +}, +"response": { +"$ref": "GoogleAdsSearchads360V23Services__UploadConversionAdjustmentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/doubleclicksearch" +] +}, "uploadUserData": { "description": "Uploads the given user data. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [OfflineUserDataJobError]() [QuotaError]() [RequestError]() [UserDataError]()", "flatPath": "v23/customers/{customersId}:uploadUserData", @@ -4326,6 +4410,38 @@ } } }, +"searchAds360Campaigns": { +"methods": { +"mutate": { +"description": "Updates Search Ads 360 campaigns. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()", +"flatPath": "v23/customers/{customersId}/searchAds360Campaigns:mutate", +"httpMethod": "POST", +"id": "searchads360.customers.searchAds360Campaigns.mutate", +"parameterOrder": [ +"customerId" +], +"parameters": { +"customerId": { +"description": "Required. The ID of the customer whose Search Ads 360 campaigns are being modified.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v23/customers/{+customerId}/searchAds360Campaigns:mutate", +"request": { +"$ref": "GoogleAdsSearchads360V23Services__MutateSearchAds360CampaignsRequest" +}, +"response": { +"$ref": "GoogleAdsSearchads360V23Services__MutateSearchAds360CampaignsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/doubleclicksearch" +] +} +} +}, "sharedCriteria": { "methods": { "mutate": { @@ -4853,7 +4969,7 @@ } } }, -"revision": "20260413", +"revision": "20260729", "rootUrl": "https://searchads360.googleapis.com/", "schemas": { "GoogleAdsSearchads360V0Common__Value": { @@ -5077,7 +5193,8 @@ "START_DATE_AFTER_END_DATE", "CANNOT_SET_DATE_TO_PAST", "AFTER_MAXIMUM_ALLOWABLE_DATE", -"CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED" +"CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED", +"REQUESTED_DATE_GRANULARITY_NOT_SUPPORTED" ], "enumDescriptions": [ "Enum unspecified.", @@ -5086,7 +5203,8 @@ "The start date was after the end date.", "Cannot set date to past time", "A date was used that is past the system \"last\" date.", -"Trying to change start date on a resource that has started." +"Trying to change start date on a resource that has started.", +"The requested time granularity is not supported for the date range in the query. Metrics with daily, hourly, or weekly segmentation are only available for the last 37 months." ], "type": "string" }, @@ -9495,7 +9613,7 @@ "type": "object" }, "GoogleAdsSearchads360V23Common__ExpandedTextAdInfo": { -"description": "An expanded text ad.", +"description": "An expanded text ad. Expanded text ads are deprecated.", "id": "GoogleAdsSearchads360V23Common__ExpandedTextAdInfo", "properties": { "description": { @@ -11855,7 +11973,7 @@ "type": "number" }, "allConversionsByConversionDate": { -"description": "The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.", +"description": "The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the \"All conversions\" column](https://support.google.com/sa360/answer/9250611).", "format": "double", "type": "number" }, @@ -11910,7 +12028,7 @@ "type": "number" }, "allConversionsValueByConversionDate": { -"description": "The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.", +"description": "The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the \"All conversions\" column](https://support.google.com/sa360/answer/9250611).", "format": "double", "type": "number" }, @@ -11930,12 +12048,12 @@ "type": "number" }, "averageCpc": { -"description": "The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "double", "type": "number" }, "averageCpm": { -"description": "Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "double", "type": "number" }, @@ -11960,27 +12078,27 @@ "type": "string" }, "clientAccountConversions": { -"description": "The number of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", +"description": "The number of client account conversions. This only includes conversion actions which `include_in_client_account_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", "format": "double", "type": "number" }, "clientAccountConversionsValue": { -"description": "The value of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", +"description": "The value of client account conversions. This only includes conversion actions which `include_in_client_account_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", "format": "double", "type": "number" }, "clientAccountCrossSellCostOfGoodsSoldMicros": { -"description": "Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "clientAccountCrossSellGrossProfitMicros": { -"description": "Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "clientAccountCrossSellRevenueMicros": { -"description": "Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, @@ -11990,17 +12108,17 @@ "type": "number" }, "clientAccountLeadCostOfGoodsSoldMicros": { -"description": "Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "clientAccountLeadGrossProfitMicros": { -"description": "Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "clientAccountLeadRevenueMicros": { -"description": "Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, @@ -12042,7 +12160,7 @@ "type": "number" }, "conversionsByConversionDate": { -"description": "The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in date column means the conversion date.", +"description": "The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in the date column mean the conversion date.", "format": "double", "type": "number" }, @@ -12052,7 +12170,7 @@ "type": "number" }, "conversionsFromInteractionsValuePerInteraction": { -"description": "The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", +"description": "The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", "format": "double", "type": "number" }, @@ -12072,7 +12190,7 @@ "type": "number" }, "costMicros": { -"description": "The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause) for more details.", "format": "int64", "type": "string" }, @@ -12092,17 +12210,17 @@ "type": "number" }, "costPerCurrentModelAttributedConversion": { -"description": "The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", +"description": "The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.", "format": "double", "type": "number" }, "crossDeviceConversions": { -"description": "Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.", +"description": "Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in `all_conversions`.", "format": "double", "type": "number" }, "crossDeviceConversionsByConversionDate": { -"description": "The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.", +"description": "The number of cross-device conversions by conversion date. Details for the `by_conversion_date` columns are available at [About the \"All conversions\" column](https://support.google.com/sa360/answer/9250611)", "format": "double", "type": "number" }, @@ -12112,22 +12230,22 @@ "type": "number" }, "crossDeviceConversionsValueByConversionDate": { -"description": "The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.", +"description": "The sum of cross-device conversions value by conversion date. Details for the `by_conversion_date` columns are available at [About the \"All conversions\" column](https://support.google.com/sa360/answer/9250611)", "format": "double", "type": "number" }, "crossSellCostOfGoodsSoldMicros": { -"description": "Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "crossSellGrossProfitMicros": { -"description": "Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "crossSellRevenueMicros": { -"description": "Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, @@ -12142,12 +12260,12 @@ "type": "number" }, "generalInvalidClickRate": { -"description": "The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.", +"description": "The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504).", "format": "double", "type": "number" }, "generalInvalidClicks": { -"description": "Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.", +"description": "Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504).", "format": "int64", "type": "string" }, @@ -12269,17 +12387,17 @@ "type": "string" }, "leadCostOfGoodsSoldMicros": { -"description": "Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "leadGrossProfitMicros": { -"description": "Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, "leadRevenueMicros": { -"description": "Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", +"description": "Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the `metrics_currency` parameter at [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).", "format": "int64", "type": "string" }, @@ -12311,7 +12429,7 @@ "type": "string" }, "searchAbsoluteTopImpressionShare": { -"description": "The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/sa360/answer/9566729 for details. Any value below 0.1 is reported as 0.0999.", +"description": "The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See [About top and absolute top metrics](https://support.google.com/sa360/answer/9566729) for details. Any value below 0.1 is reported as 0.0999.", "format": "double", "type": "number" }, @@ -12326,7 +12444,7 @@ "type": "number" }, "searchBudgetLostTopImpressionShare": { -"description": "The number estimating how often your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.", +"description": "The estimated percent of times that your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.", "format": "double", "type": "number" }, @@ -12386,7 +12504,7 @@ "type": "number" }, "valuePerAllConversionsByConversionDate": { -"description": "The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.", +"description": "The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [About the \"All conversions\" column](https://support.google.com/sa360/answer/9250611).", "format": "double", "type": "number" }, @@ -13802,7 +13920,7 @@ "type": "object" }, "GoogleAdsSearchads360V23Common__SearchAds360ExpandedTextAdInfo": { -"description": "A Search Ads 360 expanded text ad.", +"description": "A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead.", "id": "GoogleAdsSearchads360V23Common__SearchAds360ExpandedTextAdInfo", "properties": { "adTrackingId": { @@ -14154,6 +14272,26 @@ "$ref": "GoogleAdsSearchads360V23Common__Keyword", "description": "Keyword criterion." }, +"mobileDevicePlatform": { +"description": "Mobile device platform to which metrics apply.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"ANDROID", +"IOS", +"OTHER_MOBILE", +"DESKTOP" +], +"enumDescriptions": [ +"Not specified.", +"Used for return value only. Represents value unknown in this version. Non-mobile and non-desktop devices will fall into this segment.", +"Android devices.", +"iOS devices.", +"Mobile devices that are not Android or iOS devices.", +"Desktop devices." +], +"type": "string" +}, "month": { "description": "Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.", "type": "string" @@ -14700,6 +14838,63 @@ }, "type": "object" }, +"GoogleAdsSearchads360V23Common__SyntheticContentAttestation": { +"description": "Represents an attestation about synthetic content from a single source.", +"id": "GoogleAdsSearchads360V23Common__SyntheticContentAttestation", +"properties": { +"source": { +"description": "The source of the synthetic content attestation.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"ADVERTISER_ATTESTED", +"GOOGLE_GENERATED_ADVERTISER_REVIEWED", +"GOOGLE_GENERATED_FULLY_AUTOMATED" +], +"enumDescriptions": [ +"Not specified.", +"Used for return values only. Represents value unknown in this version.", +"Attestation provided by the advertiser.", +"Google-generated content with advertiser review or input.", +"Google-autogenerated content without advertiser review." +], +"type": "string" +}, +"status": { +"description": "Indicates whether the content is considered synthetic by this source.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NOT_SYNTHETIC", +"IS_SYNTHETIC" +], +"enumDescriptions": [ +"Not specified.", +"Used for return values only. Represents value unknown in this version.", +"The content is attested as not synthetic.", +"The content is attested as synthetic." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Common__SyntheticContentInfo": { +"description": "Container for synthetic content attestations from different sources, such as the advertiser and Google systems.", +"id": "GoogleAdsSearchads360V23Common__SyntheticContentInfo", +"properties": { +"advertiserAttestation": { +"$ref": "GoogleAdsSearchads360V23Common__SyntheticContentAttestation", +"description": "Input provided by the advertiser." +}, +"systemAttestation": { +"$ref": "GoogleAdsSearchads360V23Common__SyntheticContentAttestation", +"description": "Output only. Information about synthetic content generated by Google's systems.", +"readOnly": true +} +}, +"type": "object" +}, "GoogleAdsSearchads360V23Common__TagSnippet": { "description": "The site tag and event snippet pair for a TrackingCodeType.", "id": "GoogleAdsSearchads360V23Common__TagSnippet", @@ -17724,7 +17919,10 @@ "ACCESS_DENIED_FOR_ACCOUNT_TYPE", "METRIC_ACCESS_DENIED", "CLOUD_PROJECT_NOT_UNDER_ORGANIZATION", -"ACTION_NOT_PERMITTED_FOR_SUSPENDED_ACCOUNT" +"ACTION_NOT_PERMITTED_FOR_SUSPENDED_ACCOUNT", +"SEARCH_ADS360_OTHER_ENGINE_MUTATE_DENIED", +"SEARCH_ADS360_MUTATE_ALLOWLIST_DENIED", +"SEARCH_ADS360_MUTATE_FIELD_DENIED" ], "enumDescriptions": [ "Enum unspecified.", @@ -17744,7 +17942,10 @@ "The customer (or login customer) isn't allowed in Search Ads 360 API. It belongs to another ads system.", "The developer does not have access to the metrics queried.", "The Google Cloud project is not under the required organization.", -"The user does not have permission to perform this action on the resource or method because the Google Ads account is suspended." +"The user does not have permission to perform this action on the resource or method because the Google Ads account is suspended.", +"The user does not have permission to perform mutates on accounts that are not owned by Search Ads 360.", +"This account does not have permission to perform mutates using the Search Ads 360 API.", +"This field is not allowed for mutates." ], "type": "string" }, @@ -19675,7 +19876,8 @@ "START_DATE_AFTER_END_DATE", "CANNOT_SET_DATE_TO_PAST", "AFTER_MAXIMUM_ALLOWABLE_DATE", -"CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED" +"CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED", +"REQUESTED_DATE_GRANULARITY_NOT_SUPPORTED" ], "enumDescriptions": [ "Enum unspecified.", @@ -19684,7 +19886,8 @@ "The start date was after the end date.", "Cannot set date to past time", "A date was used that is past the system \"last\" date.", -"Trying to change start date on a resource that has started." +"Trying to change start date on a resource that has started.", +"The requested time granularity is not supported for the date range in the query. Metrics with daily, hourly, or weekly segmentation are only available for the last 37 months." ], "type": "string" }, @@ -23968,6 +24171,7 @@ "GENERATE_VERTICAL_YOUTUBE_VIDEOS", "GENERATE_SHORTER_YOUTUBE_VIDEOS", "GENERATE_LANDING_PAGE_PREVIEW", +"GENERATE_LANDING_PAGE_TEXT", "GENERATE_ENHANCED_YOUTUBE_VIDEOS", "GENERATE_IMAGE_ENHANCEMENT", "GENERATE_IMAGE_EXTRACTION", @@ -23978,15 +24182,16 @@ "enumDescriptions": [ "Not specified.", "Used as a return value only. Represents value unknown in this version.", -"Text asset automation includes headlines and descriptions. By default, advertisers are opted-in for Performance Max and opted-out for Search.", +"Text asset automation (text customization) includes headlines and descriptions, allowing Google to create customized text assets using your existing ads, landing page copy, and generative AI across your campaign's ads. By default, advertisers are opted-in for Performance Max and opted-out for Search. Contrast this with `FINAL_URL_EXPANSION_TEXT_ASSET_AUTOMATION`, which dynamically generates text assets to match the content of dynamically selected landing pages when final URL expansion is active.", "Converts horizontal video assets to vertical orientation using content-aware technology. By default, advertisers are opted in for DemandGenVideoResponsiveAd.", "Shortens video assets to better capture user attention using content-aware technology.", "Generates a preview of the landing page shown in the engagement panel. By using this feature, you confirm that you own all legal rights to the images on the landing page used by this account (or you have permission to share the images with Google). You hereby instruct Google to publish these images on your behalf for advertising or other commercial purposes.", +"Generates text information from the landing page to be shown in the engagement panel. Opted in by default for DemandGenVideoResponsiveAd.", "Generates video enhancements (vertical and shorter videos) for PMax campaigns. Opted in by default.", "Generates image enhancements (AutoCrop and AutoEnhance). Opted in by default for pmax.", "Generates image extraction. It defaults to account level Dynamic Image Extension control value.", "Adds design elements and embeds text assets into image assets to create images with different aspect ratios. By default, advertisers are opted in for DemandGenMultiAssetAd.", -"Controls automation for text assets related to Final URL expansion. This includes automatically creating dynamic landing pages from the final URL and generating text assets from the content of those landing pages. This setting is turned OFF by default for Search campaigns, but it is turned ON by default for Performance Max campaigns.", +"Controls automation for text assets related to Final URL expansion. This includes automatically creating dynamic landing pages from the final URL and generating text assets from the content of those landing pages. This setting is turned OFF by default for Search campaigns, but it is turned ON by default for Performance Max campaigns. Enabling final URL expansion also enables text asset automation. There is no way to opt out of text asset automation and still use final URL expansion. Contrast this with standard `TEXT_ASSET_AUTOMATION` (text customization), which customizes copy across all ads in the campaign even when final URL expansion does not occur.", "Generates videos using other Assets as input, such as images and text. By default, advertisers are opted in for DemandGenMultiAssetAd." ], "type": "string" @@ -27673,7 +27878,7 @@ }, "expandedTextAd": { "$ref": "GoogleAdsSearchads360V23Common__ExpandedTextAdInfo", -"description": "Details pertaining to an expanded text ad." +"description": "Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead." }, "finalAppUrls": { "description": "A list of final app URLs that will be used on mobile if the user has the specific app installed.", @@ -27752,7 +27957,7 @@ }, "searchAds360ExpandedTextAd": { "$ref": "GoogleAdsSearchads360V23Common__SearchAds360ExpandedTextAdInfo", -"description": "Immutable. Details pertaining to an expanded text ad." +"description": "Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead." }, "searchAds360ResponsiveSearchAd": { "$ref": "GoogleAdsSearchads360V23Common__SearchAds360ResponsiveSearchAdInfo", @@ -27778,6 +27983,10 @@ "$ref": "GoogleAdsSearchads360V23Common__SmartCampaignAdInfo", "description": "Details pertaining to a Smart campaign ad." }, +"syntheticContentInfo": { +"$ref": "GoogleAdsSearchads360V23Common__SyntheticContentInfo", +"description": "Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD`" +}, "systemManagedResourceSource": { "description": "Output only. If this ad is system managed, then this field will indicate the source. This field is read-only.", "enum": [ @@ -27846,7 +28055,7 @@ "No value has been specified.", "The received value is not known in this version. This is a response-only value.", "The ad is a text ad.", -"The ad is an expanded text ad.", +"The ad is an expanded text ad. Expanded text ads are deprecated.", "The ad is an expanded dynamic search ad.", "The ad is a hotel ad.", "The ad is a Smart Shopping ad.", @@ -28779,6 +28988,7 @@ false "GENERATE_VERTICAL_YOUTUBE_VIDEOS", "GENERATE_SHORTER_YOUTUBE_VIDEOS", "GENERATE_LANDING_PAGE_PREVIEW", +"GENERATE_LANDING_PAGE_TEXT", "GENERATE_ENHANCED_YOUTUBE_VIDEOS", "GENERATE_IMAGE_ENHANCEMENT", "GENERATE_IMAGE_EXTRACTION", @@ -28789,15 +28999,16 @@ false "enumDescriptions": [ "Not specified.", "Used as a return value only. Represents value unknown in this version.", -"Text asset automation includes headlines and descriptions. By default, advertisers are opted-in for Performance Max and opted-out for Search.", +"Text asset automation (text customization) includes headlines and descriptions, allowing Google to create customized text assets using your existing ads, landing page copy, and generative AI across your campaign's ads. By default, advertisers are opted-in for Performance Max and opted-out for Search. Contrast this with `FINAL_URL_EXPANSION_TEXT_ASSET_AUTOMATION`, which dynamically generates text assets to match the content of dynamically selected landing pages when final URL expansion is active.", "Converts horizontal video assets to vertical orientation using content-aware technology. By default, advertisers are opted in for DemandGenVideoResponsiveAd.", "Shortens video assets to better capture user attention using content-aware technology.", "Generates a preview of the landing page shown in the engagement panel. By using this feature, you confirm that you own all legal rights to the images on the landing page used by this account (or you have permission to share the images with Google). You hereby instruct Google to publish these images on your behalf for advertising or other commercial purposes.", +"Generates text information from the landing page to be shown in the engagement panel. Opted in by default for DemandGenVideoResponsiveAd.", "Generates video enhancements (vertical and shorter videos) for PMax campaigns. Opted in by default.", "Generates image enhancements (AutoCrop and AutoEnhance). Opted in by default for pmax.", "Generates image extraction. It defaults to account level Dynamic Image Extension control value.", "Adds design elements and embeds text assets into image assets to create images with different aspect ratios. By default, advertisers are opted in for DemandGenMultiAssetAd.", -"Controls automation for text assets related to Final URL expansion. This includes automatically creating dynamic landing pages from the final URL and generating text assets from the content of those landing pages. This setting is turned OFF by default for Search campaigns, but it is turned ON by default for Performance Max campaigns.", +"Controls automation for text assets related to Final URL expansion. This includes automatically creating dynamic landing pages from the final URL and generating text assets from the content of those landing pages. This setting is turned OFF by default for Search campaigns, but it is turned ON by default for Performance Max campaigns. Enabling final URL expansion also enables text asset automation. There is no way to opt out of text asset automation and still use final URL expansion. Contrast this with standard `TEXT_ASSET_AUTOMATION` (text customization), which customizes copy across all ads in the campaign even when final URL expansion does not occur.", "Generates videos using other Assets as input, such as images and text. By default, advertisers are opted in for DemandGenMultiAssetAd." ], "type": "string" @@ -30649,7 +30860,7 @@ false "type": "object" }, "GoogleAdsSearchads360V23Resources__AgeRangeView": { -"description": "An age range view.", +"description": "An age range view. Represents the view of a customer's performance metrics (like impressions and clicks) aggregated by age range. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API.", "id": "GoogleAdsSearchads360V23Resources__AgeRangeView", "properties": { "resourceName": { @@ -31151,6 +31362,10 @@ false "$ref": "GoogleAdsSearchads360V23Common__StructuredSnippetAsset", "description": "A structured snippet asset." }, +"syntheticContentInfo": { +"$ref": "GoogleAdsSearchads360V23Common__SyntheticContentInfo", +"description": "Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO`" +}, "textAsset": { "$ref": "GoogleAdsSearchads360V23Common__TextAsset", "description": "Immutable. A text asset." @@ -36500,7 +36715,7 @@ false "Floodlight activity that tracks the number of sales made or the number of items purchased. Can also capture the total value of each sale. Read only.", "Conversions that track local actions from Google's products and services after interacting with an ad. Read only.", "Conversions reported when a user submits a lead form. Read only.", -"Deprecated: The Salesforce integration will be going away and replaced with an improved way to import your conversions from Salesforce. - see https://support.google.com/google-ads/answer/14728349", +"Deprecated: The Salesforce integration ended on May 31, 2025. See [Legacy Salesforce integration for conversions upgrade FAQ](//support.google.com/google-ads/answer/14728349).", "Conversions imported from Search Ads 360 Floodlight data. Read only.", "Call conversions that occur on Smart campaign Ads without call tracking setup, using Smart campaign custom criteria. Read only.", "The user clicks on a call element within Google Maps. Smart campaign only. Read only.", @@ -38248,12 +38463,12 @@ false "id": "GoogleAdsSearchads360V23Resources__CustomerLabel", "properties": { "customer": { -"description": "Output only. The resource name of the customer to which the label is attached. Read only.", +"description": "Output only. The resource name of the customer to which the label is attached. This field should not be set when creating a new `CustomerLabel`.", "readOnly": true, "type": "string" }, "label": { -"description": "Output only. The resource name of the label assigned to the customer. Note: the Customer ID portion of the label resource name is not validated when creating a new CustomerLabel.", +"description": "Output only. The resource name of the label assigned to the customer. This field should not be set when creating a new `CustomerLabel`. Note: the Customer ID portion of the label resource name is not validated when creating a new `CustomerLabel`.", "readOnly": true, "type": "string" }, @@ -38837,7 +39052,7 @@ false "type": "object" }, "GoogleAdsSearchads360V23Resources__DetailPlacementView": { -"description": "A view with metrics aggregated by ad group and URL or YouTube video. This view primarily surfaces placement data from the Google Display Network. While you can select segments like `segments.ad_network_type`, this view generally does not include placement data from other networks, such as the Search Partners network. To understand performance on Search Partners, consider other reports and segmentations.", +"description": "A view with metrics aggregated by ad group and URL or YouTube video. Provides granular performance data about specific URLs, YouTube videos, and apps where your ads showed. This offers a more detailed breakdown compared to the group_placement_view. This view primarily surfaces placement data from the Google Display Network. While you can select segments like `segments.ad_network_type`, this view generally does not include placement data from other networks, such as the Search Partners network. To understand performance on Search Partners, consider other reports and segmentations. Data for low-traffic placements may be aggregated.", "id": "GoogleAdsSearchads360V23Resources__DetailPlacementView", "properties": { "displayName": { @@ -39257,7 +39472,7 @@ false "id": "GoogleAdsSearchads360V23Resources__ExperimentArm", "properties": { "assetGroups": { -"description": "List of asset groups in the experiment arm.", +"description": "List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID.", "items": { "$ref": "GoogleAdsSearchads360V23Resources_ExperimentArm_AssetGroupInfo" }, @@ -39456,7 +39671,7 @@ false "type": "object" }, "GoogleAdsSearchads360V23Resources__GenderView": { -"description": "A gender view. The gender_view resource reflects the effective serving state, rather than what criteria were added. An ad group without gender criteria by default shows to all genders, so all genders appear in gender_view with stats.", +"description": "A gender view resource. Represents the view of a customer's performance metrics aggregated by gender. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API.", "id": "GoogleAdsSearchads360V23Resources__GenderView", "properties": { "resourceName": { @@ -39774,7 +39989,7 @@ false "type": "object" }, "GoogleAdsSearchads360V23Resources__GroupPlacementView": { -"description": "A group placement view.", +"description": "A view showing performance data for where your ads actually served on the Display Network and YouTube, including both targeted (managed) and automatic placements. Data for low-traffic placements may be aggregated. The scope of placements shown is influenced by the ad group's `TargetingSetting` for the `PLACEMENT` dimension.", "id": "GoogleAdsSearchads360V23Resources__GroupPlacementView", "properties": { "displayName": { @@ -41514,7 +41729,7 @@ false "type": "object" }, "GoogleAdsSearchads360V23Resources__ManagedPlacementView": { -"description": "A managed placement view.", +"description": "A view providing performance data for placements explicitly targeted in your ad groups.", "id": "GoogleAdsSearchads360V23Resources__ManagedPlacementView", "properties": { "resourceName": { @@ -44656,7 +44871,7 @@ false "type": "string" }, "path": { -"description": "Output only. The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, {\"Pets & Animals\", \"Pets\", \"Dogs\"} represents the \"Pets & Animals/Pets/Dogs\" category. List of available topic categories at https://developers.google.com/google-ads/api/reference/data/verticals", +"description": "Output only. The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, {\"Pets & Animals\", \"Pets\", \"Dogs\"} represents the \"Pets & Animals/Pets/Dogs\" category. List of available topic categories at https://developers.google.com/google-ads/api/data/topics", "items": { "type": "string" }, @@ -45760,6 +45975,27 @@ false }, "type": "object" }, +"GoogleAdsSearchads360V23Services_CartData_Item": { +"description": "Contains data of the items purchased.", +"id": "GoogleAdsSearchads360V23Services_CartData_Item", +"properties": { +"productId": { +"description": "The shopping id of the item. Must be equal to the Merchant Center product identifier.", +"type": "string" +}, +"quantity": { +"description": "Number of items sold.", +"format": "int32", +"type": "integer" +}, +"unitPrice": { +"description": "Unit price excluding tax, shipping, and any transaction level discounts. The currency code is the same as that in the `ClickConversion` message.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleAdsSearchads360V23Services_DismissRecommendationRequest_DismissRecommendationOperation": { "description": "Operation to dismiss a single recommendation identified by resource_name.", "id": "GoogleAdsSearchads360V23Services_DismissRecommendationRequest_DismissRecommendationOperation", @@ -47565,6 +47801,72 @@ false }, "type": "object" }, +"GoogleAdsSearchads360V23Services__CallConversion": { +"description": "A call conversion.", +"id": "GoogleAdsSearchads360V23Services__CallConversion", +"properties": { +"callStartDateTime": { +"description": "The date time at which the call occurred. The timezone must be specified. The format is \"yyyy-mm-dd hh:mm:ss+|-hh:mm\", for example, \"2019-01-01 12:32:45-08:00\".", +"type": "string" +}, +"callerId": { +"description": "The caller id from which this call was placed. Caller id is expected to be in E.164 format with preceding '+' sign, for example, \"+16502531234\".", +"type": "string" +}, +"consent": { +"$ref": "GoogleAdsSearchads360V23Common__Consent", +"description": "The consent setting for the event." +}, +"conversionAction": { +"description": "Resource name of the conversion action associated with this conversion. Note: Although this resource name consists of a customer id and a conversion action id, validation will ignore the customer id and use the conversion action id as the sole identifier of the conversion action.", +"type": "string" +}, +"conversionDateTime": { +"description": "The date time at which the conversion occurred. Must be after the call time. The timezone must be specified. The format is \"yyyy-mm-dd hh:mm:ss+|-hh:mm\", for example, \"2019-01-01 12:32:45-08:00\".", +"type": "string" +}, +"conversionValue": { +"description": "The value of the conversion for the advertiser.", +"format": "double", +"type": "number" +}, +"currencyCode": { +"description": "Currency associated with the conversion value. This is the ISO 4217 3-character currency code. For example: USD, EUR.", +"type": "string" +}, +"customVariables": { +"description": "The custom variables associated with this conversion.", +"items": { +"$ref": "GoogleAdsSearchads360V23Services__CustomVariable" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Services__CallConversionResult": { +"description": "Identifying information for a successfully processed CallConversionUpload.", +"id": "GoogleAdsSearchads360V23Services__CallConversionResult", +"properties": { +"callStartDateTime": { +"description": "The date time at which the call occurred. The format is \"yyyy-mm-dd hh:mm:ss+|-hh:mm\", for example, \"2019-01-01 12:32:45-08:00\".", +"type": "string" +}, +"callerId": { +"description": "The caller id from which this call was placed. Caller id is expected to be in E.164 format with preceding '+' sign.", +"type": "string" +}, +"conversionAction": { +"description": "Resource name of the conversion action associated with this conversion.", +"type": "string" +}, +"conversionDateTime": { +"description": "The date time at which the conversion occurred. The format is \"yyyy-mm-dd hh:mm:ss+|-hh:mm\", for example, \"2019-01-01 12:32:45-08:00\".", +"type": "string" +} +}, +"type": "object" +}, "GoogleAdsSearchads360V23Services__CampaignAssetOperation": { "description": "A single operation (create, remove) on a campaign asset.", "id": "GoogleAdsSearchads360V23Services__CampaignAssetOperation", @@ -47943,6 +48245,183 @@ false }, "type": "object" }, +"GoogleAdsSearchads360V23Services__CartData": { +"description": "Contains additional information about cart data.", +"id": "GoogleAdsSearchads360V23Services__CartData", +"properties": { +"feedCountryCode": { +"description": "The country code associated with the feed where the items are uploaded.", +"type": "string" +}, +"feedLanguageCode": { +"description": "The language code associated with the feed where the items are uploaded.", +"type": "string" +}, +"items": { +"description": "Data of the items purchased.", +"items": { +"$ref": "GoogleAdsSearchads360V23Services_CartData_Item" +}, +"type": "array" +}, +"localTransactionCost": { +"description": "Sum of all transaction level discounts, such as free shipping and coupon discounts for the whole cart. The currency code is the same as that in the `ClickConversion` message.", +"format": "double", +"type": "number" +}, +"merchantId": { +"description": "The Merchant Center ID where the items are uploaded.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Services__ClickConversion": { +"description": "A click conversion.", +"id": "GoogleAdsSearchads360V23Services__ClickConversion", +"properties": { +"cartData": { +"$ref": "GoogleAdsSearchads360V23Services__CartData", +"description": "The cart data associated with this conversion." +}, +"consent": { +"$ref": "GoogleAdsSearchads360V23Common__Consent", +"description": "The consent setting for the event." +}, +"conversionAction": { +"description": "Resource name of the conversion action associated with this conversion. Note: Although this resource name consists of a customer id and a conversion action id, validation will ignore the customer id and use the conversion action id as the sole identifier of the conversion action.", +"type": "string" +}, +"conversionDateTime": { +"description": "The date time at which the conversion occurred. Must be after the click time. The timezone must be specified. The format is \"yyyy-mm-dd hh:mm:ss+|-hh:mm\", for example, \"2019-01-01 12:32:45-08:00\".", +"type": "string" +}, +"conversionEnvironment": { +"description": "The environment this conversion was recorded on, for example, App or Web.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"APP", +"WEB" +], +"enumDescriptions": [ +"Not specified.", +"Used for return value only. Represents value unknown in this version.", +"The conversion was recorded on an app.", +"The conversion was recorded on a website." +], +"type": "string" +}, +"conversionValue": { +"description": "The value of the conversion for the advertiser.", +"format": "double", +"type": "number" +}, +"currencyCode": { +"description": "Currency associated with the conversion value. This is the ISO 4217 3-character currency code. For example: USD, EUR.", +"type": "string" +}, +"customVariables": { +"description": "The custom variables associated with this conversion.", +"items": { +"$ref": "GoogleAdsSearchads360V23Services__CustomVariable" +}, +"type": "array" +}, +"customerType": { +"description": "Type of the customer associated with the conversion (new or returning).", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"NEW", +"RETURNING" +], +"enumDescriptions": [ +"Not specified.", +"The value is unknown in this version.", +"Converting user is new to the advertiser.", +"Converting user is returning to the advertiser. Definition of returning differs among conversion types, such as a second store visit versus a second online purchase." +], +"type": "string" +}, +"externalAttributionData": { +"$ref": "GoogleAdsSearchads360V23Services__ExternalAttributionData", +"description": "Additional data about externally attributed conversions. This field is required for conversions with an externally attributed conversion action, but should not be set otherwise." +}, +"gbraid": { +"description": "The URL parameter for clicks associated with app conversions.", +"type": "string" +}, +"gclid": { +"description": "The Google click ID (gclid) associated with this conversion.", +"type": "string" +}, +"orderId": { +"description": "The order ID associated with the conversion. An order id can only be used for one conversion per conversion action.", +"type": "string" +}, +"sessionAttributesEncoded": { +"description": "The session attributes for the event, represented as a base64-encoded JSON string. The content should be generated by Google-provided library. To set session attributes individually, use session_attributes_key_value_pairs instead. This field is only available to allowlisted users. To include this field in conversion imports, upgrade to the Data Manager API.", +"format": "byte", +"type": "string" +}, +"sessionAttributesKeyValuePairs": { +"$ref": "GoogleAdsSearchads360V23Services__SessionAttributesKeyValuePairs", +"description": "The session attributes for the event, represented as key-value pairs. This field is only available to allowlisted users. To include this field in conversion imports, upgrade to the Data Manager API." +}, +"userIdentifiers": { +"description": "The user identifiers associated with this conversion. Only hashed_email and hashed_phone_number are supported for conversion uploads. The maximum number of user identifiers for each conversion is 5.", +"items": { +"$ref": "GoogleAdsSearchads360V23Common__UserIdentifier" +}, +"type": "array" +}, +"userIpAddress": { +"description": "The IP address of the customer when they arrived on the landing page after an ad click but before a conversion event. This is the IP address of the customer's device, not the advertiser's server. Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See [About offline conversion imports](//support.google.com/google-ads/answer/2998031) page for more details. This field is only available to allowlisted users. To include this field in conversion imports, upgrade to the Data Manager API.", +"type": "string" +}, +"wbraid": { +"description": "The URL parameter for clicks associated with web conversions.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Services__ClickConversionResult": { +"description": "Identifying information for a successfully processed `ClickConversion`.", +"id": "GoogleAdsSearchads360V23Services__ClickConversionResult", +"properties": { +"conversionAction": { +"description": "Resource name of the conversion action associated with this conversion.", +"type": "string" +}, +"conversionDateTime": { +"description": "The date time at which the conversion occurred. The format is \"yyyy-mm-dd hh:mm:ss+|-hh:mm\", for example, \"2019-01-01 12:32:45-08:00\".", +"type": "string" +}, +"gbraid": { +"description": "The URL parameter for clicks associated with app conversions.", +"type": "string" +}, +"gclid": { +"description": "The Google Click ID (gclid) associated with this conversion.", +"type": "string" +}, +"userIdentifiers": { +"description": "The user identifiers associated with this conversion. Only hashed_email and hashed_phone_number are supported for conversion uploads. The maximum number of user identifiers for each conversion is 5.", +"items": { +"$ref": "GoogleAdsSearchads360V23Common__UserIdentifier" +}, +"type": "array" +}, +"wbraid": { +"description": "The URL parameter for clicks associated with web conversions.", +"type": "string" +} +}, +"type": "object" +}, "GoogleAdsSearchads360V23Services__ConfigureCampaignLifecycleGoalsRequest": { "description": "Request message for CampaignLifecycleGoalService.ConfigureCampaignLifecycleGoals.", "id": "GoogleAdsSearchads360V23Services__ConfigureCampaignLifecycleGoalsRequest", @@ -48071,6 +48550,103 @@ false }, "type": "object" }, +"GoogleAdsSearchads360V23Services__ConversionAdjustment": { +"description": "A conversion adjustment.", +"id": "GoogleAdsSearchads360V23Services__ConversionAdjustment", +"properties": { +"adjustmentDateTime": { +"description": "The date time at which the adjustment occurred. Must be after the conversion_date_time. The timezone must be specified. The format is \"yyyy-mm-dd hh:mm:ss+|-hh:mm\", for example, \"2019-01-01 12:32:45-08:00\".", +"type": "string" +}, +"adjustmentType": { +"description": "The adjustment type.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"RETRACTION", +"RESTATEMENT", +"ENHANCEMENT" +], +"enumDescriptions": [ +"Not specified.", +"Represents value unknown in this version.", +"Negates a conversion so that its total value and count are both zero.", +"Changes the value of a conversion.", +"Supplements an existing conversion with provided user identifiers and user agent, which can be used by Google to enhance the conversion count." +], +"type": "string" +}, +"conversionAction": { +"description": "Resource name of the conversion action associated with this conversion adjustment. Note: Although this resource name consists of a customer id and a conversion action id, validation will ignore the customer id and use the conversion action id as the sole identifier of the conversion action.", +"type": "string" +}, +"gclidDateTimePair": { +"$ref": "GoogleAdsSearchads360V23Services__GclidDateTimePair", +"description": "For adjustments, uniquely identifies a conversion that was reported without an order ID specified. If the adjustment_type is ENHANCEMENT, this value is optional but may be set in addition to the order_id." +}, +"orderId": { +"description": "The order ID of the conversion to be adjusted. If the conversion was reported with an order ID specified, that order ID must be used as the identifier here. The order ID is required for enhancements.", +"type": "string" +}, +"restatementValue": { +"$ref": "GoogleAdsSearchads360V23Services__RestatementValue", +"description": "Information needed to restate the conversion's value. Required for restatements. Should not be supplied for retractions. An error will be returned if provided for a retraction. NOTE: If you want to upload a second restatement with a different adjusted value, it must have a new, more recent, adjustment occurrence time. Otherwise, it will be treated as a duplicate of the previous restatement and ignored." +}, +"userAgent": { +"description": "The user agent to enhance the original conversion. This can be found in your user's HTTP request header when they convert on your web page. Example, \"Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 like Mac OS X)\". User agent can only be specified in enhancements with user identifiers.", +"type": "string" +}, +"userIdentifiers": { +"description": "The user identifiers to enhance the original conversion. ConversionAdjustmentUploadService only accepts user identifiers in enhancements. The maximum number of user identifiers for each enhancement is 5.", +"items": { +"$ref": "GoogleAdsSearchads360V23Common__UserIdentifier" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Services__ConversionAdjustmentResult": { +"description": "Information identifying a successfully processed ConversionAdjustment.", +"id": "GoogleAdsSearchads360V23Services__ConversionAdjustmentResult", +"properties": { +"adjustmentDateTime": { +"description": "The date time at which the adjustment occurred. The format is \"yyyy-mm-dd hh:mm:ss+|-hh:mm\", for example, \"2019-01-01 12:32:45-08:00\".", +"type": "string" +}, +"adjustmentType": { +"description": "The adjustment type.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"RETRACTION", +"RESTATEMENT", +"ENHANCEMENT" +], +"enumDescriptions": [ +"Not specified.", +"Represents value unknown in this version.", +"Negates a conversion so that its total value and count are both zero.", +"Changes the value of a conversion.", +"Supplements an existing conversion with provided user identifiers and user agent, which can be used by Google to enhance the conversion count." +], +"type": "string" +}, +"conversionAction": { +"description": "Resource name of the conversion action associated with this conversion adjustment.", +"type": "string" +}, +"gclidDateTimePair": { +"$ref": "GoogleAdsSearchads360V23Services__GclidDateTimePair", +"description": "The gclid and conversion date time of the conversion." +}, +"orderId": { +"description": "The order ID of the conversion to be adjusted.", +"type": "string" +} +}, +"type": "object" +}, "GoogleAdsSearchads360V23Services__ConversionCustomDimensionHeader": { "description": "Message for conversion custom dimension header.", "id": "GoogleAdsSearchads360V23Services__ConversionCustomDimensionHeader", @@ -48503,6 +49079,21 @@ false }, "type": "object" }, +"GoogleAdsSearchads360V23Services__CustomVariable": { +"description": "A custom variable.", +"id": "GoogleAdsSearchads360V23Services__CustomVariable", +"properties": { +"conversionCustomVariable": { +"description": "Resource name of the custom variable associated with this conversion. Note: Although this resource name consists of a customer id and a conversion custom variable id, validation will ignore the customer id and use the conversion custom variable id as the sole identifier of the conversion custom variable.", +"type": "string" +}, +"value": { +"description": "The value string of this custom variable. The value of the custom variable should not contain private customer data, such as email addresses or phone numbers.", +"type": "string" +} +}, +"type": "object" +}, "GoogleAdsSearchads360V23Services__CustomerAssetOperation": { "description": "A single operation (create, update, remove) on a customer asset.", "id": "GoogleAdsSearchads360V23Services__CustomerAssetOperation", @@ -49034,6 +49625,22 @@ false }, "type": "object" }, +"GoogleAdsSearchads360V23Services__ExternalAttributionData": { +"description": "Contains additional information about externally attributed conversions.", +"id": "GoogleAdsSearchads360V23Services__ExternalAttributionData", +"properties": { +"externalAttributionCredit": { +"description": "Represents the fraction of the conversion that is attributed to the Google Ads click.", +"format": "double", +"type": "number" +}, +"externalAttributionModel": { +"description": "Specifies the attribution model name.", +"type": "string" +} +}, +"type": "object" +}, "GoogleAdsSearchads360V23Services__FetchIncentiveResponse": { "description": "Response from getting the acquisition incentive for a user when they visit a specific marketing page.", "id": "GoogleAdsSearchads360V23Services__FetchIncentiveResponse", @@ -49181,6 +49788,21 @@ false }, "type": "object" }, +"GoogleAdsSearchads360V23Services__GclidDateTimePair": { +"description": "Uniquely identifies a conversion that was reported without an order ID specified.", +"id": "GoogleAdsSearchads360V23Services__GclidDateTimePair", +"properties": { +"conversionDateTime": { +"description": "The date time at which the original conversion for this adjustment occurred. The timezone must be specified. The format is \"yyyy-mm-dd hh:mm:ss+|-hh:mm\", for example, \"2019-01-01 12:32:45-08:00\".", +"type": "string" +}, +"gclid": { +"description": "Google click ID (gclid) associated with the original conversion for this adjustment.", +"type": "string" +} +}, +"type": "object" +}, "GoogleAdsSearchads360V23Services__GenerateAdGroupThemesRequest": { "description": "Request message for KeywordPlanIdeaService.GenerateAdGroupThemes.", "id": "GoogleAdsSearchads360V23Services__GenerateAdGroupThemesRequest", @@ -55103,7 +55725,7 @@ false "type": "object" }, "GoogleAdsSearchads360V23Services__MutateCustomerLabelsRequest": { -"description": "Request message for CustomerLabelService.MutateCustomerLabels.", +"description": "Request message for CustomerLabelService.MutateCustomerLabels. A single `MutateCustomerLabelsRequest` can only modify labels for the single customer account specified in the request. To apply a label to multiple different accounts, separate `MutateCustomerLabelsRequest` calls must be made.", "id": "GoogleAdsSearchads360V23Services__MutateCustomerLabelsRequest", "properties": { "operations": { @@ -56641,6 +57263,56 @@ false }, "type": "object" }, +"GoogleAdsSearchads360V23Services__MutateSearchAds360CampaignsRequest": { +"description": "Request message for SearchAds360CampaignService.MutateSearchAds360Campaigns.", +"id": "GoogleAdsSearchads360V23Services__MutateSearchAds360CampaignsRequest", +"properties": { +"operations": { +"description": "Required. The list of operations to perform on individual Search Ads 360 campaigns.", +"items": { +"$ref": "GoogleAdsSearchads360V23Services__SearchAds360CampaignOperation" +}, +"type": "array" +}, +"partialFailure": { +"description": "If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.", +"type": "boolean" +}, +"responseContentType": { +"description": "The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.", +"enum": [ +"UNSPECIFIED", +"RESOURCE_NAME_ONLY", +"MUTABLE_RESOURCE" +], +"enumDescriptions": [ +"Not specified. Will return the resource name only in the response.", +"The mutate response will be the resource name.", +"The mutate response will contain the resource name and the resource with mutable fields if possible. Otherwise, only the resource name will be returned." +], +"type": "string" +}, +"validateOnly": { +"description": "If true, the request is validated but not executed. Only errors are returned, not results.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Services__MutateSearchAds360CampaignsResponse": { +"description": "Response message for Search Ads 360 campaign mutate.", +"id": "GoogleAdsSearchads360V23Services__MutateSearchAds360CampaignsResponse", +"properties": { +"results": { +"description": "All results for the mutate.", +"items": { +"$ref": "GoogleAdsSearchads360V23Services__MutateSearchAds360CampaignResult" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleAdsSearchads360V23Services__MutateSearchAds360Request": { "description": "Request message for Service.Mutate.", "id": "GoogleAdsSearchads360V23Services__MutateSearchAds360Request", @@ -57968,6 +58640,22 @@ false }, "type": "object" }, +"GoogleAdsSearchads360V23Services__RestatementValue": { +"description": "Contains information needed to restate a conversion's value.", +"id": "GoogleAdsSearchads360V23Services__RestatementValue", +"properties": { +"adjustedValue": { +"description": "The restated conversion value. This is the value of the conversion after restatement. For example, to change the value of a conversion from 100 to 70, an adjusted value of 70 should be reported. NOTE: If you want to upload a second restatement with a different adjusted value, it must have a new, more recent, adjustment occurrence time. Otherwise, it will be treated as a duplicate of the previous restatement and ignored.", +"format": "double", +"type": "number" +}, +"currencyCode": { +"description": "The currency of the restated value. If not provided, then the default currency from the conversion action is used, and if that is not set then the account currency is used. This is the ISO 4217 3-character currency code for example, USD or EUR.", +"type": "string" +} +}, +"type": "object" +}, "GoogleAdsSearchads360V23Services__RunBatchJobRequest": { "description": "Request message for BatchJobService.RunBatchJob.", "id": "GoogleAdsSearchads360V23Services__RunBatchJobRequest", @@ -58942,6 +59630,35 @@ false }, "type": "object" }, +"GoogleAdsSearchads360V23Services__SessionAttributeKeyValuePair": { +"description": "Contains one session attribute of the conversion.", +"id": "GoogleAdsSearchads360V23Services__SessionAttributeKeyValuePair", +"properties": { +"sessionAttributeKey": { +"description": "Required. The name of the session attribute.", +"type": "string" +}, +"sessionAttributeValue": { +"description": "Required. The value of the session attribute.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Services__SessionAttributesKeyValuePairs": { +"description": "Contains session attributes of the conversion, represented as key-value pairs.", +"id": "GoogleAdsSearchads360V23Services__SessionAttributesKeyValuePairs", +"properties": { +"keyValuePairs": { +"description": "Required. The session attributes for the conversion.", +"items": { +"$ref": "GoogleAdsSearchads360V23Services__SessionAttributeKeyValuePair" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleAdsSearchads360V23Services__SharedCriterionOperation": { "description": "A single operation (create, remove) on an shared criterion.", "id": "GoogleAdsSearchads360V23Services__SharedCriterionOperation", @@ -59760,6 +60477,146 @@ false }, "type": "object" }, +"GoogleAdsSearchads360V23Services__UploadCallConversionsRequest": { +"description": "Request message for ConversionUploadService.UploadCallConversions.", +"id": "GoogleAdsSearchads360V23Services__UploadCallConversionsRequest", +"properties": { +"conversions": { +"description": "Required. The conversions that are being uploaded.", +"items": { +"$ref": "GoogleAdsSearchads360V23Services__CallConversion" +}, +"type": "array" +}, +"partialFailure": { +"description": "Required. If `true`, successful operations will be carried out and invalid operations will return errors. If `false`, all operations will be carried out in one transaction if and only if they are all valid. This should always be set to `true`.", +"type": "boolean" +}, +"validateOnly": { +"description": "If true, the request is validated but not executed. Only errors are returned, not results.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Services__UploadCallConversionsResponse": { +"description": "Response message for ConversionUploadService.UploadCallConversions.", +"id": "GoogleAdsSearchads360V23Services__UploadCallConversionsResponse", +"properties": { +"partialFailureError": { +"$ref": "GoogleRpc__Status", +"description": "Errors that pertain to conversion failures in the partial failure mode. Returned when all errors occur inside the conversions. If any errors occur outside the conversions (for example, auth errors), we return an RPC level error." +}, +"results": { +"description": "Returned for successfully processed conversions. Proto will be empty for rows that received an error. Results are not returned when `validate_only` is `true`.", +"items": { +"$ref": "GoogleAdsSearchads360V23Services__CallConversionResult" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Services__UploadClickConversionsRequest": { +"description": "Request message for ConversionUploadService.UploadClickConversions.", +"id": "GoogleAdsSearchads360V23Services__UploadClickConversionsRequest", +"properties": { +"conversions": { +"description": "Required. The conversions that are being uploaded.", +"items": { +"$ref": "GoogleAdsSearchads360V23Services__ClickConversion" +}, +"type": "array" +}, +"jobId": { +"description": "Optional. Optional input to set job ID. Must be a non-negative number that is less than 2^31 if provided. If this field is not provided, the API will generate a job ID in the range [2^31, (2^63)-1]. The API will return the value for this request in the `job_id` field of the `UploadClickConversionsResponse`.", +"format": "int32", +"type": "integer" +}, +"partialFailure": { +"description": "Required. If `true`, successful operations will be carried out and invalid operations will return errors. If `false`, all operations will be carried out in one transaction if and only if they are all valid. This should always be set to `true`.", +"type": "boolean" +}, +"validateOnly": { +"description": "If `true`, the request is validated but not executed. Only errors are returned, not results.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Services__UploadClickConversionsResponse": { +"description": "Response message for ConversionUploadService.UploadClickConversions.", +"id": "GoogleAdsSearchads360V23Services__UploadClickConversionsResponse", +"properties": { +"jobId": { +"description": "Job ID for the upload batch.", +"format": "int64", +"type": "string" +}, +"partialFailureError": { +"$ref": "GoogleRpc__Status", +"description": "Errors that pertain to conversion failures in the partial failure mode. Returned when all errors occur inside the conversions. If any errors occur outside the conversions (for example, auth errors), we return an RPC level error." +}, +"results": { +"description": "Returned for successfully processed conversions. Proto will be empty for rows that received an error. Results are not returned when `validate_only` is `true`.", +"items": { +"$ref": "GoogleAdsSearchads360V23Services__ClickConversionResult" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Services__UploadConversionAdjustmentsRequest": { +"description": "Request message for ConversionAdjustmentUploadService.UploadConversionAdjustments.", +"id": "GoogleAdsSearchads360V23Services__UploadConversionAdjustmentsRequest", +"properties": { +"conversionAdjustments": { +"description": "Required. The conversion adjustments that are being uploaded.", +"items": { +"$ref": "GoogleAdsSearchads360V23Services__ConversionAdjustment" +}, +"type": "array" +}, +"jobId": { +"description": "Optional. Optional input to set job ID. Must be a non-negative number that is less than 2^31 if provided. If this field is not provided, the API will generate a job ID in the range [2^31, (2^63)-1]. The API will return the value for this request in the `job_id` field of the `UploadConversionAdjustmentsResponse`.", +"format": "int32", +"type": "integer" +}, +"partialFailure": { +"description": "Required. If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. This should always be set to true. See https://developers.google.com/google-ads/api/docs/best-practices/partial-failures for more information about partial failure.", +"type": "boolean" +}, +"validateOnly": { +"description": "If true, the request is validated but not executed. Only errors are returned, not results.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleAdsSearchads360V23Services__UploadConversionAdjustmentsResponse": { +"description": "Response message for ConversionAdjustmentUploadService.UploadConversionAdjustments.", +"id": "GoogleAdsSearchads360V23Services__UploadConversionAdjustmentsResponse", +"properties": { +"jobId": { +"description": "Job ID for the upload batch.", +"format": "int64", +"type": "string" +}, +"partialFailureError": { +"$ref": "GoogleRpc__Status", +"description": "Errors that pertain to conversion adjustment failures in the partial failure mode. Returned when all errors occur inside the adjustments. If any errors occur outside the adjustments (for example, auth errors), we return an RPC level error. See https://developers.google.com/google-ads/api/docs/best-practices/partial-failures for more information about partial failure." +}, +"results": { +"description": "Returned for successfully processed conversion adjustments. Proto will be empty for rows that received an error. Results are not returned when validate_only is true.", +"items": { +"$ref": "GoogleAdsSearchads360V23Services__ConversionAdjustmentResult" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleAdsSearchads360V23Services__UploadUserDataRequest": { "description": "Request message for UserDataService.UploadUserData", "id": "GoogleAdsSearchads360V23Services__UploadUserDataRequest", From a9604b322eeb2df470b572ad15cb948947abcc46 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:14 +0000 Subject: [PATCH 75/84] feat(securitycenter): update the api #### securitycenter:v1 The following keys were added: - schemas.Agent (Total Keys: 15) - schemas.DetectorReference (Total Keys: 7) - schemas.Finding.properties.agent (Total Keys: 4) - schemas.GoogleCloudSecuritycenterV2Agent (Total Keys: 15) - schemas.GoogleCloudSecuritycenterV2DetectorReference (Total Keys: 7) - schemas.GoogleCloudSecuritycenterV2Finding.properties.agent (Total Keys: 4) - schemas.GoogleCloudSecuritycenterV2InvocationReference (Total Keys: 3) - schemas.InvocationReference (Total Keys: 3) The following keys were changed: - resources.folders.resources.assets.methods.group.scopes (Total Keys: 1) - resources.folders.resources.assets.methods.list.scopes (Total Keys: 1) - resources.folders.resources.assets.methods.updateSecurityMarks.scopes (Total Keys: 1) - resources.folders.resources.bigQueryExports.methods.create.scopes (Total Keys: 1) - resources.folders.resources.bigQueryExports.methods.delete.scopes (Total Keys: 1) - resources.folders.resources.bigQueryExports.methods.get.scopes (Total Keys: 1) - resources.folders.resources.bigQueryExports.methods.list.scopes (Total Keys: 1) - resources.folders.resources.bigQueryExports.methods.patch.scopes (Total Keys: 1) - resources.folders.resources.eventThreatDetectionSettings.methods.validateCustomModule.scopes (Total Keys: 1) - resources.folders.resources.eventThreatDetectionSettings.resources.customModules.methods.create.scopes (Total Keys: 1) - resources.folders.resources.eventThreatDetectionSettings.resources.customModules.methods.delete.scopes (Total Keys: 1) - resources.folders.resources.eventThreatDetectionSettings.resources.customModules.methods.get.scopes (Total Keys: 1) - resources.folders.resources.eventThreatDetectionSettings.resources.customModules.methods.list.scopes (Total Keys: 1) - resources.folders.resources.eventThreatDetectionSettings.resources.customModules.methods.listDescendant.scopes (Total Keys: 1) - resources.folders.resources.eventThreatDetectionSettings.resources.customModules.methods.patch.scopes (Total Keys: 1) - resources.folders.resources.eventThreatDetectionSettings.resources.effectiveCustomModules.methods.get.scopes (Total Keys: 1) - resources.folders.resources.eventThreatDetectionSettings.resources.effectiveCustomModules.methods.list.scopes (Total Keys: 1) - resources.folders.resources.findings.methods.bulkMute.scopes (Total Keys: 1) - resources.folders.resources.locations.resources.muteConfigs.methods.delete.scopes (Total Keys: 1) - resources.folders.resources.locations.resources.muteConfigs.methods.get.scopes (Total Keys: 1) - resources.folders.resources.locations.resources.muteConfigs.methods.patch.scopes (Total Keys: 1) - resources.folders.resources.muteConfigs.methods.create.scopes (Total Keys: 1) - resources.folders.resources.muteConfigs.methods.delete.scopes (Total Keys: 1) - resources.folders.resources.muteConfigs.methods.get.scopes (Total Keys: 1) - resources.folders.resources.muteConfigs.methods.list.scopes (Total Keys: 1) - resources.folders.resources.muteConfigs.methods.patch.scopes (Total Keys: 1) - resources.folders.resources.notificationConfigs.methods.create.scopes (Total Keys: 1) - resources.folders.resources.notificationConfigs.methods.delete.scopes (Total Keys: 1) - resources.folders.resources.notificationConfigs.methods.get.scopes (Total Keys: 1) - resources.folders.resources.notificationConfigs.methods.list.scopes (Total Keys: 1) - resources.folders.resources.notificationConfigs.methods.patch.scopes (Total Keys: 1) - resources.folders.resources.securityHealthAnalyticsSettings.resources.customModules.methods.create.scopes (Total Keys: 1) - resources.folders.resources.securityHealthAnalyticsSettings.resources.customModules.methods.delete.scopes (Total Keys: 1) - resources.folders.resources.securityHealthAnalyticsSettings.resources.customModules.methods.get.scopes (Total Keys: 1) - resources.folders.resources.securityHealthAnalyticsSettings.resources.customModules.methods.list.scopes (Total Keys: 1) - resources.folders.resources.securityHealthAnalyticsSettings.resources.customModules.methods.listDescendant.scopes (Total Keys: 1) - resources.folders.resources.securityHealthAnalyticsSettings.resources.customModules.methods.patch.scopes (Total Keys: 1) - resources.folders.resources.securityHealthAnalyticsSettings.resources.customModules.methods.simulate.scopes (Total Keys: 1) - resources.folders.resources.securityHealthAnalyticsSettings.resources.effectiveCustomModules.methods.get.scopes (Total Keys: 1) - resources.folders.resources.securityHealthAnalyticsSettings.resources.effectiveCustomModules.methods.list.scopes (Total Keys: 1) - resources.folders.resources.sources.methods.list.scopes (Total Keys: 1) - resources.folders.resources.sources.resources.findings.methods.group.scopes (Total Keys: 1) - resources.folders.resources.sources.resources.findings.methods.list.scopes (Total Keys: 1) - resources.folders.resources.sources.resources.findings.methods.patch.scopes (Total Keys: 1) - resources.folders.resources.sources.resources.findings.methods.setMute.scopes (Total Keys: 1) - resources.folders.resources.sources.resources.findings.methods.setState.scopes (Total Keys: 1) - resources.folders.resources.sources.resources.findings.methods.updateSecurityMarks.scopes (Total Keys: 1) - resources.folders.resources.sources.resources.findings.resources.externalSystems.methods.patch.scopes (Total Keys: 1) - resources.organizations.methods.getOrganizationSettings.scopes (Total Keys: 1) - resources.organizations.methods.updateOrganizationSettings.scopes (Total Keys: 1) - resources.organizations.resources.assets.methods.group.scopes (Total Keys: 1) - resources.organizations.resources.assets.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.assets.methods.runDiscovery.scopes (Total Keys: 1) - resources.organizations.resources.assets.methods.updateSecurityMarks.scopes (Total Keys: 1) - resources.organizations.resources.attackPaths.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.bigQueryExports.methods.create.scopes (Total Keys: 1) - resources.organizations.resources.bigQueryExports.methods.delete.scopes (Total Keys: 1) - resources.organizations.resources.bigQueryExports.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.bigQueryExports.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.bigQueryExports.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.eventThreatDetectionSettings.methods.validateCustomModule.scopes (Total Keys: 1) - resources.organizations.resources.eventThreatDetectionSettings.resources.customModules.methods.create.scopes (Total Keys: 1) - resources.organizations.resources.eventThreatDetectionSettings.resources.customModules.methods.delete.scopes (Total Keys: 1) - resources.organizations.resources.eventThreatDetectionSettings.resources.customModules.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.eventThreatDetectionSettings.resources.customModules.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.eventThreatDetectionSettings.resources.customModules.methods.listDescendant.scopes (Total Keys: 1) - resources.organizations.resources.eventThreatDetectionSettings.resources.customModules.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.eventThreatDetectionSettings.resources.effectiveCustomModules.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.eventThreatDetectionSettings.resources.effectiveCustomModules.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.findings.methods.bulkMute.scopes (Total Keys: 1) - resources.organizations.resources.locations.resources.muteConfigs.methods.delete.scopes (Total Keys: 1) - resources.organizations.resources.locations.resources.muteConfigs.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.locations.resources.muteConfigs.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.muteConfigs.methods.create.scopes (Total Keys: 1) - resources.organizations.resources.muteConfigs.methods.delete.scopes (Total Keys: 1) - resources.organizations.resources.muteConfigs.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.muteConfigs.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.muteConfigs.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.notificationConfigs.methods.create.scopes (Total Keys: 1) - resources.organizations.resources.notificationConfigs.methods.delete.scopes (Total Keys: 1) - resources.organizations.resources.notificationConfigs.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.notificationConfigs.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.notificationConfigs.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.operations.methods.cancel.scopes (Total Keys: 1) - resources.organizations.resources.operations.methods.delete.scopes (Total Keys: 1) - resources.organizations.resources.operations.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.operations.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.resourceValueConfigs.methods.batchCreate.scopes (Total Keys: 1) - resources.organizations.resources.resourceValueConfigs.methods.delete.scopes (Total Keys: 1) - resources.organizations.resources.resourceValueConfigs.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.resourceValueConfigs.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.resourceValueConfigs.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.securityHealthAnalyticsSettings.resources.customModules.methods.create.scopes (Total Keys: 1) - resources.organizations.resources.securityHealthAnalyticsSettings.resources.customModules.methods.delete.scopes (Total Keys: 1) - resources.organizations.resources.securityHealthAnalyticsSettings.resources.customModules.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.securityHealthAnalyticsSettings.resources.customModules.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.securityHealthAnalyticsSettings.resources.customModules.methods.listDescendant.scopes (Total Keys: 1) - resources.organizations.resources.securityHealthAnalyticsSettings.resources.customModules.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.securityHealthAnalyticsSettings.resources.customModules.methods.simulate.scopes (Total Keys: 1) - resources.organizations.resources.securityHealthAnalyticsSettings.resources.effectiveCustomModules.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.securityHealthAnalyticsSettings.resources.effectiveCustomModules.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.simulations.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.simulations.resources.attackExposureResults.resources.attackPaths.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.simulations.resources.attackExposureResults.resources.valuedResources.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.simulations.resources.attackPaths.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.simulations.resources.valuedResources.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.simulations.resources.valuedResources.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.simulations.resources.valuedResources.resources.attackPaths.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.create.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.getIamPolicy.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.setIamPolicy.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.testIamPermissions.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.methods.create.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.methods.group.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.methods.setMute.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.methods.setState.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.methods.updateSecurityMarks.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.resources.externalSystems.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.valuedResources.methods.list.scopes (Total Keys: 1) - resources.projects.resources.assets.methods.group.scopes (Total Keys: 1) - resources.projects.resources.assets.methods.list.scopes (Total Keys: 1) - resources.projects.resources.assets.methods.updateSecurityMarks.scopes (Total Keys: 1) - resources.projects.resources.bigQueryExports.methods.create.scopes (Total Keys: 1) - resources.projects.resources.bigQueryExports.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.bigQueryExports.methods.get.scopes (Total Keys: 1) - resources.projects.resources.bigQueryExports.methods.list.scopes (Total Keys: 1) - resources.projects.resources.bigQueryExports.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.eventThreatDetectionSettings.methods.validateCustomModule.scopes (Total Keys: 1) - resources.projects.resources.eventThreatDetectionSettings.resources.customModules.methods.create.scopes (Total Keys: 1) - resources.projects.resources.eventThreatDetectionSettings.resources.customModules.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.eventThreatDetectionSettings.resources.customModules.methods.get.scopes (Total Keys: 1) - resources.projects.resources.eventThreatDetectionSettings.resources.customModules.methods.list.scopes (Total Keys: 1) - resources.projects.resources.eventThreatDetectionSettings.resources.customModules.methods.listDescendant.scopes (Total Keys: 1) - resources.projects.resources.eventThreatDetectionSettings.resources.customModules.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.eventThreatDetectionSettings.resources.effectiveCustomModules.methods.get.scopes (Total Keys: 1) - resources.projects.resources.eventThreatDetectionSettings.resources.effectiveCustomModules.methods.list.scopes (Total Keys: 1) - resources.projects.resources.findings.methods.bulkMute.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.muteConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.muteConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.muteConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.muteConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.muteConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.muteConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.muteConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.muteConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.notificationConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.notificationConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.notificationConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.notificationConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.notificationConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.securityHealthAnalyticsSettings.resources.customModules.methods.create.scopes (Total Keys: 1) - resources.projects.resources.securityHealthAnalyticsSettings.resources.customModules.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.securityHealthAnalyticsSettings.resources.customModules.methods.get.scopes (Total Keys: 1) - resources.projects.resources.securityHealthAnalyticsSettings.resources.customModules.methods.list.scopes (Total Keys: 1) - resources.projects.resources.securityHealthAnalyticsSettings.resources.customModules.methods.listDescendant.scopes (Total Keys: 1) - resources.projects.resources.securityHealthAnalyticsSettings.resources.customModules.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.securityHealthAnalyticsSettings.resources.customModules.methods.simulate.scopes (Total Keys: 1) - resources.projects.resources.securityHealthAnalyticsSettings.resources.effectiveCustomModules.methods.get.scopes (Total Keys: 1) - resources.projects.resources.securityHealthAnalyticsSettings.resources.effectiveCustomModules.methods.list.scopes (Total Keys: 1) - resources.projects.resources.sources.methods.list.scopes (Total Keys: 1) - resources.projects.resources.sources.resources.findings.methods.group.scopes (Total Keys: 1) - resources.projects.resources.sources.resources.findings.methods.list.scopes (Total Keys: 1) - resources.projects.resources.sources.resources.findings.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.sources.resources.findings.methods.setMute.scopes (Total Keys: 1) - resources.projects.resources.sources.resources.findings.methods.setState.scopes (Total Keys: 1) - resources.projects.resources.sources.resources.findings.methods.updateSecurityMarks.scopes (Total Keys: 1) - resources.projects.resources.sources.resources.findings.resources.externalSystems.methods.patch.scopes (Total Keys: 1) #### securitycenter:v1beta1 The following keys were added: - schemas.Agent (Total Keys: 15) - schemas.DetectorReference (Total Keys: 7) - schemas.Finding.properties.agent (Total Keys: 4) - schemas.GoogleCloudSecuritycenterV2Agent (Total Keys: 15) - schemas.GoogleCloudSecuritycenterV2DetectorReference (Total Keys: 7) - schemas.GoogleCloudSecuritycenterV2Finding.properties.agent (Total Keys: 4) - schemas.GoogleCloudSecuritycenterV2InvocationReference (Total Keys: 3) - schemas.InvocationReference (Total Keys: 3) The following keys were changed: - resources.organizations.methods.getOrganizationSettings.scopes (Total Keys: 1) - resources.organizations.methods.updateOrganizationSettings.scopes (Total Keys: 1) - resources.organizations.resources.assets.methods.group.scopes (Total Keys: 1) - resources.organizations.resources.assets.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.assets.methods.runDiscovery.scopes (Total Keys: 1) - resources.organizations.resources.assets.methods.updateSecurityMarks.scopes (Total Keys: 1) - resources.organizations.resources.operations.methods.cancel.scopes (Total Keys: 1) - resources.organizations.resources.operations.methods.delete.scopes (Total Keys: 1) - resources.organizations.resources.operations.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.operations.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.create.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.getIamPolicy.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.setIamPolicy.scopes (Total Keys: 1) - resources.organizations.resources.sources.methods.testIamPermissions.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.methods.create.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.methods.group.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.methods.setState.scopes (Total Keys: 1) - resources.organizations.resources.sources.resources.findings.methods.updateSecurityMarks.scopes (Total Keys: 1) #### securitycenter:v1beta2 The following keys were added: - schemas.Agent (Total Keys: 15) - schemas.DetectorReference (Total Keys: 7) - schemas.Finding.properties.agent (Total Keys: 4) - schemas.GoogleCloudSecuritycenterV2Agent (Total Keys: 15) - schemas.GoogleCloudSecuritycenterV2DetectorReference (Total Keys: 7) - schemas.GoogleCloudSecuritycenterV2Finding.properties.agent (Total Keys: 4) - schemas.GoogleCloudSecuritycenterV2InvocationReference (Total Keys: 3) - schemas.InvocationReference (Total Keys: 3) The following keys were changed: - resources.folders.methods.getContainerThreatDetectionSettings.scopes (Total Keys: 1) - resources.folders.methods.getEventThreatDetectionSettings.scopes (Total Keys: 1) - resources.folders.methods.getRapidVulnerabilityDetectionSettings.scopes (Total Keys: 1) - resources.folders.methods.getSecurityCenterSettings.scopes (Total Keys: 1) - resources.folders.methods.getSecurityHealthAnalyticsSettings.scopes (Total Keys: 1) - resources.folders.methods.getVirtualMachineThreatDetectionSettings.scopes (Total Keys: 1) - resources.folders.methods.getWebSecurityScannerSettings.scopes (Total Keys: 1) - resources.folders.methods.updateContainerThreatDetectionSettings.scopes (Total Keys: 1) - resources.folders.methods.updateEventThreatDetectionSettings.scopes (Total Keys: 1) - resources.folders.methods.updateRapidVulnerabilityDetectionSettings.scopes (Total Keys: 1) - resources.folders.methods.updateSecurityHealthAnalyticsSettings.scopes (Total Keys: 1) - resources.folders.methods.updateVirtualMachineThreatDetectionSettings.scopes (Total Keys: 1) - resources.folders.methods.updateWebSecurityScannerSettings.scopes (Total Keys: 1) - resources.folders.resources.containerThreatDetectionSettings.methods.calculate.scopes (Total Keys: 1) - resources.folders.resources.eventThreatDetectionSettings.methods.calculate.scopes (Total Keys: 1) - resources.folders.resources.rapidVulnerabilityDetectionSettings.methods.calculate.scopes (Total Keys: 1) - resources.folders.resources.securityHealthAnalyticsSettings.methods.calculate.scopes (Total Keys: 1) - resources.folders.resources.virtualMachineThreatDetectionSettings.methods.calculate.scopes (Total Keys: 1) - resources.folders.resources.webSecurityScannerSettings.methods.calculate.scopes (Total Keys: 1) - resources.organizations.methods.getContainerThreatDetectionSettings.scopes (Total Keys: 1) - resources.organizations.methods.getEventThreatDetectionSettings.scopes (Total Keys: 1) - resources.organizations.methods.getRapidVulnerabilityDetectionSettings.scopes (Total Keys: 1) - resources.organizations.methods.getSecurityCenterSettings.scopes (Total Keys: 1) - resources.organizations.methods.getSecurityHealthAnalyticsSettings.scopes (Total Keys: 1) - resources.organizations.methods.getSubscription.scopes (Total Keys: 1) - resources.organizations.methods.getVirtualMachineThreatDetectionSettings.scopes (Total Keys: 1) - resources.organizations.methods.getWebSecurityScannerSettings.scopes (Total Keys: 1) - resources.organizations.methods.updateContainerThreatDetectionSettings.scopes (Total Keys: 1) - resources.organizations.methods.updateEventThreatDetectionSettings.scopes (Total Keys: 1) - resources.organizations.methods.updateRapidVulnerabilityDetectionSettings.scopes (Total Keys: 1) - resources.organizations.methods.updateSecurityHealthAnalyticsSettings.scopes (Total Keys: 1) - resources.organizations.methods.updateVirtualMachineThreatDetectionSettings.scopes (Total Keys: 1) - resources.organizations.methods.updateWebSecurityScannerSettings.scopes (Total Keys: 1) - resources.organizations.resources.containerThreatDetectionSettings.methods.calculate.scopes (Total Keys: 1) - resources.organizations.resources.eventThreatDetectionSettings.methods.calculate.scopes (Total Keys: 1) - resources.organizations.resources.rapidVulnerabilityDetectionSettings.methods.calculate.scopes (Total Keys: 1) - resources.organizations.resources.securityHealthAnalyticsSettings.methods.calculate.scopes (Total Keys: 1) - resources.organizations.resources.virtualMachineThreatDetectionSettings.methods.calculate.scopes (Total Keys: 1) - resources.organizations.resources.webSecurityScannerSettings.methods.calculate.scopes (Total Keys: 1) - resources.projects.methods.getContainerThreatDetectionSettings.scopes (Total Keys: 1) - resources.projects.methods.getEventThreatDetectionSettings.scopes (Total Keys: 1) - resources.projects.methods.getRapidVulnerabilityDetectionSettings.scopes (Total Keys: 1) - resources.projects.methods.getSecurityCenterSettings.scopes (Total Keys: 1) - resources.projects.methods.getSecurityHealthAnalyticsSettings.scopes (Total Keys: 1) - resources.projects.methods.getVirtualMachineThreatDetectionSettings.scopes (Total Keys: 1) - resources.projects.methods.getWebSecurityScannerSettings.scopes (Total Keys: 1) - resources.projects.methods.updateContainerThreatDetectionSettings.scopes (Total Keys: 1) - resources.projects.methods.updateEventThreatDetectionSettings.scopes (Total Keys: 1) - resources.projects.methods.updateRapidVulnerabilityDetectionSettings.scopes (Total Keys: 1) - resources.projects.methods.updateSecurityHealthAnalyticsSettings.scopes (Total Keys: 1) - resources.projects.methods.updateVirtualMachineThreatDetectionSettings.scopes (Total Keys: 1) - resources.projects.methods.updateWebSecurityScannerSettings.scopes (Total Keys: 1) - resources.projects.resources.containerThreatDetectionSettings.methods.calculate.scopes (Total Keys: 1) - resources.projects.resources.eventThreatDetectionSettings.methods.calculate.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.clusters.methods.getContainerThreatDetectionSettings.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.clusters.methods.updateContainerThreatDetectionSettings.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.clusters.resources.containerThreatDetectionSettings.methods.calculate.scopes (Total Keys: 1) - resources.projects.resources.rapidVulnerabilityDetectionSettings.methods.calculate.scopes (Total Keys: 1) - resources.projects.resources.securityHealthAnalyticsSettings.methods.calculate.scopes (Total Keys: 1) - resources.projects.resources.virtualMachineThreatDetectionSettings.methods.calculate.scopes (Total Keys: 1) - resources.projects.resources.webSecurityScannerSettings.methods.calculate.scopes (Total Keys: 1) --- ...HealthAnalyticsSettings.customModules.html | 26 + ...itycenter_v1.folders.sources.findings.html | 130 ++++ ...HealthAnalyticsSettings.customModules.html | 26 + ...ter_v1.organizations.sources.findings.html | 182 +++++ ...HealthAnalyticsSettings.customModules.html | 26 + ...tycenter_v1.projects.sources.findings.html | 130 ++++ .../documents/securitycenter.v1.json | 719 +++++++++++++----- .../documents/securitycenter.v1beta1.json | 272 ++++++- .../documents/securitycenter.v1beta2.json | 386 ++++++++-- 9 files changed, 1638 insertions(+), 259 deletions(-) diff --git a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html index ed8f61f21c..0e79083cc9 100644 --- a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html @@ -646,6 +646,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -654,6 +675,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html index 0a3f4e5549..9698e22d73 100644 --- a/docs/dyn/securitycenter_v1.folders.sources.findings.html +++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html @@ -215,6 +215,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -223,6 +244,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -1186,6 +1212,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -1194,6 +1241,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -2013,6 +2065,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -2021,6 +2094,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -2853,6 +2931,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -2861,6 +2960,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -3694,6 +3798,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -3702,6 +3827,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", diff --git a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html index 583de6a854..a098473664 100644 --- a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html @@ -646,6 +646,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -654,6 +675,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html index 92be448b99..86af3b7c3b 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html @@ -148,6 +148,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -156,6 +177,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -975,6 +1001,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -983,6 +1030,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -1873,6 +1925,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -1881,6 +1954,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -2844,6 +2922,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -2852,6 +2951,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -3671,6 +3775,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -3679,6 +3804,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -4511,6 +4641,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -4519,6 +4670,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -5352,6 +5508,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -5360,6 +5537,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", diff --git a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html index a80a8ec971..7b61ba5457 100644 --- a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html @@ -646,6 +646,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -654,6 +675,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html index aff796c84f..324b9b2f66 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.findings.html +++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html @@ -215,6 +215,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -223,6 +244,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -1186,6 +1212,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -1194,6 +1241,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -2013,6 +2065,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -2021,6 +2094,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -2853,6 +2931,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -2861,6 +2960,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", @@ -3694,6 +3798,27 @@

Method Details

"affectedResources": { "count": "A String", }, + "agent": { + "displayName": "A String", + "id": "A String", + }, + "agentAnomaly": { + "confidenceScore": 3.14, + "detectorReferences": [ + { + "detectorId": "A String", + "displayName": "A String", + "explanation": "A String", + "recommendation": "A String", + "severity": "A String", + }, + ], + "invocationReferences": [ + { + "invocationId": "A String", + }, + ], + }, "agentDataAccessEvents": [ { "eventId": "A String", @@ -3702,6 +3827,11 @@

Method Details

"principalSubject": "A String", }, ], + "agentSessions": [ + { + "sessionId": "A String", + }, + ], "aiModel": { "deploymentPlatform": "A String", "displayName": "A String", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index fd656cabba..75d5eb0099 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -4,6 +4,9 @@ "scopes": { "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." +}, +"https://www.googleapis.com/auth/securitycenter": { +"description": "See, edit, configure, and delete your Google Cloud Security Command Center data and see the email address for your Google Account" } } } @@ -151,7 +154,8 @@ "$ref": "GroupAssetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -208,7 +212,8 @@ "$ref": "ListAssetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateSecurityMarks": { @@ -245,7 +250,8 @@ "$ref": "SecurityMarks" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -280,7 +286,8 @@ "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -304,7 +311,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -328,7 +336,8 @@ "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -361,7 +370,8 @@ "$ref": "ListBigQueryExportsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -393,7 +403,8 @@ "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -424,7 +435,8 @@ "$ref": "ValidateEventThreatDetectionCustomModuleResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -455,7 +467,8 @@ "$ref": "EventThreatDetectionCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -479,7 +492,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -503,7 +517,8 @@ "$ref": "EventThreatDetectionCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -536,7 +551,8 @@ "$ref": "ListEventThreatDetectionCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "listDescendant": { @@ -569,7 +585,8 @@ "$ref": "ListDescendantEventThreatDetectionCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -601,7 +618,8 @@ "$ref": "EventThreatDetectionCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -629,7 +647,8 @@ "$ref": "EffectiveEventThreatDetectionCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -662,7 +681,8 @@ "$ref": "ListEffectiveEventThreatDetectionCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -695,7 +715,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -725,7 +746,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -749,7 +771,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -781,7 +804,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -818,7 +842,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -842,7 +867,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -866,7 +892,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -899,7 +926,8 @@ "$ref": "ListMuteConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -931,7 +959,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -966,7 +995,8 @@ "$ref": "NotificationConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -990,7 +1020,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -1014,7 +1045,8 @@ "$ref": "NotificationConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -1047,7 +1079,8 @@ "$ref": "ListNotificationConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -1079,7 +1112,8 @@ "$ref": "NotificationConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1112,7 +1146,8 @@ "$ref": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -1136,7 +1171,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -1160,7 +1196,8 @@ "$ref": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -1193,7 +1230,8 @@ "$ref": "ListSecurityHealthAnalyticsCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "listDescendant": { @@ -1226,7 +1264,8 @@ "$ref": "ListDescendantSecurityHealthAnalyticsCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -1258,7 +1297,8 @@ "$ref": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "simulate": { @@ -1285,7 +1325,8 @@ "$ref": "SimulateSecurityHealthAnalyticsCustomModuleResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1313,7 +1354,8 @@ "$ref": "GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -1346,7 +1388,8 @@ "$ref": "ListEffectiveSecurityHealthAnalyticsCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1385,7 +1428,8 @@ "$ref": "ListSourcesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -1416,7 +1460,8 @@ "$ref": "GroupFindingsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -1474,7 +1519,8 @@ "$ref": "ListFindingsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -1506,7 +1552,8 @@ "$ref": "Finding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "setMute": { @@ -1533,7 +1580,8 @@ "$ref": "Finding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "setState": { @@ -1560,7 +1608,8 @@ "$ref": "Finding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateSecurityMarks": { @@ -1597,7 +1646,8 @@ "$ref": "SecurityMarks" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -1633,7 +1683,8 @@ "$ref": "GoogleCloudSecuritycenterV1ExternalSystem" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1667,7 +1718,8 @@ "$ref": "OrganizationSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateOrganizationSettings": { @@ -1700,7 +1752,8 @@ "$ref": "OrganizationSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -1732,7 +1785,8 @@ "$ref": "GroupAssetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -1789,7 +1843,8 @@ "$ref": "ListAssetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "runDiscovery": { @@ -1817,7 +1872,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateSecurityMarks": { @@ -1854,7 +1910,8 @@ "$ref": "SecurityMarks" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1895,7 +1952,8 @@ "$ref": "ListAttackPathsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1930,7 +1988,8 @@ "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -1954,7 +2013,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -1978,7 +2038,8 @@ "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -2011,7 +2072,8 @@ "$ref": "ListBigQueryExportsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -2043,7 +2105,8 @@ "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -2074,7 +2137,8 @@ "$ref": "ValidateEventThreatDetectionCustomModuleResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -2105,7 +2169,8 @@ "$ref": "EventThreatDetectionCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -2129,7 +2194,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -2153,7 +2219,8 @@ "$ref": "EventThreatDetectionCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -2186,7 +2253,8 @@ "$ref": "ListEventThreatDetectionCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "listDescendant": { @@ -2219,7 +2287,8 @@ "$ref": "ListDescendantEventThreatDetectionCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -2251,7 +2320,8 @@ "$ref": "EventThreatDetectionCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -2279,7 +2349,8 @@ "$ref": "EffectiveEventThreatDetectionCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -2312,7 +2383,8 @@ "$ref": "ListEffectiveEventThreatDetectionCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -2345,7 +2417,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -2375,7 +2448,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -2399,7 +2473,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -2431,7 +2506,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -2468,7 +2544,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -2492,7 +2569,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -2516,7 +2594,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -2549,7 +2628,8 @@ "$ref": "ListMuteConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -2581,7 +2661,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -2616,7 +2697,8 @@ "$ref": "NotificationConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -2640,7 +2722,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -2664,7 +2747,8 @@ "$ref": "NotificationConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -2697,7 +2781,8 @@ "$ref": "ListNotificationConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -2729,7 +2814,8 @@ "$ref": "NotificationConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -2757,7 +2843,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -2781,7 +2868,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -2805,7 +2893,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -2846,7 +2935,8 @@ "$ref": "ListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -2877,7 +2967,8 @@ "$ref": "BatchCreateResourceValueConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -2901,7 +2992,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -2925,7 +3017,8 @@ "$ref": "GoogleCloudSecuritycenterV1ResourceValueConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -2958,7 +3051,8 @@ "$ref": "ListResourceValueConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -2990,7 +3084,8 @@ "$ref": "GoogleCloudSecuritycenterV1ResourceValueConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -3023,7 +3118,8 @@ "$ref": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -3047,7 +3143,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -3071,7 +3168,8 @@ "$ref": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -3104,7 +3202,8 @@ "$ref": "ListSecurityHealthAnalyticsCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "listDescendant": { @@ -3137,7 +3236,8 @@ "$ref": "ListDescendantSecurityHealthAnalyticsCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -3169,7 +3269,8 @@ "$ref": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "simulate": { @@ -3196,7 +3297,8 @@ "$ref": "SimulateSecurityHealthAnalyticsCustomModuleResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -3224,7 +3326,8 @@ "$ref": "GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -3257,7 +3360,8 @@ "$ref": "ListEffectiveSecurityHealthAnalyticsCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -3287,7 +3391,8 @@ "$ref": "Simulation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -3330,7 +3435,8 @@ "$ref": "ListAttackPathsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -3375,7 +3481,8 @@ "$ref": "ListValuedResourcesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -3418,7 +3525,8 @@ "$ref": "ListAttackPathsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -3446,7 +3554,8 @@ "$ref": "ValuedResource" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -3487,7 +3596,8 @@ "$ref": "ListValuedResourcesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -3528,7 +3638,8 @@ "$ref": "ListAttackPathsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -3563,7 +3674,8 @@ "$ref": "Source" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -3587,7 +3699,8 @@ "$ref": "Source" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getIamPolicy": { @@ -3614,7 +3727,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -3647,7 +3761,8 @@ "$ref": "ListSourcesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -3679,7 +3794,8 @@ "$ref": "Source" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "setIamPolicy": { @@ -3706,7 +3822,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "testIamPermissions": { @@ -3733,7 +3850,8 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -3768,7 +3886,8 @@ "$ref": "Finding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "group": { @@ -3795,7 +3914,8 @@ "$ref": "GroupFindingsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -3853,7 +3973,8 @@ "$ref": "ListFindingsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -3885,7 +4006,8 @@ "$ref": "Finding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "setMute": { @@ -3912,7 +4034,8 @@ "$ref": "Finding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "setState": { @@ -3939,7 +4062,8 @@ "$ref": "Finding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateSecurityMarks": { @@ -3976,7 +4100,8 @@ "$ref": "SecurityMarks" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -4012,7 +4137,8 @@ "$ref": "GoogleCloudSecuritycenterV1ExternalSystem" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -4061,7 +4187,8 @@ "$ref": "ListValuedResourcesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -4097,7 +4224,8 @@ "$ref": "GroupAssetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -4154,7 +4282,8 @@ "$ref": "ListAssetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateSecurityMarks": { @@ -4191,7 +4320,8 @@ "$ref": "SecurityMarks" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -4226,7 +4356,8 @@ "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -4250,7 +4381,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -4274,7 +4406,8 @@ "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -4307,7 +4440,8 @@ "$ref": "ListBigQueryExportsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -4339,7 +4473,8 @@ "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -4370,7 +4505,8 @@ "$ref": "ValidateEventThreatDetectionCustomModuleResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -4401,7 +4537,8 @@ "$ref": "EventThreatDetectionCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -4425,7 +4562,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -4449,7 +4587,8 @@ "$ref": "EventThreatDetectionCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -4482,7 +4621,8 @@ "$ref": "ListEventThreatDetectionCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "listDescendant": { @@ -4515,7 +4655,8 @@ "$ref": "ListDescendantEventThreatDetectionCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -4547,7 +4688,8 @@ "$ref": "EventThreatDetectionCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -4575,7 +4717,8 @@ "$ref": "EffectiveEventThreatDetectionCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -4608,7 +4751,8 @@ "$ref": "ListEffectiveEventThreatDetectionCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -4641,7 +4785,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -4671,7 +4816,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -4695,7 +4841,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -4727,7 +4874,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -4764,7 +4912,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -4788,7 +4937,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -4812,7 +4962,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -4845,7 +4996,8 @@ "$ref": "ListMuteConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -4877,7 +5029,8 @@ "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -4912,7 +5065,8 @@ "$ref": "NotificationConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -4936,7 +5090,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -4960,7 +5115,8 @@ "$ref": "NotificationConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -4993,7 +5149,8 @@ "$ref": "ListNotificationConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -5025,7 +5182,8 @@ "$ref": "NotificationConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -5058,7 +5216,8 @@ "$ref": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -5082,7 +5241,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -5106,7 +5266,8 @@ "$ref": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -5139,7 +5300,8 @@ "$ref": "ListSecurityHealthAnalyticsCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "listDescendant": { @@ -5172,7 +5334,8 @@ "$ref": "ListDescendantSecurityHealthAnalyticsCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -5204,7 +5367,8 @@ "$ref": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "simulate": { @@ -5231,7 +5395,8 @@ "$ref": "SimulateSecurityHealthAnalyticsCustomModuleResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -5259,7 +5424,8 @@ "$ref": "GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -5292,7 +5458,8 @@ "$ref": "ListEffectiveSecurityHealthAnalyticsCustomModulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -5331,7 +5498,8 @@ "$ref": "ListSourcesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -5362,7 +5530,8 @@ "$ref": "GroupFindingsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -5420,7 +5589,8 @@ "$ref": "ListFindingsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -5452,7 +5622,8 @@ "$ref": "Finding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "setMute": { @@ -5479,7 +5650,8 @@ "$ref": "Finding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "setState": { @@ -5506,7 +5678,8 @@ "$ref": "Finding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateSecurityMarks": { @@ -5543,7 +5716,8 @@ "$ref": "SecurityMarks" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -5579,7 +5753,8 @@ "$ref": "GoogleCloudSecuritycenterV1ExternalSystem" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -5591,7 +5766,7 @@ } } }, -"revision": "20260619", +"revision": "20260724", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -5713,6 +5888,40 @@ }, "type": "object" }, +"Agent": { +"id": "Agent", +"properties": { +"displayName": { +"type": "string" +}, +"id": { +"type": "string" +} +}, +"type": "object" +}, +"AgentAnomaly": { +"id": "AgentAnomaly", +"properties": { +"confidenceScore": { +"format": "double", +"type": "number" +}, +"detectorReferences": { +"items": { +"$ref": "DetectorReference" +}, +"type": "array" +}, +"invocationReferences": { +"items": { +"$ref": "InvocationReference" +}, +"type": "array" +} +}, +"type": "object" +}, "AgentDataAccessEvent": { "id": "AgentDataAccessEvent", "properties": { @@ -5744,6 +5953,15 @@ }, "type": "object" }, +"AgentSession": { +"id": "AgentSession", +"properties": { +"sessionId": { +"type": "string" +} +}, +"type": "object" +}, "AiModel": { "id": "AiModel", "properties": { @@ -7071,6 +7289,41 @@ false }, "type": "object" }, +"DetectorReference": { +"id": "DetectorReference", +"properties": { +"detectorId": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"explanation": { +"type": "string" +}, +"recommendation": { +"type": "string" +}, +"severity": { +"enum": [ +"SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, "DiscoveredWorkload": { "id": "DiscoveredWorkload", "properties": { @@ -7518,12 +7771,24 @@ false "affectedResources": { "$ref": "AffectedResources" }, +"agent": { +"$ref": "Agent" +}, +"agentAnomaly": { +"$ref": "AgentAnomaly" +}, "agentDataAccessEvents": { "items": { "$ref": "AgentDataAccessEvent" }, "type": "array" }, +"agentSessions": { +"items": { +"$ref": "AgentSession" +}, +"type": "array" +}, "aiModel": { "$ref": "AiModel" }, @@ -8979,6 +9244,40 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2Agent": { +"id": "GoogleCloudSecuritycenterV2Agent", +"properties": { +"displayName": { +"type": "string" +}, +"id": { +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2AgentAnomaly": { +"id": "GoogleCloudSecuritycenterV2AgentAnomaly", +"properties": { +"confidenceScore": { +"format": "double", +"type": "number" +}, +"detectorReferences": { +"items": { +"$ref": "GoogleCloudSecuritycenterV2DetectorReference" +}, +"type": "array" +}, +"invocationReferences": { +"items": { +"$ref": "GoogleCloudSecuritycenterV2InvocationReference" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2AgentDataAccessEvent": { "id": "GoogleCloudSecuritycenterV2AgentDataAccessEvent", "properties": { @@ -9010,6 +9309,15 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2AgentSession": { +"id": "GoogleCloudSecuritycenterV2AgentSession", +"properties": { +"sessionId": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2AiModel": { "id": "GoogleCloudSecuritycenterV2AiModel", "properties": { @@ -10076,6 +10384,41 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2DetectorReference": { +"id": "GoogleCloudSecuritycenterV2DetectorReference", +"properties": { +"detectorId": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"explanation": { +"type": "string" +}, +"recommendation": { +"type": "string" +}, +"severity": { +"enum": [ +"SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2DiscoveredWorkload": { "id": "GoogleCloudSecuritycenterV2DiscoveredWorkload", "properties": { @@ -10401,12 +10744,24 @@ false "affectedResources": { "$ref": "GoogleCloudSecuritycenterV2AffectedResources" }, +"agent": { +"$ref": "GoogleCloudSecuritycenterV2Agent" +}, +"agentAnomaly": { +"$ref": "GoogleCloudSecuritycenterV2AgentAnomaly" +}, "agentDataAccessEvents": { "items": { "$ref": "GoogleCloudSecuritycenterV2AgentDataAccessEvent" }, "type": "array" }, +"agentSessions": { +"items": { +"$ref": "GoogleCloudSecuritycenterV2AgentSession" +}, +"type": "array" +}, "aiModel": { "$ref": "GoogleCloudSecuritycenterV2AiModel" }, @@ -10941,6 +11296,15 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2InvocationReference": { +"id": "GoogleCloudSecuritycenterV2InvocationReference", +"properties": { +"invocationId": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2IpRule": { "id": "GoogleCloudSecuritycenterV2IpRule", "properties": { @@ -13590,6 +13954,15 @@ false }, "type": "object" }, +"InvocationReference": { +"id": "InvocationReference", +"properties": { +"invocationId": { +"type": "string" +} +}, +"type": "object" +}, "IpRule": { "id": "IpRule", "properties": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index e4a55a41c2..6557392dc5 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -4,6 +4,9 @@ "scopes": { "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." +}, +"https://www.googleapis.com/auth/securitycenter": { +"description": "See, edit, configure, and delete your Google Cloud Security Command Center data and see the email address for your Google Account" } } } @@ -145,7 +148,8 @@ "$ref": "OrganizationSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateOrganizationSettings": { @@ -178,7 +182,8 @@ "$ref": "OrganizationSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -209,7 +214,8 @@ "$ref": "GroupAssetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -265,7 +271,8 @@ "$ref": "ListAssetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "runDiscovery": { @@ -292,7 +299,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateSecurityMarks": { @@ -329,7 +337,8 @@ "$ref": "GoogleCloudSecuritycenterV1beta1SecurityMarks" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -360,7 +369,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "delete": { @@ -384,7 +394,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -408,7 +419,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -449,7 +461,8 @@ "$ref": "ListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -480,7 +493,8 @@ "$ref": "Source" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "get": { @@ -504,7 +518,8 @@ "$ref": "Source" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getIamPolicy": { @@ -531,7 +546,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -564,7 +580,8 @@ "$ref": "ListSourcesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -596,7 +613,8 @@ "$ref": "Source" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "setIamPolicy": { @@ -623,7 +641,8 @@ "$ref": "Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "testIamPermissions": { @@ -650,7 +669,8 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -685,7 +705,8 @@ "$ref": "GoogleCloudSecuritycenterV1beta1Finding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "group": { @@ -712,7 +733,8 @@ "$ref": "GroupFindingsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "list": { @@ -763,7 +785,8 @@ "$ref": "ListFindingsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "patch": { @@ -795,7 +818,8 @@ "$ref": "GoogleCloudSecuritycenterV1beta1Finding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "setState": { @@ -822,7 +846,8 @@ "$ref": "GoogleCloudSecuritycenterV1beta1Finding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateSecurityMarks": { @@ -859,7 +884,8 @@ "$ref": "GoogleCloudSecuritycenterV1beta1SecurityMarks" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -869,7 +895,7 @@ } } }, -"revision": "20260619", +"revision": "20260724", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -991,6 +1017,40 @@ }, "type": "object" }, +"Agent": { +"id": "Agent", +"properties": { +"displayName": { +"type": "string" +}, +"id": { +"type": "string" +} +}, +"type": "object" +}, +"AgentAnomaly": { +"id": "AgentAnomaly", +"properties": { +"confidenceScore": { +"format": "double", +"type": "number" +}, +"detectorReferences": { +"items": { +"$ref": "DetectorReference" +}, +"type": "array" +}, +"invocationReferences": { +"items": { +"$ref": "InvocationReference" +}, +"type": "array" +} +}, +"type": "object" +}, "AgentDataAccessEvent": { "id": "AgentDataAccessEvent", "properties": { @@ -1022,6 +1082,15 @@ }, "type": "object" }, +"AgentSession": { +"id": "AgentSession", +"properties": { +"sessionId": { +"type": "string" +} +}, +"type": "object" +}, "AiModel": { "id": "AiModel", "properties": { @@ -2149,6 +2218,41 @@ false }, "type": "object" }, +"DetectorReference": { +"id": "DetectorReference", +"properties": { +"detectorId": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"explanation": { +"type": "string" +}, +"recommendation": { +"type": "string" +}, +"severity": { +"enum": [ +"SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, "DiscoveredWorkload": { "id": "DiscoveredWorkload", "properties": { @@ -2469,12 +2573,24 @@ false "affectedResources": { "$ref": "AffectedResources" }, +"agent": { +"$ref": "Agent" +}, +"agentAnomaly": { +"$ref": "AgentAnomaly" +}, "agentDataAccessEvents": { "items": { "$ref": "AgentDataAccessEvent" }, "type": "array" }, +"agentSessions": { +"items": { +"$ref": "AgentSession" +}, +"type": "array" +}, "aiModel": { "$ref": "AiModel" }, @@ -3997,6 +4113,40 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2Agent": { +"id": "GoogleCloudSecuritycenterV2Agent", +"properties": { +"displayName": { +"type": "string" +}, +"id": { +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2AgentAnomaly": { +"id": "GoogleCloudSecuritycenterV2AgentAnomaly", +"properties": { +"confidenceScore": { +"format": "double", +"type": "number" +}, +"detectorReferences": { +"items": { +"$ref": "GoogleCloudSecuritycenterV2DetectorReference" +}, +"type": "array" +}, +"invocationReferences": { +"items": { +"$ref": "GoogleCloudSecuritycenterV2InvocationReference" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2AgentDataAccessEvent": { "id": "GoogleCloudSecuritycenterV2AgentDataAccessEvent", "properties": { @@ -4028,6 +4178,15 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2AgentSession": { +"id": "GoogleCloudSecuritycenterV2AgentSession", +"properties": { +"sessionId": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2AiModel": { "id": "GoogleCloudSecuritycenterV2AiModel", "properties": { @@ -5094,6 +5253,41 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2DetectorReference": { +"id": "GoogleCloudSecuritycenterV2DetectorReference", +"properties": { +"detectorId": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"explanation": { +"type": "string" +}, +"recommendation": { +"type": "string" +}, +"severity": { +"enum": [ +"SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2DiscoveredWorkload": { "id": "GoogleCloudSecuritycenterV2DiscoveredWorkload", "properties": { @@ -5419,12 +5613,24 @@ false "affectedResources": { "$ref": "GoogleCloudSecuritycenterV2AffectedResources" }, +"agent": { +"$ref": "GoogleCloudSecuritycenterV2Agent" +}, +"agentAnomaly": { +"$ref": "GoogleCloudSecuritycenterV2AgentAnomaly" +}, "agentDataAccessEvents": { "items": { "$ref": "GoogleCloudSecuritycenterV2AgentDataAccessEvent" }, "type": "array" }, +"agentSessions": { +"items": { +"$ref": "GoogleCloudSecuritycenterV2AgentSession" +}, +"type": "array" +}, "aiModel": { "$ref": "GoogleCloudSecuritycenterV2AiModel" }, @@ -5959,6 +6165,15 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2InvocationReference": { +"id": "GoogleCloudSecuritycenterV2InvocationReference", +"properties": { +"invocationId": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2IpRule": { "id": "GoogleCloudSecuritycenterV2IpRule", "properties": { @@ -8585,6 +8800,15 @@ false }, "type": "object" }, +"InvocationReference": { +"id": "InvocationReference", +"properties": { +"invocationId": { +"type": "string" +} +}, +"type": "object" +}, "IpRule": { "id": "IpRule", "properties": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index e762dc619c..c5e8c0a29f 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -4,6 +4,9 @@ "scopes": { "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." +}, +"https://www.googleapis.com/auth/securitycenter": { +"description": "See, edit, configure, and delete your Google Cloud Security Command Center data and see the email address for your Google Account" } } } @@ -145,7 +148,8 @@ "$ref": "ContainerThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getEventThreatDetectionSettings": { @@ -169,7 +173,8 @@ "$ref": "EventThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getRapidVulnerabilityDetectionSettings": { @@ -193,7 +198,8 @@ "$ref": "RapidVulnerabilityDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getSecurityCenterSettings": { @@ -217,7 +223,8 @@ "$ref": "SecurityCenterSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getSecurityHealthAnalyticsSettings": { @@ -241,7 +248,8 @@ "$ref": "SecurityHealthAnalyticsSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getVirtualMachineThreatDetectionSettings": { @@ -265,7 +273,8 @@ "$ref": "VirtualMachineThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getWebSecurityScannerSettings": { @@ -289,7 +298,8 @@ "$ref": "WebSecurityScannerSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateContainerThreatDetectionSettings": { @@ -321,7 +331,8 @@ "$ref": "ContainerThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateEventThreatDetectionSettings": { @@ -353,7 +364,8 @@ "$ref": "EventThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateRapidVulnerabilityDetectionSettings": { @@ -385,7 +397,8 @@ "$ref": "RapidVulnerabilityDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateSecurityHealthAnalyticsSettings": { @@ -417,7 +430,8 @@ "$ref": "SecurityHealthAnalyticsSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateVirtualMachineThreatDetectionSettings": { @@ -449,7 +463,8 @@ "$ref": "VirtualMachineThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateWebSecurityScannerSettings": { @@ -481,7 +496,8 @@ "$ref": "WebSecurityScannerSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -513,7 +529,8 @@ "$ref": "ContainerThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -545,7 +562,8 @@ "$ref": "EventThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -573,7 +591,8 @@ "$ref": "RapidVulnerabilityDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -605,7 +624,8 @@ "$ref": "SecurityHealthAnalyticsSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -637,7 +657,8 @@ "$ref": "VirtualMachineThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -669,7 +690,8 @@ "$ref": "WebSecurityScannerSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -699,7 +721,8 @@ "$ref": "ContainerThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getEventThreatDetectionSettings": { @@ -723,7 +746,8 @@ "$ref": "EventThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getRapidVulnerabilityDetectionSettings": { @@ -747,7 +771,8 @@ "$ref": "RapidVulnerabilityDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getSecurityCenterSettings": { @@ -771,7 +796,8 @@ "$ref": "SecurityCenterSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getSecurityHealthAnalyticsSettings": { @@ -795,7 +821,8 @@ "$ref": "SecurityHealthAnalyticsSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getSubscription": { @@ -819,7 +846,8 @@ "$ref": "Subscription" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getVirtualMachineThreatDetectionSettings": { @@ -843,7 +871,8 @@ "$ref": "VirtualMachineThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getWebSecurityScannerSettings": { @@ -867,7 +896,8 @@ "$ref": "WebSecurityScannerSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateContainerThreatDetectionSettings": { @@ -899,7 +929,8 @@ "$ref": "ContainerThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateEventThreatDetectionSettings": { @@ -931,7 +962,8 @@ "$ref": "EventThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateRapidVulnerabilityDetectionSettings": { @@ -963,7 +995,8 @@ "$ref": "RapidVulnerabilityDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateSecurityHealthAnalyticsSettings": { @@ -995,7 +1028,8 @@ "$ref": "SecurityHealthAnalyticsSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateVirtualMachineThreatDetectionSettings": { @@ -1027,7 +1061,8 @@ "$ref": "VirtualMachineThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateWebSecurityScannerSettings": { @@ -1059,7 +1094,8 @@ "$ref": "WebSecurityScannerSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -1091,7 +1127,8 @@ "$ref": "ContainerThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1123,7 +1160,8 @@ "$ref": "EventThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1151,7 +1189,8 @@ "$ref": "RapidVulnerabilityDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1183,7 +1222,8 @@ "$ref": "SecurityHealthAnalyticsSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1215,7 +1255,8 @@ "$ref": "VirtualMachineThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1247,7 +1288,8 @@ "$ref": "WebSecurityScannerSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1277,7 +1319,8 @@ "$ref": "ContainerThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getEventThreatDetectionSettings": { @@ -1301,7 +1344,8 @@ "$ref": "EventThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getRapidVulnerabilityDetectionSettings": { @@ -1325,7 +1369,8 @@ "$ref": "RapidVulnerabilityDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getSecurityCenterSettings": { @@ -1349,7 +1394,8 @@ "$ref": "SecurityCenterSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getSecurityHealthAnalyticsSettings": { @@ -1373,7 +1419,8 @@ "$ref": "SecurityHealthAnalyticsSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getVirtualMachineThreatDetectionSettings": { @@ -1397,7 +1444,8 @@ "$ref": "VirtualMachineThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "getWebSecurityScannerSettings": { @@ -1421,7 +1469,8 @@ "$ref": "WebSecurityScannerSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateContainerThreatDetectionSettings": { @@ -1453,7 +1502,8 @@ "$ref": "ContainerThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateEventThreatDetectionSettings": { @@ -1485,7 +1535,8 @@ "$ref": "EventThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateRapidVulnerabilityDetectionSettings": { @@ -1517,7 +1568,8 @@ "$ref": "RapidVulnerabilityDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateSecurityHealthAnalyticsSettings": { @@ -1549,7 +1601,8 @@ "$ref": "SecurityHealthAnalyticsSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateVirtualMachineThreatDetectionSettings": { @@ -1581,7 +1634,8 @@ "$ref": "VirtualMachineThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateWebSecurityScannerSettings": { @@ -1613,7 +1667,8 @@ "$ref": "WebSecurityScannerSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -1645,7 +1700,8 @@ "$ref": "ContainerThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1677,7 +1733,8 @@ "$ref": "EventThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1707,7 +1764,8 @@ "$ref": "ContainerThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] }, "updateContainerThreatDetectionSettings": { @@ -1739,7 +1797,8 @@ "$ref": "ContainerThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } }, @@ -1771,7 +1830,8 @@ "$ref": "ContainerThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1803,7 +1863,8 @@ "$ref": "RapidVulnerabilityDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1835,7 +1896,8 @@ "$ref": "SecurityHealthAnalyticsSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1867,7 +1929,8 @@ "$ref": "VirtualMachineThreatDetectionSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1899,7 +1962,8 @@ "$ref": "WebSecurityScannerSettings" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/securitycenter" ] } } @@ -1907,7 +1971,7 @@ } } }, -"revision": "20260619", +"revision": "20260724", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2029,6 +2093,40 @@ }, "type": "object" }, +"Agent": { +"id": "Agent", +"properties": { +"displayName": { +"type": "string" +}, +"id": { +"type": "string" +} +}, +"type": "object" +}, +"AgentAnomaly": { +"id": "AgentAnomaly", +"properties": { +"confidenceScore": { +"format": "double", +"type": "number" +}, +"detectorReferences": { +"items": { +"$ref": "DetectorReference" +}, +"type": "array" +}, +"invocationReferences": { +"items": { +"$ref": "InvocationReference" +}, +"type": "array" +} +}, +"type": "object" +}, "AgentDataAccessEvent": { "id": "AgentDataAccessEvent", "properties": { @@ -2060,6 +2158,15 @@ }, "type": "object" }, +"AgentSession": { +"id": "AgentSession", +"properties": { +"sessionId": { +"type": "string" +} +}, +"type": "object" +}, "AiModel": { "id": "AiModel", "properties": { @@ -3174,6 +3281,41 @@ false }, "type": "object" }, +"DetectorReference": { +"id": "DetectorReference", +"properties": { +"detectorId": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"explanation": { +"type": "string" +}, +"recommendation": { +"type": "string" +}, +"severity": { +"enum": [ +"SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, "DiscoveredWorkload": { "id": "DiscoveredWorkload", "properties": { @@ -3524,12 +3666,24 @@ false "affectedResources": { "$ref": "AffectedResources" }, +"agent": { +"$ref": "Agent" +}, +"agentAnomaly": { +"$ref": "AgentAnomaly" +}, "agentDataAccessEvents": { "items": { "$ref": "AgentDataAccessEvent" }, "type": "array" }, +"agentSessions": { +"items": { +"$ref": "AgentSession" +}, +"type": "array" +}, "aiModel": { "$ref": "AiModel" }, @@ -4966,6 +5120,40 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2Agent": { +"id": "GoogleCloudSecuritycenterV2Agent", +"properties": { +"displayName": { +"type": "string" +}, +"id": { +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2AgentAnomaly": { +"id": "GoogleCloudSecuritycenterV2AgentAnomaly", +"properties": { +"confidenceScore": { +"format": "double", +"type": "number" +}, +"detectorReferences": { +"items": { +"$ref": "GoogleCloudSecuritycenterV2DetectorReference" +}, +"type": "array" +}, +"invocationReferences": { +"items": { +"$ref": "GoogleCloudSecuritycenterV2InvocationReference" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2AgentDataAccessEvent": { "id": "GoogleCloudSecuritycenterV2AgentDataAccessEvent", "properties": { @@ -4997,6 +5185,15 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2AgentSession": { +"id": "GoogleCloudSecuritycenterV2AgentSession", +"properties": { +"sessionId": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2AiModel": { "id": "GoogleCloudSecuritycenterV2AiModel", "properties": { @@ -6063,6 +6260,41 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2DetectorReference": { +"id": "GoogleCloudSecuritycenterV2DetectorReference", +"properties": { +"detectorId": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"explanation": { +"type": "string" +}, +"recommendation": { +"type": "string" +}, +"severity": { +"enum": [ +"SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2DiscoveredWorkload": { "id": "GoogleCloudSecuritycenterV2DiscoveredWorkload", "properties": { @@ -6388,12 +6620,24 @@ false "affectedResources": { "$ref": "GoogleCloudSecuritycenterV2AffectedResources" }, +"agent": { +"$ref": "GoogleCloudSecuritycenterV2Agent" +}, +"agentAnomaly": { +"$ref": "GoogleCloudSecuritycenterV2AgentAnomaly" +}, "agentDataAccessEvents": { "items": { "$ref": "GoogleCloudSecuritycenterV2AgentDataAccessEvent" }, "type": "array" }, +"agentSessions": { +"items": { +"$ref": "GoogleCloudSecuritycenterV2AgentSession" +}, +"type": "array" +}, "aiModel": { "$ref": "GoogleCloudSecuritycenterV2AiModel" }, @@ -6928,6 +7172,15 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2InvocationReference": { +"id": "GoogleCloudSecuritycenterV2InvocationReference", +"properties": { +"invocationId": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2IpRule": { "id": "GoogleCloudSecuritycenterV2IpRule", "properties": { @@ -9450,6 +9703,15 @@ false }, "type": "object" }, +"InvocationReference": { +"id": "InvocationReference", +"properties": { +"invocationId": { +"type": "string" +} +}, +"type": "object" +}, "IpRule": { "id": "IpRule", "properties": { From ff8e9d6caa8b6043aeb01c69670b9e12be605ba2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:15 +0000 Subject: [PATCH 76/84] feat(serviceconsumermanagement): update the api #### serviceconsumermanagement:v1 The following keys were added: - schemas.MetricRule.properties.agenticMetricCosts (Total Keys: 3) - schemas.MetricRule.properties.nonagenticMetricCosts (Total Keys: 3) - schemas.QuotaLimit.properties.trafficSource.type (Total Keys: 1) - schemas.TenantResource.properties.sourceTenantProject (Total Keys: 2) --- ...serviceconsumermanagement_v1.services.html | 1 + ...ermanagement_v1.services.tenancyUnits.html | 2 + .../serviceconsumermanagement.v1.json | 37 ++++++++++++++++++- 3 files changed, 39 insertions(+), 1 deletion(-) diff --git a/docs/dyn/serviceconsumermanagement_v1.services.html b/docs/dyn/serviceconsumermanagement_v1.services.html index 36dc1e7568..a08fa6cafa 100644 --- a/docs/dyn/serviceconsumermanagement_v1.services.html +++ b/docs/dyn/serviceconsumermanagement_v1.services.html @@ -123,6 +123,7 @@

Method Details

{ # Resource constituting the TenancyUnit. "migratedTenantProject": "A String", # Output only. The newly created regional resource name of the tenant project that has been migrated from a global service. This field is only set for migrated tenant projects. Format: `services//{collection_id}/{RESOURCE_ID}/locations/{LOCATION}/tenantProjects/{TENANT_ID}`. "resource": "A String", # Output only. @OutputOnly Identifier of the tenant resource. For cloud projects, it is in the form 'projects/{number}'. For example 'projects/123456'. + "sourceTenantProject": "A String", # Output only. The resource name of the tenant project from which this active regional tenant project was migrated. This field is only set for active regional migrated mapping tenant projects. Format: `services//{collection_id}/{RESOURCE_ID}/locations/{LOCATION}/tenantProjects/{TENANT_ID}`. "status": "A String", # Status of tenant resource. "tag": "A String", # Unique per single tenancy unit. }, diff --git a/docs/dyn/serviceconsumermanagement_v1.services.tenancyUnits.html b/docs/dyn/serviceconsumermanagement_v1.services.tenancyUnits.html index 3b5cc1f19d..dbd7d68e06 100644 --- a/docs/dyn/serviceconsumermanagement_v1.services.tenancyUnits.html +++ b/docs/dyn/serviceconsumermanagement_v1.services.tenancyUnits.html @@ -327,6 +327,7 @@

Method Details

{ # Resource constituting the TenancyUnit. "migratedTenantProject": "A String", # Output only. The newly created regional resource name of the tenant project that has been migrated from a global service. This field is only set for migrated tenant projects. Format: `services//{collection_id}/{RESOURCE_ID}/locations/{LOCATION}/tenantProjects/{TENANT_ID}`. "resource": "A String", # Output only. @OutputOnly Identifier of the tenant resource. For cloud projects, it is in the form 'projects/{number}'. For example 'projects/123456'. + "sourceTenantProject": "A String", # Output only. The resource name of the tenant project from which this active regional tenant project was migrated. This field is only set for active regional migrated mapping tenant projects. Format: `services//{collection_id}/{RESOURCE_ID}/locations/{LOCATION}/tenantProjects/{TENANT_ID}`. "status": "A String", # Status of tenant resource. "tag": "A String", # Unique per single tenancy unit. }, @@ -440,6 +441,7 @@

Method Details

{ # Resource constituting the TenancyUnit. "migratedTenantProject": "A String", # Output only. The newly created regional resource name of the tenant project that has been migrated from a global service. This field is only set for migrated tenant projects. Format: `services//{collection_id}/{RESOURCE_ID}/locations/{LOCATION}/tenantProjects/{TENANT_ID}`. "resource": "A String", # Output only. @OutputOnly Identifier of the tenant resource. For cloud projects, it is in the form 'projects/{number}'. For example 'projects/123456'. + "sourceTenantProject": "A String", # Output only. The resource name of the tenant project from which this active regional tenant project was migrated. This field is only set for active regional migrated mapping tenant projects. Format: `services//{collection_id}/{RESOURCE_ID}/locations/{LOCATION}/tenantProjects/{TENANT_ID}`. "status": "A String", # Status of tenant resource. "tag": "A String", # Unique per single tenancy unit. }, diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index d4de0ab504..f80c581037 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -547,7 +547,7 @@ } } }, -"revision": "20260423", +"revision": "20260721", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -2211,6 +2211,14 @@ "description": "Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.", "id": "MetricRule", "properties": { +"agenticMetricCosts": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.", +"type": "object" +}, "metricCosts": { "additionalProperties": { "format": "int64", @@ -2219,6 +2227,14 @@ "description": "Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.", "type": "object" }, +"nonagenticMetricCosts": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is not an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.", +"type": "object" +}, "selector": { "description": "Selects the methods to which this rule applies. Refer to selector for syntax details.", "type": "string" @@ -2622,6 +2638,20 @@ "description": "Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.", "type": "string" }, +"trafficSource": { +"description": "Optional. This is only informational, the logic to allocate the quota to the correct metric (such as in `metric_rules`) should identify which quota metrics to allocate to.", +"enum": [ +"TRAFFIC_SOURCE_UNSPECIFIED", +"TRAFFIC_SOURCE_NONAGENTIC", +"TRAFFIC_SOURCE_AGENTIC" +], +"enumDescriptions": [ +"This quota limit applies to all traffic. This is the default value.", +"This quota limit applies to traffic not recognized as agentic.", +"This quota limit applies to only agentic traffic." +], +"type": "string" +}, "unit": { "description": "Specify the unit of the quota limit. It uses the same syntax as MetricDescriptor.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * \"1/min/{project}\" for quota per minute per project. Note: the order of unit components is insignificant. The \"1\" at the beginning is required to follow the metric unit syntax.", "type": "string" @@ -3070,6 +3100,11 @@ "readOnly": true, "type": "string" }, +"sourceTenantProject": { +"description": "Output only. The resource name of the tenant project from which this active regional tenant project was migrated. This field is only set for active regional migrated mapping tenant projects. Format: `services//{collection_id}/{RESOURCE_ID}/locations/{LOCATION}/tenantProjects/{TENANT_ID}`.", +"readOnly": true, +"type": "string" +}, "status": { "description": "Status of tenant resource.", "enum": [ From 4bcec95d99a8b0c92898f4526f9889fa733fd174 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:16 +0000 Subject: [PATCH 77/84] feat(servicedirectory): update the api #### servicedirectory:v1 The following keys were added: - endpoints (Total Keys: 1) #### servicedirectory:v1beta1 The following keys were added: - endpoints (Total Keys: 1) --- .../documents/servicedirectory.v1.json | 214 +++++++++++++++++- .../documents/servicedirectory.v1beta1.json | 214 +++++++++++++++++- 2 files changed, 426 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json index d2c249cbac..bf13593653 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json @@ -15,6 +15,218 @@ "description": "Service Directory is a platform for discovering, publishing, and connecting services. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/service-directory", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-west4.rep.googleapis.com/", +"location": "us-west4" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -889,7 +1101,7 @@ } } }, -"revision": "20260526", +"revision": "20260724", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json index 2cf235255a..bfaaa0cbe7 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json @@ -15,6 +15,218 @@ "description": "Service Directory is a platform for discovering, publishing, and connecting services. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/service-directory", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://servicedirectory.us-west4.rep.googleapis.com/", +"location": "us-west4" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -977,7 +1189,7 @@ } } }, -"revision": "20260526", +"revision": "20260724", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { From 799ac7d50fd50013d99dfecc6f681c1225492c2a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:17 +0000 Subject: [PATCH 78/84] feat(serviceusage): update the api #### serviceusage:v1 The following keys were deleted: - schemas.Analysis.properties.analysis (Total Keys: 2) - schemas.ConsumerPolicy.properties.annotations (Total Keys: 2) - schemas.EnableRule.properties.groups (Total Keys: 3) - schemas.EnableRule.properties.services.deprecated (Total Keys: 1) - schemas.Impact.properties.parent.type (Total Keys: 1) The following keys were added: - schemas.Analysis.properties.analysis (Total Keys: 2) - schemas.ConsumerPolicy.properties.createTime (Total Keys: 3) - schemas.ConsumerPolicy.properties.updateTime.readOnly (Total Keys: 1) - schemas.EnableRule.properties.values.deprecated (Total Keys: 1) - schemas.GoogleApiServiceusageV2alphaAnalysis (Total Keys: 15) - schemas.GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyMetadata (Total Keys: 2) - schemas.GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyResponse (Total Keys: 4) - schemas.GoogleApiServiceusageV2alphaImpact (Total Keys: 7) - schemas.Impact.properties.missingDependency (Total Keys: 2) - schemas.MetricRule.properties.agenticMetricCosts (Total Keys: 3) - schemas.MetricRule.properties.nonagenticMetricCosts (Total Keys: 3) - schemas.QuotaLimit.properties.trafficSource.type (Total Keys: 1) #### serviceusage:v1beta1 The following keys were deleted: - schemas.Analysis.properties.analysis (Total Keys: 2) - schemas.ConsumerPolicy.properties.annotations (Total Keys: 2) - schemas.EnableRule.properties.groups (Total Keys: 3) - schemas.EnableRule.properties.services.deprecated (Total Keys: 1) - schemas.Impact.properties.parent.type (Total Keys: 1) The following keys were added: - schemas.Analysis.properties.analysis (Total Keys: 2) - schemas.ConsumerPolicy.properties.createTime (Total Keys: 3) - schemas.ConsumerPolicy.properties.updateTime.readOnly (Total Keys: 1) - schemas.EnableRule.properties.values.deprecated (Total Keys: 1) - schemas.GoogleApiServiceusageV2alphaAnalysis (Total Keys: 15) - schemas.GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyMetadata (Total Keys: 2) - schemas.GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyResponse (Total Keys: 4) - schemas.GoogleApiServiceusageV2alphaImpact (Total Keys: 7) - schemas.Impact.properties.missingDependency (Total Keys: 2) - schemas.MetricRule.properties.agenticMetricCosts (Total Keys: 3) - schemas.MetricRule.properties.nonagenticMetricCosts (Total Keys: 3) - schemas.QuotaLimit.properties.trafficSource.type (Total Keys: 1) --- docs/dyn/serviceusage_v1.services.html | 21 ++ docs/dyn/serviceusage_v1beta1.services.html | 14 ++ .../documents/serviceusage.v1.json | 195 +++++++++++++++--- .../documents/serviceusage.v1beta1.json | 195 +++++++++++++++--- 4 files changed, 359 insertions(+), 66 deletions(-) diff --git a/docs/dyn/serviceusage_v1.services.html b/docs/dyn/serviceusage_v1.services.html index 393cd5fd53..cf95654bb9 100644 --- a/docs/dyn/serviceusage_v1.services.html +++ b/docs/dyn/serviceusage_v1.services.html @@ -329,6 +329,7 @@

Method Details

"maxLimit": "A String", # Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. "metric": "A String", # The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. "name": "A String", # Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. + "trafficSource": "A String", # Optional. This is only informational, the logic to allocate the quota to the correct metric (such as in `metric_rules`) should identify which quota metrics to allocate to. "unit": "A String", # Specify the unit of the quota limit. It uses the same syntax as MetricDescriptor.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. "values": { # Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. "a_key": "A String", @@ -337,9 +338,15 @@

Method Details

], "metricRules": [ # List of MetricRule definitions, each one mapping a selected method to one or more metrics. { # Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. + "agenticMetricCosts": { # Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. + "a_key": "A String", + }, "metricCosts": { # Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. "a_key": "A String", }, + "nonagenticMetricCosts": { # Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is not an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. + "a_key": "A String", + }, "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, ], @@ -639,6 +646,7 @@

Method Details

"maxLimit": "A String", # Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. "metric": "A String", # The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. "name": "A String", # Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. + "trafficSource": "A String", # Optional. This is only informational, the logic to allocate the quota to the correct metric (such as in `metric_rules`) should identify which quota metrics to allocate to. "unit": "A String", # Specify the unit of the quota limit. It uses the same syntax as MetricDescriptor.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. "values": { # Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. "a_key": "A String", @@ -647,9 +655,15 @@

Method Details

], "metricRules": [ # List of MetricRule definitions, each one mapping a selected method to one or more metrics. { # Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. + "agenticMetricCosts": { # Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. + "a_key": "A String", + }, "metricCosts": { # Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. "a_key": "A String", }, + "nonagenticMetricCosts": { # Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is not an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. + "a_key": "A String", + }, "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, ], @@ -864,6 +878,7 @@

Method Details

"maxLimit": "A String", # Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. "metric": "A String", # The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. "name": "A String", # Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. + "trafficSource": "A String", # Optional. This is only informational, the logic to allocate the quota to the correct metric (such as in `metric_rules`) should identify which quota metrics to allocate to. "unit": "A String", # Specify the unit of the quota limit. It uses the same syntax as MetricDescriptor.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. "values": { # Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. "a_key": "A String", @@ -872,9 +887,15 @@

Method Details

], "metricRules": [ # List of MetricRule definitions, each one mapping a selected method to one or more metrics. { # Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. + "agenticMetricCosts": { # Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. + "a_key": "A String", + }, "metricCosts": { # Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. "a_key": "A String", }, + "nonagenticMetricCosts": { # Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is not an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. + "a_key": "A String", + }, "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, ], diff --git a/docs/dyn/serviceusage_v1beta1.services.html b/docs/dyn/serviceusage_v1beta1.services.html index 3cad9cb2c0..07e792c866 100644 --- a/docs/dyn/serviceusage_v1beta1.services.html +++ b/docs/dyn/serviceusage_v1beta1.services.html @@ -453,6 +453,7 @@

Method Details

"maxLimit": "A String", # Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. "metric": "A String", # The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. "name": "A String", # Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. + "trafficSource": "A String", # Optional. This is only informational, the logic to allocate the quota to the correct metric (such as in `metric_rules`) should identify which quota metrics to allocate to. "unit": "A String", # Specify the unit of the quota limit. It uses the same syntax as MetricDescriptor.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. "values": { # Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. "a_key": "A String", @@ -461,9 +462,15 @@

Method Details

], "metricRules": [ # List of MetricRule definitions, each one mapping a selected method to one or more metrics. { # Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. + "agenticMetricCosts": { # Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. + "a_key": "A String", + }, "metricCosts": { # Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. "a_key": "A String", }, + "nonagenticMetricCosts": { # Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is not an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. + "a_key": "A String", + }, "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, ], @@ -678,6 +685,7 @@

Method Details

"maxLimit": "A String", # Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. "metric": "A String", # The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. "name": "A String", # Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. + "trafficSource": "A String", # Optional. This is only informational, the logic to allocate the quota to the correct metric (such as in `metric_rules`) should identify which quota metrics to allocate to. "unit": "A String", # Specify the unit of the quota limit. It uses the same syntax as MetricDescriptor.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. "values": { # Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported. "a_key": "A String", @@ -686,9 +694,15 @@

Method Details

], "metricRules": [ # List of MetricRule definitions, each one mapping a selected method to one or more metrics. { # Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. + "agenticMetricCosts": { # Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. + "a_key": "A String", + }, "metricCosts": { # Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. "a_key": "A String", }, + "nonagenticMetricCosts": { # Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is not an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. + "a_key": "A String", + }, "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, ], diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index 9b9a1fd180..d6b0d4cf0d 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -431,7 +431,7 @@ } } }, -"revision": "20260423", +"revision": "20260721", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -497,7 +497,7 @@ "description": "A message to group the analysis information.", "id": "Analysis", "properties": { -"analysis": { +"analysisResult": { "$ref": "AnalysisResult", "description": "Output only. Analysis result of updating a policy.", "readOnly": true @@ -507,14 +507,12 @@ "enum": [ "ANALYSIS_TYPE_UNSPECIFIED", "ANALYSIS_TYPE_DEPENDENCY", -"ANALYSIS_TYPE_RESOURCE_USAGE", -"ANALYSIS_TYPE_RESOURCE_EXISTENCE" +"ANALYSIS_TYPE_RESOURCE_USAGE" ], "enumDescriptions": [ "Unspecified analysis type. Do not use.", "The analysis of service dependencies.", -"The analysis of service resource usage.", -"The analysis of service resource existence." +"The analysis of service resource usage." ], "readOnly": true, "type": "string" @@ -1171,15 +1169,14 @@ "description": "Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.", "id": "ConsumerPolicy", "properties": { -"annotations": { -"additionalProperties": { +"createTime": { +"description": "Output only. The time the policy was created. For singleton policies, this is the first touch of the policy.", +"format": "google-datetime", +"readOnly": true, "type": "string" }, -"description": "Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations)", -"type": "object" -}, "enableRules": { -"description": "Enable rules define usable services and service groups.", +"description": "Enable rules define usable services and groups. There can currently be at most one `EnableRule`. This restriction will be lifted in later releases.", "items": { "$ref": "EnableRule" }, @@ -1190,13 +1187,14 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the policy. We only allow consumer policy name as `default` for now: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`.", +"description": "Output only. The resource name of the policy. Only the `default` policy is supported: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`.", "readOnly": true, "type": "string" }, "updateTime": { -"description": "The last-modified time.", +"description": "Output only. The time the policy was last updated.", "format": "google-datetime", +"readOnly": true, "type": "string" } }, @@ -1563,7 +1561,7 @@ "type": "object" }, "EnableRule": { -"description": "The consumer policy rule that defines usable services and service groups.", +"description": "The consumer policy rule that defines enabled services and groups.", "id": "EnableRule", "properties": { "enableType": { @@ -1582,24 +1580,16 @@ ], "type": "string" }, -"groups": { -"deprecated": true, -"description": "DEPRECATED: Please use field `values`. Service group should have prefix `groups/`. The names of the service groups that are enabled (Not Implemented). Example: `groups/googleServices`.", -"items": { -"type": "string" -}, -"type": "array" -}, "services": { -"deprecated": true, -"description": "DEPRECATED: Please use field `values`. Service should have prefix `services/`. The names of the services that are enabled. Example: `storage.googleapis.com`.", +"description": "The names of the services that are enabled. Example: `services/storage.googleapis.com`.", "items": { "type": "string" }, "type": "array" }, "values": { -"description": "The names of the services or service groups that are enabled. Example: `services/storage.googleapis.com`, `groups/googleServices`, `groups/allServices`.", +"deprecated": true, +"description": "Deprecated: Use the `services` field instead. The names of the services or service groups that are enabled. Example: `services/storage.googleapis.com`, `groups/googleServices`, `groups/allServices`.", "items": { "type": "string" }, @@ -2204,6 +2194,85 @@ }, "type": "object" }, +"GoogleApiServiceusageV2alphaAnalysis": { +"description": "A message to group the analysis information.", +"id": "GoogleApiServiceusageV2alphaAnalysis", +"properties": { +"analysisResult": { +"$ref": "GoogleApiServiceusageV2alphaAnalysisResult", +"description": "Output only. Analysis result of updating a policy.", +"readOnly": true +}, +"analysisType": { +"description": "Output only. The type of analysis.", +"enum": [ +"ANALYSIS_TYPE_UNSPECIFIED", +"ANALYSIS_TYPE_DEPENDENCY", +"ANALYSIS_TYPE_RESOURCE_USAGE", +"ANALYSIS_TYPE_RESOURCE_EXISTENCE" +], +"enumDescriptions": [ +"Unspecified analysis type. Do not use.", +"The analysis of service dependencies.", +"The analysis of service resource usage.", +"The analysis of service resource existence." +], +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The user friendly display name of the analysis type. E.g. service dependency analysis, service resource usage analysis, etc.", +"readOnly": true, +"type": "string" +}, +"service": { +"description": "The names of the service that has analysis result of warnings or blockers. Example: `services/storage.googleapis.com`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleApiServiceusageV2alphaAnalysisResult": { +"description": "An analysis result including blockers and warnings.", +"id": "GoogleApiServiceusageV2alphaAnalysisResult", +"properties": { +"blockers": { +"description": "Blocking information that would prevent the policy changes at runtime.", +"items": { +"$ref": "GoogleApiServiceusageV2alphaImpact" +}, +"type": "array" +}, +"warnings": { +"description": "Warning information indicating that the policy changes might be unsafe, but will not block the changes at runtime.", +"items": { +"$ref": "GoogleApiServiceusageV2alphaImpact" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyMetadata": { +"description": "Metadata for the `AnalyzeConsumerPolicy` method.", +"id": "GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyMetadata", +"properties": {}, +"type": "object" +}, +"GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyResponse": { +"description": "The response of analyzing a consumer policy update.", +"id": "GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyResponse", +"properties": { +"analysis": { +"description": "The list of analyses returned from performing the intended policy update analysis. The analysis is grouped by service name and different analysis types. The empty analysis list means that the consumer policy can be updated without any warnings or blockers.", +"items": { +"$ref": "GoogleApiServiceusageV2alphaAnalysis" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleApiServiceusageV2alphaConsumerPolicy": { "description": "Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.", "id": "GoogleApiServiceusageV2alphaConsumerPolicy", @@ -2261,6 +2330,37 @@ }, "type": "object" }, +"GoogleApiServiceusageV2alphaImpact": { +"description": "A message to group impacts of updating a policy.", +"id": "GoogleApiServiceusageV2alphaImpact", +"properties": { +"detail": { +"description": "Output only. User friendly impact detail in a free form message.", +"readOnly": true, +"type": "string" +}, +"impactType": { +"description": "Output only. The type of impact.", +"enum": [ +"IMPACT_TYPE_UNSPECIFIED", +"DEPENDENCY_MISSING_DEPENDENCIES", +"RESOURCE_EXISTENCE_PROJECT" +], +"enumDescriptions": [ +"Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 Block 0 - Special/Admin codes Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of ANALYSIS_TYPE_RESOURCE_USAGE Block 3 - Impact Type of ANALYSIS_TYPE_RESOURCE_EXISTENCE ...", +"Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY", +"Block 3 - Impact Type of ANALYSIS_TYPE_RESOURCE_EXISTENCE" +], +"readOnly": true, +"type": "string" +}, +"parent": { +"description": "The parent resource that the analysis is based on and the service name that the analysis is for. Example: `projects/100/services/compute.googleapis.com`, folders/101/services/compute.googleapis.com` and `organizations/102/services/compute.googleapis.com`. Usually, the parent resource here is same as the parent resource of the analyzed policy. However, for some analysis types, the parent can be different. For example, for resource existence analysis, if the parent resource of the analyzed policy is a folder or an organization, the parent resource here can still be the project that contains the resources.", +"type": "string" +} +}, +"type": "object" +}, "GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata": { "description": "Metadata for the `UpdateConsumerPolicy` method.", "id": "GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata", @@ -2576,19 +2676,18 @@ "description": "Output only. The type of impact.", "enum": [ "IMPACT_TYPE_UNSPECIFIED", -"DEPENDENCY_MISSING_DEPENDENCIES", -"RESOURCE_EXISTENCE_PROJECT" +"DEPENDENCY_MISSING_DEPENDENCIES" ], "enumDescriptions": [ -"Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 Block 0 - Special/Admin codes Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of ANALYSIS_TYPE_RESOURCE_USAGE Block 3 - Impact Type of ANALYSIS_TYPE_RESOURCE_EXISTENCE ...", -"Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY", -"Block 3 - Impact Type of ANALYSIS_TYPE_RESOURCE_EXISTENCE" +"Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 Block 0 - Special/Admin codes Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of ANALYSIS_TYPE_RESOURCE_USAGE ...", +"Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY" ], "readOnly": true, "type": "string" }, -"parent": { -"description": "The parent resource that the analysis is based on and the service name that the analysis is for. Example: `projects/100/services/compute.googleapis.com`, folders/101/services/compute.googleapis.com` and `organizations/102/services/compute.googleapis.com`. Usually, the parent resource here is same as the parent resource of the analyzed policy. However, for some analysis types, the parent can be different. For example, for resource existence analysis, if the parent resource of the analyzed policy is a folder or an organization, the parent resource here can still be the project that contains the resources.", +"missingDependency": { +"description": "Output only. This field will be populated only for the `DEPENDENCY_MISSING_DEPENDENCIES` impact type. Example: `services/compute.googleapis.com`. Impact.detail will be in format : `missing service dependency: {missing_dependency}.`", +"readOnly": true, "type": "string" } }, @@ -3133,6 +3232,14 @@ "description": "Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.", "id": "MetricRule", "properties": { +"agenticMetricCosts": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.", +"type": "object" +}, "metricCosts": { "additionalProperties": { "format": "int64", @@ -3141,6 +3248,14 @@ "description": "Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.", "type": "object" }, +"nonagenticMetricCosts": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is not an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.", +"type": "object" +}, "selector": { "description": "Selects the methods to which this rule applies. Refer to selector for syntax details.", "type": "string" @@ -3540,6 +3655,20 @@ "description": "Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.", "type": "string" }, +"trafficSource": { +"description": "Optional. This is only informational, the logic to allocate the quota to the correct metric (such as in `metric_rules`) should identify which quota metrics to allocate to.", +"enum": [ +"TRAFFIC_SOURCE_UNSPECIFIED", +"TRAFFIC_SOURCE_NONAGENTIC", +"TRAFFIC_SOURCE_AGENTIC" +], +"enumDescriptions": [ +"This quota limit applies to all traffic. This is the default value.", +"This quota limit applies to traffic not recognized as agentic.", +"This quota limit applies to only agentic traffic." +], +"type": "string" +}, "unit": { "description": "Specify the unit of the quota limit. It uses the same syntax as MetricDescriptor.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * \"1/min/{project}\" for quota per minute per project. Note: the order of unit components is insignificant. The \"1\" at the beginning is required to follow the metric unit syntax.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index 4ef1a8d805..a7b383d494 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -969,7 +969,7 @@ } } }, -"revision": "20260423", +"revision": "20260721", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1035,7 +1035,7 @@ "description": "A message to group the analysis information.", "id": "Analysis", "properties": { -"analysis": { +"analysisResult": { "$ref": "AnalysisResult", "description": "Output only. Analysis result of updating a policy.", "readOnly": true @@ -1045,14 +1045,12 @@ "enum": [ "ANALYSIS_TYPE_UNSPECIFIED", "ANALYSIS_TYPE_DEPENDENCY", -"ANALYSIS_TYPE_RESOURCE_USAGE", -"ANALYSIS_TYPE_RESOURCE_EXISTENCE" +"ANALYSIS_TYPE_RESOURCE_USAGE" ], "enumDescriptions": [ "Unspecified analysis type. Do not use.", "The analysis of service dependencies.", -"The analysis of service resource usage.", -"The analysis of service resource existence." +"The analysis of service resource usage." ], "readOnly": true, "type": "string" @@ -1689,15 +1687,14 @@ "description": "Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.", "id": "ConsumerPolicy", "properties": { -"annotations": { -"additionalProperties": { +"createTime": { +"description": "Output only. The time the policy was created. For singleton policies, this is the first touch of the policy.", +"format": "google-datetime", +"readOnly": true, "type": "string" }, -"description": "Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations)", -"type": "object" -}, "enableRules": { -"description": "Enable rules define usable services and service groups.", +"description": "Enable rules define usable services and groups. There can currently be at most one `EnableRule`. This restriction will be lifted in later releases.", "items": { "$ref": "EnableRule" }, @@ -1708,13 +1705,14 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the policy. We only allow consumer policy name as `default` for now: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`.", +"description": "Output only. The resource name of the policy. Only the `default` policy is supported: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`.", "readOnly": true, "type": "string" }, "updateTime": { -"description": "The last-modified time.", +"description": "Output only. The time the policy was last updated.", "format": "google-datetime", +"readOnly": true, "type": "string" } }, @@ -2140,7 +2138,7 @@ "type": "object" }, "EnableRule": { -"description": "The consumer policy rule that defines usable services and service groups.", +"description": "The consumer policy rule that defines enabled services and groups.", "id": "EnableRule", "properties": { "enableType": { @@ -2159,24 +2157,16 @@ ], "type": "string" }, -"groups": { -"deprecated": true, -"description": "DEPRECATED: Please use field `values`. Service group should have prefix `groups/`. The names of the service groups that are enabled (Not Implemented). Example: `groups/googleServices`.", -"items": { -"type": "string" -}, -"type": "array" -}, "services": { -"deprecated": true, -"description": "DEPRECATED: Please use field `values`. Service should have prefix `services/`. The names of the services that are enabled. Example: `storage.googleapis.com`.", +"description": "The names of the services that are enabled. Example: `services/storage.googleapis.com`.", "items": { "type": "string" }, "type": "array" }, "values": { -"description": "The names of the services or service groups that are enabled. Example: `services/storage.googleapis.com`, `groups/googleServices`, `groups/allServices`.", +"deprecated": true, +"description": "Deprecated: Use the `services` field instead. The names of the services or service groups that are enabled. Example: `services/storage.googleapis.com`, `groups/googleServices`, `groups/allServices`.", "items": { "type": "string" }, @@ -2781,6 +2771,85 @@ }, "type": "object" }, +"GoogleApiServiceusageV2alphaAnalysis": { +"description": "A message to group the analysis information.", +"id": "GoogleApiServiceusageV2alphaAnalysis", +"properties": { +"analysisResult": { +"$ref": "GoogleApiServiceusageV2alphaAnalysisResult", +"description": "Output only. Analysis result of updating a policy.", +"readOnly": true +}, +"analysisType": { +"description": "Output only. The type of analysis.", +"enum": [ +"ANALYSIS_TYPE_UNSPECIFIED", +"ANALYSIS_TYPE_DEPENDENCY", +"ANALYSIS_TYPE_RESOURCE_USAGE", +"ANALYSIS_TYPE_RESOURCE_EXISTENCE" +], +"enumDescriptions": [ +"Unspecified analysis type. Do not use.", +"The analysis of service dependencies.", +"The analysis of service resource usage.", +"The analysis of service resource existence." +], +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The user friendly display name of the analysis type. E.g. service dependency analysis, service resource usage analysis, etc.", +"readOnly": true, +"type": "string" +}, +"service": { +"description": "The names of the service that has analysis result of warnings or blockers. Example: `services/storage.googleapis.com`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleApiServiceusageV2alphaAnalysisResult": { +"description": "An analysis result including blockers and warnings.", +"id": "GoogleApiServiceusageV2alphaAnalysisResult", +"properties": { +"blockers": { +"description": "Blocking information that would prevent the policy changes at runtime.", +"items": { +"$ref": "GoogleApiServiceusageV2alphaImpact" +}, +"type": "array" +}, +"warnings": { +"description": "Warning information indicating that the policy changes might be unsafe, but will not block the changes at runtime.", +"items": { +"$ref": "GoogleApiServiceusageV2alphaImpact" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyMetadata": { +"description": "Metadata for the `AnalyzeConsumerPolicy` method.", +"id": "GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyMetadata", +"properties": {}, +"type": "object" +}, +"GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyResponse": { +"description": "The response of analyzing a consumer policy update.", +"id": "GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyResponse", +"properties": { +"analysis": { +"description": "The list of analyses returned from performing the intended policy update analysis. The analysis is grouped by service name and different analysis types. The empty analysis list means that the consumer policy can be updated without any warnings or blockers.", +"items": { +"$ref": "GoogleApiServiceusageV2alphaAnalysis" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleApiServiceusageV2alphaConsumerPolicy": { "description": "Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.", "id": "GoogleApiServiceusageV2alphaConsumerPolicy", @@ -2838,6 +2907,37 @@ }, "type": "object" }, +"GoogleApiServiceusageV2alphaImpact": { +"description": "A message to group impacts of updating a policy.", +"id": "GoogleApiServiceusageV2alphaImpact", +"properties": { +"detail": { +"description": "Output only. User friendly impact detail in a free form message.", +"readOnly": true, +"type": "string" +}, +"impactType": { +"description": "Output only. The type of impact.", +"enum": [ +"IMPACT_TYPE_UNSPECIFIED", +"DEPENDENCY_MISSING_DEPENDENCIES", +"RESOURCE_EXISTENCE_PROJECT" +], +"enumDescriptions": [ +"Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 Block 0 - Special/Admin codes Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of ANALYSIS_TYPE_RESOURCE_USAGE Block 3 - Impact Type of ANALYSIS_TYPE_RESOURCE_EXISTENCE ...", +"Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY", +"Block 3 - Impact Type of ANALYSIS_TYPE_RESOURCE_EXISTENCE" +], +"readOnly": true, +"type": "string" +}, +"parent": { +"description": "The parent resource that the analysis is based on and the service name that the analysis is for. Example: `projects/100/services/compute.googleapis.com`, folders/101/services/compute.googleapis.com` and `organizations/102/services/compute.googleapis.com`. Usually, the parent resource here is same as the parent resource of the analyzed policy. However, for some analysis types, the parent can be different. For example, for resource existence analysis, if the parent resource of the analyzed policy is a folder or an organization, the parent resource here can still be the project that contains the resources.", +"type": "string" +} +}, +"type": "object" +}, "GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata": { "description": "Metadata for the `UpdateConsumerPolicy` method.", "id": "GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata", @@ -3153,19 +3253,18 @@ "description": "Output only. The type of impact.", "enum": [ "IMPACT_TYPE_UNSPECIFIED", -"DEPENDENCY_MISSING_DEPENDENCIES", -"RESOURCE_EXISTENCE_PROJECT" +"DEPENDENCY_MISSING_DEPENDENCIES" ], "enumDescriptions": [ -"Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 Block 0 - Special/Admin codes Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of ANALYSIS_TYPE_RESOURCE_USAGE Block 3 - Impact Type of ANALYSIS_TYPE_RESOURCE_EXISTENCE ...", -"Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY", -"Block 3 - Impact Type of ANALYSIS_TYPE_RESOURCE_EXISTENCE" +"Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 Block 0 - Special/Admin codes Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of ANALYSIS_TYPE_RESOURCE_USAGE ...", +"Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY" ], "readOnly": true, "type": "string" }, -"parent": { -"description": "The parent resource that the analysis is based on and the service name that the analysis is for. Example: `projects/100/services/compute.googleapis.com`, folders/101/services/compute.googleapis.com` and `organizations/102/services/compute.googleapis.com`. Usually, the parent resource here is same as the parent resource of the analyzed policy. However, for some analysis types, the parent can be different. For example, for resource existence analysis, if the parent resource of the analyzed policy is a folder or an organization, the parent resource here can still be the project that contains the resources.", +"missingDependency": { +"description": "Output only. This field will be populated only for the `DEPENDENCY_MISSING_DEPENDENCIES` impact type. Example: `services/compute.googleapis.com`. Impact.detail will be in format : `missing service dependency: {missing_dependency}.`", +"readOnly": true, "type": "string" } }, @@ -3828,6 +3927,14 @@ "description": "Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.", "id": "MetricRule", "properties": { +"agenticMetricCosts": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.", +"type": "object" +}, "metricCosts": { "additionalProperties": { "format": "int64", @@ -3836,6 +3943,14 @@ "description": "Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.", "type": "object" }, +"nonagenticMetricCosts": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Optional. Metrics to update when the selected methods are called, and the associated cost applied to each metric, iff the source of the call is not an agent. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.", +"type": "object" +}, "selector": { "description": "Selects the methods to which this rule applies. Refer to selector for syntax details.", "type": "string" @@ -4328,6 +4443,20 @@ "description": "Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.", "type": "string" }, +"trafficSource": { +"description": "Optional. This is only informational, the logic to allocate the quota to the correct metric (such as in `metric_rules`) should identify which quota metrics to allocate to.", +"enum": [ +"TRAFFIC_SOURCE_UNSPECIFIED", +"TRAFFIC_SOURCE_NONAGENTIC", +"TRAFFIC_SOURCE_AGENTIC" +], +"enumDescriptions": [ +"This quota limit applies to all traffic. This is the default value.", +"This quota limit applies to traffic not recognized as agentic.", +"This quota limit applies to only agentic traffic." +], +"type": "string" +}, "unit": { "description": "Specify the unit of the quota limit. It uses the same syntax as MetricDescriptor.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * \"1/min/{project}\" for quota per minute per project. Note: the order of unit components is insignificant. The \"1\" at the beginning is required to follow the metric unit syntax.", "type": "string" From f4364e2f39c201f13c344be3b18707fc3e6d98c0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:19 +0000 Subject: [PATCH 79/84] feat(sqladmin): update the api #### sqladmin:v1 The following keys were added: - resources.operations.methods.cancel.parameters.location (Total Keys: 2) - resources.operations.methods.get.parameters.location (Total Keys: 2) - resources.operations.methods.list.parameters.location (Total Keys: 2) - resources.users.methods.update.parameters.revokeExistingServerRoles (Total Keys: 2) - resources.users.methods.update.parameters.serverRoles (Total Keys: 3) - schemas.DatabaseInstance.properties.databaseCenterIntegrationEnabled.type (Total Keys: 1) - schemas.ExecuteSqlPayload.properties.passwordSecretVersion.type (Total Keys: 1) - schemas.OnPremisesConfiguration.properties.dmsManaged (Total Keys: 2) - schemas.User.properties.serverRoles (Total Keys: 2) #### sqladmin:v1beta4 The following keys were added: - resources.operations.methods.cancel.parameters.location (Total Keys: 2) - resources.operations.methods.get.parameters.location (Total Keys: 2) - resources.operations.methods.list.parameters.location (Total Keys: 2) - resources.users.methods.update.parameters.revokeExistingServerRoles (Total Keys: 2) - resources.users.methods.update.parameters.serverRoles (Total Keys: 3) - schemas.DatabaseInstance.properties.databaseCenterIntegrationEnabled.type (Total Keys: 1) - schemas.ExecuteSqlPayload.properties.passwordSecretVersion.type (Total Keys: 1) - schemas.OnPremisesConfiguration.properties.dmsManaged (Total Keys: 2) - schemas.User.properties.serverRoles (Total Keys: 2) --- docs/dyn/sqladmin_v1.Backups.html | 8 ++++ docs/dyn/sqladmin_v1.instances.html | 15 ++++++ docs/dyn/sqladmin_v1.operations.html | 15 +++--- docs/dyn/sqladmin_v1.users.html | 18 ++++++- docs/dyn/sqladmin_v1beta4.backups.html | 8 ++++ docs/dyn/sqladmin_v1beta4.instances.html | 15 ++++++ docs/dyn/sqladmin_v1beta4.operations.html | 15 +++--- docs/dyn/sqladmin_v1beta4.users.html | 18 ++++++- .../documents/sqladmin.v1.json | 48 ++++++++++++++++++- .../documents/sqladmin.v1beta4.json | 48 ++++++++++++++++++- 10 files changed, 190 insertions(+), 18 deletions(-) diff --git a/docs/dyn/sqladmin_v1.Backups.html b/docs/dyn/sqladmin_v1.Backups.html index 36cd0d7e1c..252842439c 100644 --- a/docs/dyn/sqladmin_v1.Backups.html +++ b/docs/dyn/sqladmin_v1.Backups.html @@ -130,6 +130,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -220,6 +221,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -897,6 +899,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -987,6 +990,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -1350,6 +1354,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -1440,6 +1445,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -1817,6 +1823,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -1907,6 +1914,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html index 8d19575cb7..9d82827c5e 100644 --- a/docs/dyn/sqladmin_v1.instances.html +++ b/docs/dyn/sqladmin_v1.instances.html @@ -1878,6 +1878,7 @@

Method Details

"autoIamAuthn": True or False, # Optional. When set to `true`, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database. "database": "A String", # Optional. Name of the database on which the statement will be executed. "partialResultMode": "A String", # Optional. Controls how the API should respond when the SQL execution result is incomplete due to the size limit or another error. The default mode is to throw an error. + "passwordSecretVersion": "A String", # Optional. The resource name of the Secret Manager secret holding the password for the user to log into the database. The secret should be created using the regional endpoint (for API) or from the Regional Secrets page (for UI), and stored in the same region as the Cloud SQL instance. The expected resource name format is `projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}`. Used together with the `user` field. The secret resource name will not be stored. "rowLimit": "A String", # Optional. The maximum number of rows returned per SQL statement. "sqlStatement": "A String", # Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons. "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. @@ -2357,6 +2358,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -2447,6 +2449,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -2984,6 +2987,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -3074,6 +3078,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -3562,6 +3567,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -3652,6 +3658,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -4034,6 +4041,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -4124,6 +4132,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -4616,6 +4625,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -4706,6 +4716,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -6073,6 +6084,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -6163,6 +6175,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -7484,6 +7497,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -7574,6 +7588,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. diff --git a/docs/dyn/sqladmin_v1.operations.html b/docs/dyn/sqladmin_v1.operations.html index ef7b7ea32b..4f5334369e 100644 --- a/docs/dyn/sqladmin_v1.operations.html +++ b/docs/dyn/sqladmin_v1.operations.html @@ -75,28 +75,29 @@

Cloud SQL Admin API . operations

Instance Methods

- cancel(project, operation, x__xgafv=None)

+ cancel(project, operation, location=None, x__xgafv=None)

Cancels an instance operation that has been performed on an instance.

close()

Close httplib2 connections.

- get(project, operation, x__xgafv=None)

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

Retrieves an instance operation that has been performed on an instance.

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

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

Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.

list_next()

Retrieves the next page of results.

Method Details

- cancel(project, operation, x__xgafv=None) + cancel(project, operation, location=None, x__xgafv=None)
Cancels an instance operation that has been performed on an instance.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   operation: string, Instance operation ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -115,12 +116,13 @@ 

Method Details

- get(project, operation, x__xgafv=None) + get(project, operation, location=None, x__xgafv=None)
Retrieves an instance operation that has been performed on an instance.
 
 Args:
   project: string, Required. Project ID of the project that contains the instance. (required)
   operation: string, Required. Instance operation ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -279,12 +281,13 @@ 

Method Details

- list(project, instance=None, maxResults=None, pageToken=None, x__xgafv=None) + list(project, instance=None, location=None, maxResults=None, pageToken=None, x__xgafv=None)
Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.
 
 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.
+  location: string, Optional. Region of the Cloud SQL instance.
   maxResults: integer, Maximum number of operations per response.
   pageToken: string, A previously-returned page token representing part of the larger set of results to view.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/sqladmin_v1.users.html b/docs/dyn/sqladmin_v1.users.html
index c7b9e07a59..baaa7d73da 100644
--- a/docs/dyn/sqladmin_v1.users.html
+++ b/docs/dyn/sqladmin_v1.users.html
@@ -90,7 +90,7 @@ 

Instance Methods

list(project, instance, x__xgafv=None)

Lists users in the specified Cloud SQL instance.

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

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

Updates an existing user in a Cloud SQL instance.

Method Details

@@ -305,6 +305,9 @@

Method Details

}, }, "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for `update` because it is already specified on the URL. + "serverRoles": [ # Optional. The server roles for the SQL Server login. + "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 @@ -349,6 +352,9 @@

Method Details

}, }, "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for `update` because it is already specified on the URL. + "serverRoles": [ # Optional. The server roles for the SQL Server login. + "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 @@ -556,6 +562,9 @@

Method Details

}, }, "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for `update` because it is already specified on the URL. + "serverRoles": [ # Optional. The server roles for the SQL Server login. + "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 @@ -571,7 +580,7 @@

Method Details

- update(project, instance, body=None, databaseRoles=None, host=None, name=None, revokeExistingRoles=None, x__xgafv=None) + update(project, instance, body=None, databaseRoles=None, host=None, name=None, revokeExistingRoles=None, revokeExistingServerRoles=None, serverRoles=None, x__xgafv=None)
Updates an existing user in a Cloud SQL instance.
 
 Args:
@@ -604,6 +613,9 @@ 

Method Details

}, }, "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for `update` because it is already specified on the URL. + "serverRoles": [ # Optional. The server roles for the SQL Server login. + "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 @@ -617,6 +629,8 @@

Method Details

host: string, Optional. Host of the user in the 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. + serverRoles: string, Optional. The server roles to grant to the SQL Server login. Existing server roles will not be revoked if revoke_existing_roles is false. body.server_roles will be ignored for update request. (repeated) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/sqladmin_v1beta4.backups.html b/docs/dyn/sqladmin_v1beta4.backups.html index dbc614bf64..5cbbdd1d62 100644 --- a/docs/dyn/sqladmin_v1beta4.backups.html +++ b/docs/dyn/sqladmin_v1beta4.backups.html @@ -135,6 +135,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -225,6 +226,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -902,6 +904,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -992,6 +995,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -1355,6 +1359,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -1445,6 +1450,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -1822,6 +1828,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -1912,6 +1919,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index ec08ce000a..f386dd710d 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -1878,6 +1878,7 @@

Method Details

"autoIamAuthn": True or False, # Optional. When set to true, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database. "database": "A String", # Optional. Name of the database on which the statement will be executed. "partialResultMode": "A String", # Optional. Controls how the API should respond when the SQL execution result is incomplete due to the size limit or another error. The default mode is to throw an error. + "passwordSecretVersion": "A String", # Optional. The resource name of the Secret Manager secret holding the password for the user to log into the database. The secret should be created using the regional endpoint (for API) or from the Regional Secrets page (for UI), and stored in the same region as the Cloud SQL instance. The expected resource name format is `projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}`. This field is used together with the `user` field. The secret resource name will not be stored. "rowLimit": "A String", # Optional. The maximum number of rows returned per SQL statement. "sqlStatement": "A String", # Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons. "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. @@ -2357,6 +2358,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -2447,6 +2449,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -2984,6 +2987,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -3074,6 +3078,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -3562,6 +3567,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -3652,6 +3658,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -4034,6 +4041,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -4124,6 +4132,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -4616,6 +4625,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -4706,6 +4716,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -6073,6 +6084,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -6163,6 +6175,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. @@ -7484,6 +7497,7 @@

Method Details

"connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. @@ -7574,6 +7588,7 @@

Method Details

"caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dmsManaged": True or False, # Output only. Indicates whether the resource is managed by Database Migration Service. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format "kind": "A String", # This is always `sql#onPremisesConfiguration`. diff --git a/docs/dyn/sqladmin_v1beta4.operations.html b/docs/dyn/sqladmin_v1beta4.operations.html index d414957672..53b2dcec6a 100644 --- a/docs/dyn/sqladmin_v1beta4.operations.html +++ b/docs/dyn/sqladmin_v1beta4.operations.html @@ -75,28 +75,29 @@

Cloud SQL Admin API . operations

Instance Methods

- cancel(project, operation, x__xgafv=None)

+ cancel(project, operation, location=None, x__xgafv=None)

Cancels an instance operation that has been performed on an instance. Ordinarily, this method name should be `CancelSqlOperation`.

close()

Close httplib2 connections.

- get(project, operation, x__xgafv=None)

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

Retrieves an instance operation that has been performed on an instance.

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

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

Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.

list_next()

Retrieves the next page of results.

Method Details

- cancel(project, operation, x__xgafv=None) + cancel(project, operation, location=None, x__xgafv=None)
Cancels an instance operation that has been performed on an instance. Ordinarily, this method name should be `CancelSqlOperation`.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   operation: string, Instance operation ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -115,12 +116,13 @@ 

Method Details

- get(project, operation, x__xgafv=None) + get(project, operation, location=None, x__xgafv=None)
Retrieves an instance operation that has been performed on an instance.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   operation: string, Instance operation ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -279,12 +281,13 @@ 

Method Details

- list(project, instance=None, maxResults=None, pageToken=None, x__xgafv=None) + list(project, instance=None, location=None, maxResults=None, pageToken=None, x__xgafv=None)
Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.
 
 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.
+  location: string, Optional. Region of the Cloud SQL instance.
   maxResults: integer, Maximum number of operations per response.
   pageToken: string, A previously-returned page token representing part of the larger set of results to view.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/sqladmin_v1beta4.users.html b/docs/dyn/sqladmin_v1beta4.users.html
index d172d3b69f..e866fed400 100644
--- a/docs/dyn/sqladmin_v1beta4.users.html
+++ b/docs/dyn/sqladmin_v1beta4.users.html
@@ -90,7 +90,7 @@ 

Instance Methods

list(project, instance, x__xgafv=None)

Lists users in the specified Cloud SQL instance.

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

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

Updates an existing user in a Cloud SQL instance.

Method Details

@@ -305,6 +305,9 @@

Method Details

}, }, "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for *update* because it is already specified on the URL. + "serverRoles": [ # Optional. The server roles for the SQL Server login. + "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 @@ -349,6 +352,9 @@

Method Details

}, }, "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for *update* because it is already specified on the URL. + "serverRoles": [ # Optional. The server roles for the SQL Server login. + "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 @@ -556,6 +562,9 @@

Method Details

}, }, "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for *update* because it is already specified on the URL. + "serverRoles": [ # Optional. The server roles for the SQL Server login. + "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 @@ -571,7 +580,7 @@

Method Details

- update(project, instance, body=None, databaseRoles=None, host=None, name=None, revokeExistingRoles=None, x__xgafv=None) + update(project, instance, body=None, databaseRoles=None, host=None, name=None, revokeExistingRoles=None, revokeExistingServerRoles=None, serverRoles=None, x__xgafv=None)
Updates an existing user in a Cloud SQL instance.
 
 Args:
@@ -604,6 +613,9 @@ 

Method Details

}, }, "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for *update* because it is already specified on the URL. + "serverRoles": [ # Optional. The server roles for the SQL Server login. + "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 @@ -617,6 +629,8 @@

Method Details

host: string, Optional. Host of the user in the 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. + serverRoles: string, Optional. The server roles to grant to the SQL Server login. Existing server roles will not be revoked if revoke_existing_roles is false. body.server_roles will be ignored for update request. (repeated) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index 38d356c702..a356358339 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -2292,6 +2292,11 @@ "operation" ], "parameters": { +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "operation": { "description": "Instance operation ID.", "location": "path", @@ -2324,6 +2329,11 @@ "operation" ], "parameters": { +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "operation": { "description": "Required. Instance operation ID.", "location": "path", @@ -2360,6 +2370,11 @@ "location": "query", "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "maxResults": { "description": "Maximum number of operations per response.", "format": "uint32", @@ -3052,6 +3067,17 @@ "description": "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.", "location": "query", "type": "boolean" +}, +"revokeExistingServerRoles": { +"description": "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.", +"location": "query", +"type": "boolean" +}, +"serverRoles": { +"description": "Optional. The server roles to grant to the SQL Server login. Existing server roles will not be revoked if revoke_existing_roles is false. body.server_roles will be ignored for update request.", +"location": "query", +"repeated": true, +"type": "string" } }, "path": "v1/projects/{project}/instances/{instance}/users", @@ -3069,7 +3095,7 @@ } } }, -"revision": "20260627", +"revision": "20260722", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -4592,6 +4618,10 @@ false "format": "int64", "type": "string" }, +"databaseCenterIntegrationEnabled": { +"description": "Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center.", +"type": "boolean" +}, "databaseInstalledVersion": { "description": "Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`.", "readOnly": true, @@ -5320,6 +5350,10 @@ false ], "type": "string" }, +"passwordSecretVersion": { +"description": "Optional. The resource name of the Secret Manager secret holding the password for the user to log into the database. The secret should be created using the regional endpoint (for API) or from the Regional Secrets page (for UI), and stored in the same region as the Cloud SQL instance. The expected resource name format is `projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}`. Used together with the `user` field. The secret resource name will not be stored.", +"type": "string" +}, "rowLimit": { "description": "Optional. The maximum number of rows returned per SQL statement.", "format": "int64", @@ -6796,6 +6830,11 @@ false "description": "PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.", "type": "string" }, +"dmsManaged": { +"description": "Output only. Indicates whether the resource is managed by Database Migration Service.", +"readOnly": true, +"type": "boolean" +}, "dumpFilePath": { "description": "The dump file to create the Cloud SQL replica.", "type": "string" @@ -9358,6 +9397,13 @@ false "description": "The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for `update` because it is already specified on the URL.", "type": "string" }, +"serverRoles": { +"description": "Optional. The server roles for the SQL Server login.", +"items": { +"type": "string" +}, +"type": "array" +}, "sqlserverUserDetails": { "$ref": "SqlServerUserDetails" }, diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index ad261324e5..c15eaea061 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -2292,6 +2292,11 @@ "operation" ], "parameters": { +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "operation": { "description": "Instance operation ID.", "location": "path", @@ -2324,6 +2329,11 @@ "operation" ], "parameters": { +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "operation": { "description": "Instance operation ID.", "location": "path", @@ -2360,6 +2370,11 @@ "location": "query", "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "maxResults": { "description": "Maximum number of operations per response.", "format": "uint32", @@ -3052,6 +3067,17 @@ "description": "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.", "location": "query", "type": "boolean" +}, +"revokeExistingServerRoles": { +"description": "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.", +"location": "query", +"type": "boolean" +}, +"serverRoles": { +"description": "Optional. The server roles to grant to the SQL Server login. Existing server roles will not be revoked if revoke_existing_roles is false. body.server_roles will be ignored for update request.", +"location": "query", +"repeated": true, +"type": "string" } }, "path": "sql/v1beta4/projects/{project}/instances/{instance}/users", @@ -3069,7 +3095,7 @@ } } }, -"revision": "20260627", +"revision": "20260722", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -4592,6 +4618,10 @@ false "format": "int64", "type": "string" }, +"databaseCenterIntegrationEnabled": { +"description": "Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center.", +"type": "boolean" +}, "databaseInstalledVersion": { "description": "Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`.", "readOnly": true, @@ -5321,6 +5351,10 @@ false ], "type": "string" }, +"passwordSecretVersion": { +"description": "Optional. The resource name of the Secret Manager secret holding the password for the user to log into the database. The secret should be created using the regional endpoint (for API) or from the Regional Secrets page (for UI), and stored in the same region as the Cloud SQL instance. The expected resource name format is `projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}`. This field is used together with the `user` field. The secret resource name will not be stored.", +"type": "string" +}, "rowLimit": { "description": "Optional. The maximum number of rows returned per SQL statement.", "format": "int64", @@ -6797,6 +6831,11 @@ false "description": "PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.", "type": "string" }, +"dmsManaged": { +"description": "Output only. Indicates whether the resource is managed by Database Migration Service.", +"readOnly": true, +"type": "boolean" +}, "dumpFilePath": { "description": "The dump file to create the Cloud SQL replica.", "type": "string" @@ -9360,6 +9399,13 @@ false "description": "The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for *update* because it is already specified on the URL.", "type": "string" }, +"serverRoles": { +"description": "Optional. The server roles for the SQL Server login.", +"items": { +"type": "string" +}, +"type": "array" +}, "sqlserverUserDetails": { "$ref": "SqlServerUserDetails" }, From 8ce7274e08ad1abc957ac1cd738439ac6ae5cd02 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:21 +0000 Subject: [PATCH 80/84] feat(sts): update the api #### sts:v1 The following keys were added: - schemas.GoogleIdentityStsV1Jwk.properties.alg.type (Total Keys: 1) --- ...anizations.locations.workloadIdentityPools.openid.html | 3 ++- ...1.projects.locations.workloadIdentityPools.openid.html | 3 ++- googleapiclient/discovery_cache/documents/sts.v1.json | 8 ++++++-- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/dyn/sts_v1.organizations.locations.workloadIdentityPools.openid.html b/docs/dyn/sts_v1.organizations.locations.workloadIdentityPools.openid.html index 983db00eda..b44fb38416 100644 --- a/docs/dyn/sts_v1.organizations.locations.workloadIdentityPools.openid.html +++ b/docs/dyn/sts_v1.organizations.locations.workloadIdentityPools.openid.html @@ -103,11 +103,12 @@

Method Details

{ # Response message for GetJwks. "keys": [ # The JWKS for this OP. { # A JSON web key set (JWK) See also https://datatracker.ietf.org/doc/html/rfc7517 and https://github.com/spiffe/spiffe/blob/main/standards/JWT-SVID.md#6-representation-in-the-spiffe-bundle + "alg": "A String", # Algorithm intended for use with the key. Currently "RS256". "e": "A String", # Exponent value for kty="RSA". "kid": "A String", # Key ID. "kty": "A String", # Key type. Currently "RSA". "n": "A String", # Modulus value for kty="RSA". - "use": "A String", # Public key use. Currently "jwt-svid". + "use": "A String", # Public key use. Currently "sig". }, ], }
diff --git a/docs/dyn/sts_v1.projects.locations.workloadIdentityPools.openid.html b/docs/dyn/sts_v1.projects.locations.workloadIdentityPools.openid.html index b78c740367..5812a1df13 100644 --- a/docs/dyn/sts_v1.projects.locations.workloadIdentityPools.openid.html +++ b/docs/dyn/sts_v1.projects.locations.workloadIdentityPools.openid.html @@ -103,11 +103,12 @@

Method Details

{ # Response message for GetJwks. "keys": [ # The JWKS for this OP. { # A JSON web key set (JWK) See also https://datatracker.ietf.org/doc/html/rfc7517 and https://github.com/spiffe/spiffe/blob/main/standards/JWT-SVID.md#6-representation-in-the-spiffe-bundle + "alg": "A String", # Algorithm intended for use with the key. Currently "RS256". "e": "A String", # Exponent value for kty="RSA". "kid": "A String", # Key ID. "kty": "A String", # Key type. Currently "RSA". "n": "A String", # Modulus value for kty="RSA". - "use": "A String", # Public key use. Currently "jwt-svid". + "use": "A String", # Public key use. Currently "sig". }, ], }
diff --git a/googleapiclient/discovery_cache/documents/sts.v1.json b/googleapiclient/discovery_cache/documents/sts.v1.json index c9c7a39c91..41e26ce4cc 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1.json +++ b/googleapiclient/discovery_cache/documents/sts.v1.json @@ -481,7 +481,7 @@ } } }, -"revision": "20260701", +"revision": "20260722", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { @@ -610,6 +610,10 @@ "description": "A JSON web key set (JWK) See also https://datatracker.ietf.org/doc/html/rfc7517 and https://github.com/spiffe/spiffe/blob/main/standards/JWT-SVID.md#6-representation-in-the-spiffe-bundle", "id": "GoogleIdentityStsV1Jwk", "properties": { +"alg": { +"description": "Algorithm intended for use with the key. Currently \"RS256\".", +"type": "string" +}, "e": { "description": "Exponent value for kty=\"RSA\".", "type": "string" @@ -627,7 +631,7 @@ "type": "string" }, "use": { -"description": "Public key use. Currently \"jwt-svid\".", +"description": "Public key use. Currently \"sig\".", "type": "string" } }, From 7c5f92fb6ddf4d0094291fb5a994c625be568400 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:22 +0000 Subject: [PATCH 81/84] feat(threatintelligence): update the api #### threatintelligence:v1beta The following keys were added: - resources.projects.resources.alerts.methods.getPassword (Total Keys: 11) --- ...atintelligence_v1beta.projects.alerts.html | 139 ++++++++++++++++++ .../documents/threatintelligence.v1beta.json | 27 +++- 2 files changed, 165 insertions(+), 1 deletion(-) diff --git a/docs/dyn/threatintelligence_v1beta.projects.alerts.html b/docs/dyn/threatintelligence_v1beta.projects.alerts.html index 745f0cd7b2..68dbd56efc 100644 --- a/docs/dyn/threatintelligence_v1beta.projects.alerts.html +++ b/docs/dyn/threatintelligence_v1beta.projects.alerts.html @@ -100,6 +100,9 @@

Instance Methods

get(name, x__xgafv=None)

Get an alert by name.

+

+ getPassword(name, x__xgafv=None)

+

Get the decrypted password of an alert.

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

Get a list of alerts that meet the filter criteria.

@@ -866,6 +869,142 @@

Method Details

}
+
+ getPassword(name, x__xgafv=None) +
Get the decrypted password of an alert.
+
+Args:
+  name: string, Required. Name of the alert to get. Format: projects/{project}/alerts/{alert} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Stateful object representing a group of Findings. Key feature to an Alert is that it expresses the user's intent towards the findings of that group, even those that haven't occurred yet.
+  "aiSummary": "A String", # Optional. AI summary of the alert.
+  "audit": { # Tracks basic CRUD facts. # Output only. Audit information for the alert.
+    "createTime": "A String", # Output only. Time of creation.
+    "creator": "A String", # Output only. Agent that created or updated the record, could be a UserId or a JobId.
+    "updateTime": "A String", # Output only. Time of creation or last update.
+    "updater": "A String", # Output only. Agent that last updated the record, could be a UserId or a JobId.
+  },
+  "configurations": [ # Output only. The resource names of the Configurations bound to this alert. Format: projects/{project}/configurations/{configuration}
+    "A String",
+  ],
+  "detail": { # Container for different types of alert details. # Output only. Details object for the alert, not all alerts will have a details object.
+    "dataLeak": { # Captures the specific details of Data Leak alert. # Data Leak alert detail type.
+      "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents
+        "A String",
+      ],
+      "severity": "A String", # Required. The severity of the Data Leak alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL`
+    },
+    "detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union.
+    "initialAccessBroker": { # Captures the specific details of InitialAccessBroker (IAB) alert. # Initial Access Broker alert detail type.
+      "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents
+        "A String",
+      ],
+      "severity": "A String", # Required. The severity of the Initial Access Broker (IAB) alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL`
+    },
+    "insiderThreat": { # Captures the specific details of InsiderThreat alert. # Insider Threat alert detail type.
+      "discoveryDocumentIds": [ # Required. Array of ids to accommodate multiple discovery documents
+        "A String",
+      ],
+      "severity": "A String", # Required. The severity of the Insider Threat alert. Allowed values are: * `LOW` * `MEDIUM` * `HIGH` * `CRITICAL`
+    },
+    "targetTechnology": { # Contains details for a technology watchlist alert. # Technology Watchlist alert detail type.
+      "vulnerabilityMatch": { # Contains details about a vulnerability match. # Optional. The vulnerability match details.
+        "associations": [ # Optional. Associated threat actors, malware, etc. This is embedded as a snapshot because the details of the association at the time of the vulnerability match are important for context and reporting.
+          { # Represents an association with a vulnerability.
+            "id": "A String", # Required. The ID of the association.
+            "type": "A String", # Required. The type of the association.
+          },
+        ],
+        "collectionId": "A String", # Required. The collection ID of the vulnerability. Ex: "vulnerability--cve-2025-9876".
+        "cveId": "A String", # Required. The CVE ID of the vulnerability. Ex: "CVE-2025-9876". See https://www.cve.org/ for more information.
+        "cvss3Score": 3.14, # Required. The CVSS score of the vulnerability. Evaluates to CVSS v3 when available with a fallback to v2 and v4. Example: 6.4.
+        "description": "A String", # Required. A description of the vulnerability.
+        "disclosureTime": "A String", # Optional. The disclosure time of the vulnerability.
+        "epssScore": 3.14, # Optional. The EPSS score, representing the probability of exploitation. Example: 0.87.
+        "exploitationConsequences": [ # Optional. List of exploitation consequences for the vulnerability.
+          "A String",
+        ],
+        "exploitationState": "A String", # Required. The exploitation state of the vulnerability.
+        "exploitationVectors": [ # Optional. List of exploitation vectors for the vulnerability.
+          "A String",
+        ],
+        "matchedTechnologies": [ # Optional. The specific technologies from the configured watchlist that triggered the match. Ex: "Apache Struts".
+          "A String",
+        ],
+        "priority": "A String", # Optional. The priority level of the vulnerability data. Ex: "P1".
+        "productFixes": [ # Optional. List of product fixes for the vulnerability.
+          { # Contains details about a product fix.
+            "displayName": "A String", # Required. The name of the fix. Ex: "Magento".
+            "publishTime": "A String", # Optional. The published time of the fix.
+            "sourceId": "A String", # Required. The source ID of the fix. Ex: "APPSEC-1420".
+            "uri": "A String", # Optional. The URI of the fix.
+          },
+        ],
+        "publicExploits": [ # Optional. List of public exploits.
+          { # Contains details about a public exploit.
+            "exploitGrade": "A String", # Optional. The grade of the exploit. Ex: "non-weaponized".
+            "exploitName": "A String", # Required. The name of the exploit. Ex: "Magentounauth.php.txt".
+            "exploitReliability": "A String", # Optional. The reliability of the exploit. Ex: "Unreviewed".
+            "releaseTime": "A String", # Optional. The release time of the exploit.
+            "sizeBytes": "A String", # Optional. The size of the exploit.
+            "uri": "A String", # Optional. The URI of the exploit.
+          },
+        ],
+        "publiclyAvailableExploit": True or False, # Output only. Whether a publicly available exploit exists.
+        "riskRating": "A String", # Required. The risk rating of the vulnerability.
+        "technologies": [ # Required. All technologies affected by the vulnerability. Ex: "Apache Struts".
+          "A String",
+        ],
+      },
+    },
+  },
+  "displayName": "A String", # Output only. A short title for the alert.
+  "duplicateOf": "A String", # Output only. alert name of the alert this alert is a duplicate of. Format: projects/{project}/alerts/{alert}
+  "duplicatedBy": [ # Output only. alert names of the alerts that are duplicates of this alert. Format: projects/{project}/alerts/{alert}
+    "A String",
+  ],
+  "etag": "A String", # Optional. If included when updating an alert, this should be set to the current etag of the alert. If the etags do not match, the update will be rejected and an ABORTED error will be returned.
+  "externalId": "A String", # Output only. External ID for the alert. This is used internally to provide protection against out of order updates.
+  "findingCount": "A String", # Output only. The number of findings associated with this alert.
+  "findings": [ # Output only. Findings that are covered by this alert.
+    "A String",
+  ],
+  "name": "A String", # Identifier. Server generated name for the alert. format is projects/{project}/alerts/{alert}
+  "priorityAnalysis": { # Structured priority analysis for a threat. # Output only. High-Precision Priority Analysis for the alert.
+    "confidence": "A String", # The level of confidence in the given verdict.
+    "priorityLevel": "A String", # The level of Priority.
+    "reasoning": "A String", # Human-readable explanation from the model, detailing why a particular result is considered to have a certain priority.
+  },
+  "relevanceAnalysis": { # Structured relevance analysis for a threat. # Output only. High-Precision Relevance Analysis verdict for the alert.
+    "confidence": "A String", # The level of confidence in the given verdict.
+    "evidence": { # Details the evidence used to determine the relevance verdict. # Evidence supporting the verdict, including matched and unmatched items.
+      "commonThemes": [ # A list of semantic themes or concepts found to be common, related, or aligned between the sources, supporting the verdict.
+        "A String",
+      ],
+      "distinctThemes": [ # A list of semantic themes or descriptions unique to one source or semantically distant.
+        "A String",
+      ],
+    },
+    "reasoning": "A String", # Human-readable explanation from the matcher, detailing why a particular result is considered relevant or not relevant.
+    "relevanceLevel": "A String", # The level of relevance.
+    "relevant": True or False, # Indicates whether the threat is considered relevant.
+  },
+  "severityAnalysis": { # Structured severity analysis for a threat. # Output only. High-Precision Severity Analysis for the alert.
+    "confidence": "A String", # The level of confidence in the given verdict.
+    "reasoning": "A String", # Human-readable explanation from the model, detailing why a particular result is considered to have a certain severity.
+    "severityLevel": "A String", # The level of severity.
+  },
+  "state": "A String", # Output only. State of the alert.
+}
+
+
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Get a list of alerts that meet the filter criteria.
diff --git a/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json b/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json
index 988e8988f5..fd29df78c0 100644
--- a/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json
@@ -313,6 +313,31 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"getPassword": {
+"description": "Get the decrypted password of an alert.",
+"flatPath": "v1beta/projects/{projectsId}/alerts/{alertsId}:getPassword",
+"httpMethod": "GET",
+"id": "threatintelligence.projects.alerts.getPassword",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Name of the alert to get. Format: projects/{project}/alerts/{alert}",
+"location": "path",
+"pattern": "^projects/[^/]+/alerts/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+name}:getPassword",
+"response": {
+"$ref": "Alert"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "list": {
 "description": "Get a list of alerts that meet the filter criteria.",
 "flatPath": "v1beta/projects/{projectsId}/alerts",
@@ -817,7 +842,7 @@
 }
 }
 },
-"revision": "20260607",
+"revision": "20260726",
 "rootUrl": "https://threatintelligence.googleapis.com/",
 "schemas": {
 "Alert": {

From 26b06194dc01a6c28b3083ed4d2f628096b97ae5 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Aug 2026 07:58:23 +0000
Subject: [PATCH 82/84] feat(webcontentpublisher): update the api

#### webcontentpublisher:v1

The following keys were added:
- schemas.Publication.properties.publicationType.type (Total Keys: 1)
- schemas.TosAcceptance.properties.emailOptIn.type (Total Keys: 1)
---
 ...blisher_v1.organizations.publications.html | 12 +++++++++++
 .../documents/webcontentpublisher.v1.json     | 20 ++++++++++++++++++-
 2 files changed, 31 insertions(+), 1 deletion(-)

diff --git a/docs/dyn/webcontentpublisher_v1.organizations.publications.html b/docs/dyn/webcontentpublisher_v1.organizations.publications.html
index 99c7f96bf8..91b91bb4f9 100644
--- a/docs/dyn/webcontentpublisher_v1.organizations.publications.html
+++ b/docs/dyn/webcontentpublisher_v1.organizations.publications.html
@@ -139,11 +139,13 @@ 

Method Details

"publicationId": "A String", # Output only. The unique identifier of the publication. "publicationPrivacyPolicyUrl": "A String", # Optional. The URL to the publisher's Privacy Policy. "publicationTosUrl": "A String", # Optional. The URL to the publisher's own Terms of Service. + "publicationType": "A String", # Optional. The publication entity type (for-profit vs non-profit). Defaults to FOR_PROFIT if omitted. "regionCode": "A String", # Required. The ISO 3166-1 alpha-2 region code where the publication is registered (e.g., "US"). "rrmProduct": { # Configuration and status of the Reader Revenue Manager (RRM) product for a publication. # Optional. Reader Revenue Manager product settings and status. "enabled": True or False, # Optional. Whether the RRM product is enabled for the publication. "productTosUrl": "A String", # Output only. The URL to the product-specific Terms of Service. "tosAcceptance": { # Details about the acceptance of the Terms of Service (TOS). # Optional. The details of the TOS acceptance. + "emailOptIn": True or False, # Optional. Whether the user opted in to receive product updates and email communications. "signer": "A String", # Optional. The name of the person who accepted the TOS. "signerTitle": "A String", # Optional. The job title or role of the signer. "userAccepted": True or False, # Required. Whether the user has accepted the Terms of Service. @@ -191,11 +193,13 @@

Method Details

"publicationId": "A String", # Output only. The unique identifier of the publication. "publicationPrivacyPolicyUrl": "A String", # Optional. The URL to the publisher's Privacy Policy. "publicationTosUrl": "A String", # Optional. The URL to the publisher's own Terms of Service. + "publicationType": "A String", # Optional. The publication entity type (for-profit vs non-profit). Defaults to FOR_PROFIT if omitted. "regionCode": "A String", # Required. The ISO 3166-1 alpha-2 region code where the publication is registered (e.g., "US"). "rrmProduct": { # Configuration and status of the Reader Revenue Manager (RRM) product for a publication. # Optional. Reader Revenue Manager product settings and status. "enabled": True or False, # Optional. Whether the RRM product is enabled for the publication. "productTosUrl": "A String", # Output only. The URL to the product-specific Terms of Service. "tosAcceptance": { # Details about the acceptance of the Terms of Service (TOS). # Optional. The details of the TOS acceptance. + "emailOptIn": True or False, # Optional. Whether the user opted in to receive product updates and email communications. "signer": "A String", # Optional. The name of the person who accepted the TOS. "signerTitle": "A String", # Optional. The job title or role of the signer. "userAccepted": True or False, # Required. Whether the user has accepted the Terms of Service. @@ -249,11 +253,13 @@

Method Details

"publicationId": "A String", # Output only. The unique identifier of the publication. "publicationPrivacyPolicyUrl": "A String", # Optional. The URL to the publisher's Privacy Policy. "publicationTosUrl": "A String", # Optional. The URL to the publisher's own Terms of Service. + "publicationType": "A String", # Optional. The publication entity type (for-profit vs non-profit). Defaults to FOR_PROFIT if omitted. "regionCode": "A String", # Required. The ISO 3166-1 alpha-2 region code where the publication is registered (e.g., "US"). "rrmProduct": { # Configuration and status of the Reader Revenue Manager (RRM) product for a publication. # Optional. Reader Revenue Manager product settings and status. "enabled": True or False, # Optional. Whether the RRM product is enabled for the publication. "productTosUrl": "A String", # Output only. The URL to the product-specific Terms of Service. "tosAcceptance": { # Details about the acceptance of the Terms of Service (TOS). # Optional. The details of the TOS acceptance. + "emailOptIn": True or False, # Optional. Whether the user opted in to receive product updates and email communications. "signer": "A String", # Optional. The name of the person who accepted the TOS. "signerTitle": "A String", # Optional. The job title or role of the signer. "userAccepted": True or False, # Required. Whether the user has accepted the Terms of Service. @@ -313,11 +319,13 @@

Method Details

"publicationId": "A String", # Output only. The unique identifier of the publication. "publicationPrivacyPolicyUrl": "A String", # Optional. The URL to the publisher's Privacy Policy. "publicationTosUrl": "A String", # Optional. The URL to the publisher's own Terms of Service. + "publicationType": "A String", # Optional. The publication entity type (for-profit vs non-profit). Defaults to FOR_PROFIT if omitted. "regionCode": "A String", # Required. The ISO 3166-1 alpha-2 region code where the publication is registered (e.g., "US"). "rrmProduct": { # Configuration and status of the Reader Revenue Manager (RRM) product for a publication. # Optional. Reader Revenue Manager product settings and status. "enabled": True or False, # Optional. Whether the RRM product is enabled for the publication. "productTosUrl": "A String", # Output only. The URL to the product-specific Terms of Service. "tosAcceptance": { # Details about the acceptance of the Terms of Service (TOS). # Optional. The details of the TOS acceptance. + "emailOptIn": True or False, # Optional. Whether the user opted in to receive product updates and email communications. "signer": "A String", # Optional. The name of the person who accepted the TOS. "signerTitle": "A String", # Optional. The job title or role of the signer. "userAccepted": True or False, # Required. Whether the user has accepted the Terms of Service. @@ -382,11 +390,13 @@

Method Details

"publicationId": "A String", # Output only. The unique identifier of the publication. "publicationPrivacyPolicyUrl": "A String", # Optional. The URL to the publisher's Privacy Policy. "publicationTosUrl": "A String", # Optional. The URL to the publisher's own Terms of Service. + "publicationType": "A String", # Optional. The publication entity type (for-profit vs non-profit). Defaults to FOR_PROFIT if omitted. "regionCode": "A String", # Required. The ISO 3166-1 alpha-2 region code where the publication is registered (e.g., "US"). "rrmProduct": { # Configuration and status of the Reader Revenue Manager (RRM) product for a publication. # Optional. Reader Revenue Manager product settings and status. "enabled": True or False, # Optional. Whether the RRM product is enabled for the publication. "productTosUrl": "A String", # Output only. The URL to the product-specific Terms of Service. "tosAcceptance": { # Details about the acceptance of the Terms of Service (TOS). # Optional. The details of the TOS acceptance. + "emailOptIn": True or False, # Optional. Whether the user opted in to receive product updates and email communications. "signer": "A String", # Optional. The name of the person who accepted the TOS. "signerTitle": "A String", # Optional. The job title or role of the signer. "userAccepted": True or False, # Required. Whether the user has accepted the Terms of Service. @@ -434,11 +444,13 @@

Method Details

"publicationId": "A String", # Output only. The unique identifier of the publication. "publicationPrivacyPolicyUrl": "A String", # Optional. The URL to the publisher's Privacy Policy. "publicationTosUrl": "A String", # Optional. The URL to the publisher's own Terms of Service. + "publicationType": "A String", # Optional. The publication entity type (for-profit vs non-profit). Defaults to FOR_PROFIT if omitted. "regionCode": "A String", # Required. The ISO 3166-1 alpha-2 region code where the publication is registered (e.g., "US"). "rrmProduct": { # Configuration and status of the Reader Revenue Manager (RRM) product for a publication. # Optional. Reader Revenue Manager product settings and status. "enabled": True or False, # Optional. Whether the RRM product is enabled for the publication. "productTosUrl": "A String", # Output only. The URL to the product-specific Terms of Service. "tosAcceptance": { # Details about the acceptance of the Terms of Service (TOS). # Optional. The details of the TOS acceptance. + "emailOptIn": True or False, # Optional. Whether the user opted in to receive product updates and email communications. "signer": "A String", # Optional. The name of the person who accepted the TOS. "signerTitle": "A String", # Optional. The job title or role of the signer. "userAccepted": True or False, # Required. Whether the user has accepted the Terms of Service. diff --git a/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json b/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json index cc0d47f03f..c16fe6066e 100644 --- a/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json +++ b/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json @@ -394,7 +394,7 @@ } } }, -"revision": "20260629", +"revision": "20260724", "rootUrl": "https://webcontentpublisher.googleapis.com/", "schemas": { "CheckFreeAccessResponse": { @@ -660,6 +660,20 @@ "description": "Optional. The URL to the publisher's own Terms of Service.", "type": "string" }, +"publicationType": { +"description": "Optional. The publication entity type (for-profit vs non-profit). Defaults to FOR_PROFIT if omitted.", +"enum": [ +"PUBLICATION_TYPE_UNSPECIFIED", +"FOR_PROFIT", +"NON_PROFIT" +], +"enumDescriptions": [ +"Unspecified publication type.", +"For-profit entity.", +"Non-profit entity." +], +"type": "string" +}, "regionCode": { "description": "Required. The ISO 3166-1 alpha-2 region code where the publication is registered (e.g., \"US\").", "type": "string" @@ -715,6 +729,10 @@ "description": "Details about the acceptance of the Terms of Service (TOS).", "id": "TosAcceptance", "properties": { +"emailOptIn": { +"description": "Optional. Whether the user opted in to receive product updates and email communications.", +"type": "boolean" +}, "signer": { "description": "Optional. The name of the person who accepted the TOS.", "type": "string" From 245049fcf9c63a2eff240c16a92b0614a746fb8b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Aug 2026 07:58:25 +0000 Subject: [PATCH 83/84] fix(workspaceevents): update the api #### workspaceevents:v1 The following keys were changed: - resources.subscriptions.methods.create.scopes (Total Keys: 1) - resources.subscriptions.methods.patch.scopes (Total Keys: 1) - resources.subscriptions.methods.reactivate.scopes (Total Keys: 1) --- .../dyn/workspaceevents_v1.subscriptions.html | 14 ++++---- .../documents/workspaceevents.v1.json | 34 ++++++++++++++++--- 2 files changed, 36 insertions(+), 12 deletions(-) diff --git a/docs/dyn/workspaceevents_v1.subscriptions.html b/docs/dyn/workspaceevents_v1.subscriptions.html index 65ef69eb22..8b8460d0bf 100644 --- a/docs/dyn/workspaceevents_v1.subscriptions.html +++ b/docs/dyn/workspaceevents_v1.subscriptions.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

create(body=None, validateOnly=None, x__xgafv=None)

-

Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

+

Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app subscribing to space events where the app is a member by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - [Developer Preview](https://developers.google.com/workspace/preview): A Chat app subscribing to all events in a Google Workspace organization by specifying an authorization scope that begins with `chat.app.all` and obtaining one-time administrator approval. To learn more, see [Subscribe to all Google Chat events in a Workspace organization ](https://developers.google.com/workspace/events/guides/create-subscription#customer-subscription). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

delete(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None)

Deletes a Google Workspace subscription. To learn how to use this method, see [Delete a Google Workspace subscription](https://developers.google.com/workspace/events/guides/delete-subscription).

@@ -94,10 +94,10 @@

Instance Methods

Retrieves the next page of results.

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

-

Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

+

Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app subscribing to space events where the app is a member by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - [Developer Preview](https://developers.google.com/workspace/preview): A Chat app subscribing to all events in a Google Workspace organization by specifying an authorization scope that begins with `chat.app.all` and getting one-time administrator approval. To learn more, see [Subscribe to all Google Chat events in a Workspace organization ](https://developers.google.com/workspace/events/guides/create-subscription#customer-subscription). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

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

-

Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

+

Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app subscribing to space events where the app is a member by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - [Developer Preview](https://developers.google.com/workspace/preview): A Chat app subscribing to all events in a Google Workspace organization by specifying an authorization scope that begins with `chat.app.all` and getting one-time administrator approval. To learn more, see [Subscribe to all Google Chat events in a Workspace organization ](https://developers.google.com/workspace/events/guides/create-subscription#customer-subscription). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

Method Details

close() @@ -106,7 +106,7 @@

Method Details

create(body=None, validateOnly=None, x__xgafv=None) -
Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+  
Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app subscribing to space events where the app is a member by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - [Developer Preview](https://developers.google.com/workspace/preview): A Chat app subscribing to all events in a Google Workspace organization by specifying an authorization scope that begins with `chat.app.all` and obtaining one-time administrator approval. To learn more, see [Subscribe to all Google Chat events in a Workspace organization ](https://developers.google.com/workspace/events/guides/create-subscription#customer-subscription). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
   body: object, The request body.
@@ -260,7 +260,7 @@ 

Method Details

Lists Google Workspace subscriptions. To learn how to use this method, see [List Google Workspace subscriptions](https://developers.google.com/workspace/events/guides/list-subscriptions).
 
 Args:
-  filter: string, Required. A query filter. You can filter subscriptions by event type (`event_types`) and target resource (`target_resource`). You must specify at least one event type in your query. To filter for multiple event types, use the `OR` operator. To filter by both event type and target resource, use the `AND` operator and specify the full resource name, such as `//chat.googleapis.com/spaces/{space}`. For example, the following queries are valid: ``` event_types:"google.workspace.chat.membership.v1.updated" OR event_types:"google.workspace.chat.message.v1.created" event_types:"google.workspace.chat.message.v1.created" AND target_resource="//chat.googleapis.com/spaces/{space}" ( event_types:"google.workspace.chat.membership.v1.updated" OR event_types:"google.workspace.chat.message.v1.created" ) AND target_resource="//chat.googleapis.com/spaces/{space}" ``` The server rejects invalid queries with an `INVALID_ARGUMENT` error.
+  filter: string, Required. A query filter. You can filter subscriptions by event type (`event_types`) and target resource (`target_resource`). You must specify at least one event type in your query. To filter for multiple event types, use the `OR` operator. To filter by both event type and target resource, use the `AND` operator and specify the full resource name, such as `//chat.googleapis.com/spaces/{space}`. For example, the following queries are valid: ``` event_types:"google.workspace.chat.membership.v1.updated" OR event_types:"google.workspace.chat.message.v1.created" event_types:"google.workspace.chat.message.v1.created" AND target_resource="//chat.googleapis.com/spaces/{space}" ( event_types:"google.workspace.chat.membership.v1.updated" OR event_types:"google.workspace.chat.message.v1.created" ) AND target_resource="//chat.googleapis.com/spaces/{space}" ``` The following query is available in [Developer Preview](https://developers.google.com/workspace/preview): ``` event_types:"google.workspace.chat.message.v1.created" AND target_resource="//admin.googleapis.com/customers/my_customer" ``` The server rejects invalid queries with an `INVALID_ARGUMENT` error.
   pageSize: integer, Optional. The maximum number of subscriptions to return. The service might return fewer than this value. If unspecified or set to `0`, up to 50 subscriptions are returned. The maximum value is 100. If you specify a value more than 100, the system only returns 100 subscriptions.
   pageToken: string, Optional. A page token, received from a previous list subscriptions call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.
   x__xgafv: string, V1 error format.
@@ -323,7 +323,7 @@ 

Method Details

patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None) -
Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+  
Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app subscribing to space events where the app is a member by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - [Developer Preview](https://developers.google.com/workspace/preview): A Chat app subscribing to all events in a Google Workspace organization by specifying an authorization scope that begins with `chat.app.all` and getting one-time administrator approval. To learn more, see [Subscribe to all Google Chat events in a Workspace organization ](https://developers.google.com/workspace/events/guides/create-subscription#customer-subscription). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
   name: string, Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}` (required)
@@ -393,7 +393,7 @@ 

Method Details

reactivate(name, body=None, x__xgafv=None) -
Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+  
Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app subscribing to space events where the app is a member by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - [Developer Preview](https://developers.google.com/workspace/preview): A Chat app subscribing to all events in a Google Workspace organization by specifying an authorization scope that begins with `chat.app.all` and getting one-time administrator approval. To learn more, see [Subscribe to all Google Chat events in a Workspace organization ](https://developers.google.com/workspace/events/guides/create-subscription#customer-subscription). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
   name: string, Required. Resource name of the subscription. Format: `subscriptions/{subscription}` (required)
diff --git a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json
index 651db2251d..eebfa89b3f 100644
--- a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json
+++ b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json
@@ -2,6 +2,18 @@
 "auth": {
 "oauth2": {
 "scopes": {
+"https://www.googleapis.com/auth/chat.app.all.memberships.readonly": {
+"description": "On their own behalf, apps in Google Chat can see all members in Google Chat spaces and conversations throughout your Workspace organization, even when the Chat app isn't a member"
+},
+"https://www.googleapis.com/auth/chat.app.all.messages.readonly": {
+"description": "On their own behalf, apps in Google Chat can see all messages and reactions throughout your Workspace organization, even when the Chat app isn't a member of a space or conversation"
+},
+"https://www.googleapis.com/auth/chat.app.all.spaces.readonly": {
+"description": "On their own behalf, apps in Google Chat can see metadata about all spaces and conversations in Google Chat throughout your Workspace organization, even when the Chat app isn't a member"
+},
+"https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly": {
+"description": "On their own behalf, apps in Google Chat can see the last read time for all users in all spaces and conversations throughout your Workspace organization, even when the Chat app isn't a member."
+},
 "https://www.googleapis.com/auth/chat.app.memberships": {
 "description": "On their own behalf, apps in Google Chat can see, add, update, and remove members from conversations and spaces"
 },
@@ -247,7 +259,7 @@
 "subscriptions": {
 "methods": {
 "create": {
-"description": "Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
+"description": "Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app subscribing to space events where the app is a member by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - [Developer Preview](https://developers.google.com/workspace/preview): A Chat app subscribing to all events in a Google Workspace organization by specifying an authorization scope that begins with `chat.app.all` and obtaining one-time administrator approval. To learn more, see [Subscribe to all Google Chat events in a Workspace organization ](https://developers.google.com/workspace/events/guides/create-subscription#customer-subscription). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
 "flatPath": "v1/subscriptions",
 "httpMethod": "POST",
 "id": "workspaceevents.subscriptions.create",
@@ -267,6 +279,10 @@
 "$ref": "Operation"
 },
 "scopes": [
+"https://www.googleapis.com/auth/chat.app.all.memberships.readonly",
+"https://www.googleapis.com/auth/chat.app.all.messages.readonly",
+"https://www.googleapis.com/auth/chat.app.all.spaces.readonly",
+"https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly",
 "https://www.googleapis.com/auth/chat.app.memberships",
 "https://www.googleapis.com/auth/chat.app.memberships.readonly",
 "https://www.googleapis.com/auth/chat.app.messages.readonly",
@@ -404,7 +420,7 @@
 "parameterOrder": [],
 "parameters": {
 "filter": {
-"description": "Required. A query filter. You can filter subscriptions by event type (`event_types`) and target resource (`target_resource`). You must specify at least one event type in your query. To filter for multiple event types, use the `OR` operator. To filter by both event type and target resource, use the `AND` operator and specify the full resource name, such as `//chat.googleapis.com/spaces/{space}`. For example, the following queries are valid: ``` event_types:\"google.workspace.chat.membership.v1.updated\" OR event_types:\"google.workspace.chat.message.v1.created\" event_types:\"google.workspace.chat.message.v1.created\" AND target_resource=\"//chat.googleapis.com/spaces/{space}\" ( event_types:\"google.workspace.chat.membership.v1.updated\" OR event_types:\"google.workspace.chat.message.v1.created\" ) AND target_resource=\"//chat.googleapis.com/spaces/{space}\" ``` The server rejects invalid queries with an `INVALID_ARGUMENT` error.",
+"description": "Required. A query filter. You can filter subscriptions by event type (`event_types`) and target resource (`target_resource`). You must specify at least one event type in your query. To filter for multiple event types, use the `OR` operator. To filter by both event type and target resource, use the `AND` operator and specify the full resource name, such as `//chat.googleapis.com/spaces/{space}`. For example, the following queries are valid: ``` event_types:\"google.workspace.chat.membership.v1.updated\" OR event_types:\"google.workspace.chat.message.v1.created\" event_types:\"google.workspace.chat.message.v1.created\" AND target_resource=\"//chat.googleapis.com/spaces/{space}\" ( event_types:\"google.workspace.chat.membership.v1.updated\" OR event_types:\"google.workspace.chat.message.v1.created\" ) AND target_resource=\"//chat.googleapis.com/spaces/{space}\" ``` The following query is available in [Developer Preview](https://developers.google.com/workspace/preview): ``` event_types:\"google.workspace.chat.message.v1.created\" AND target_resource=\"//admin.googleapis.com/customers/my_customer\" ``` The server rejects invalid queries with an `INVALID_ARGUMENT` error.",
 "location": "query",
 "type": "string"
 },
@@ -448,7 +464,7 @@
 ]
 },
 "patch": {
-"description": "Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
+"description": "Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app subscribing to space events where the app is a member by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - [Developer Preview](https://developers.google.com/workspace/preview): A Chat app subscribing to all events in a Google Workspace organization by specifying an authorization scope that begins with `chat.app.all` and getting one-time administrator approval. To learn more, see [Subscribe to all Google Chat events in a Workspace organization ](https://developers.google.com/workspace/events/guides/create-subscription#customer-subscription). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
 "flatPath": "v1/subscriptions/{subscriptionsId}",
 "httpMethod": "PATCH",
 "id": "workspaceevents.subscriptions.patch",
@@ -483,6 +499,10 @@
 "$ref": "Operation"
 },
 "scopes": [
+"https://www.googleapis.com/auth/chat.app.all.memberships.readonly",
+"https://www.googleapis.com/auth/chat.app.all.messages.readonly",
+"https://www.googleapis.com/auth/chat.app.all.spaces.readonly",
+"https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly",
 "https://www.googleapis.com/auth/chat.app.memberships",
 "https://www.googleapis.com/auth/chat.app.memberships.readonly",
 "https://www.googleapis.com/auth/chat.app.messages.readonly",
@@ -510,7 +530,7 @@
 ]
 },
 "reactivate": {
-"description": "Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
+"description": "Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app subscribing to space events where the app is a member by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - [Developer Preview](https://developers.google.com/workspace/preview): A Chat app subscribing to all events in a Google Workspace organization by specifying an authorization scope that begins with `chat.app.all` and getting one-time administrator approval. To learn more, see [Subscribe to all Google Chat events in a Workspace organization ](https://developers.google.com/workspace/events/guides/create-subscription#customer-subscription). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
 "flatPath": "v1/subscriptions/{subscriptionsId}:reactivate",
 "httpMethod": "POST",
 "id": "workspaceevents.subscriptions.reactivate",
@@ -534,6 +554,10 @@
 "$ref": "Operation"
 },
 "scopes": [
+"https://www.googleapis.com/auth/chat.app.all.memberships.readonly",
+"https://www.googleapis.com/auth/chat.app.all.messages.readonly",
+"https://www.googleapis.com/auth/chat.app.all.spaces.readonly",
+"https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly",
 "https://www.googleapis.com/auth/chat.app.memberships",
 "https://www.googleapis.com/auth/chat.app.memberships.readonly",
 "https://www.googleapis.com/auth/chat.app.messages.readonly",
@@ -785,7 +809,7 @@
 }
 }
 },
-"revision": "20260517",
+"revision": "20260721",
 "rootUrl": "https://workspaceevents.googleapis.com/",
 "schemas": {
 "Artifact": {

From 7f3cc906f1f5a5aed68a8f9b0df9b9a4e67b323d Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Aug 2026 07:58:29 +0000
Subject: [PATCH 84/84] chore(docs): Add new discovery artifacts and artifacts
 with minor updates

---
 docs/dyn/agentidentity_v1.html                |  111 ++
 docs/dyn/agentidentity_v1.projects.html       |   91 +
 ...v1.projects.locations.accessSummaries.html |  187 ++
 ...ocations.authProviders.authorizations.html |  195 +++
 ...y_v1.projects.locations.authProviders.html |  976 +++++++++++
 .../agentidentity_v1.projects.locations.html  |  182 ++
 docs/dyn/agentidentity_v1alpha.html           |  111 ++
 docs/dyn/agentidentity_v1alpha.projects.html  |   91 +
 ...ha.projects.locations.accessSummaries.html |  187 ++
 ...ocations.authProviders.authorizations.html |  195 +++
 ...lpha.projects.locations.authProviders.html |  976 +++++++++++
 ...ntidentity_v1alpha.projects.locations.html |  182 ++
 docs/dyn/agentidentity_v1beta.html            |  111 ++
 docs/dyn/agentidentity_v1beta.projects.html   |   91 +
 ...ta.projects.locations.accessSummaries.html |  187 ++
 ...ocations.authProviders.authorizations.html |  195 +++
 ...beta.projects.locations.authProviders.html |  976 +++++++++++
 ...entidentity_v1beta.projects.locations.html |  182 ++
 docs/dyn/agentidentitycredentials_v1.html     |  111 ++
 .../agentidentitycredentials_v1.projects.html |   91 +
 ...s.locations.authProviders.credentials.html |  166 ++
 ...s_v1.projects.locations.authProviders.html |   91 +
 ...titycredentials_v1.projects.locations.html |   91 +
 .../dyn/agentidentitycredentials_v1alpha.html |  111 ++
 ...tidentitycredentials_v1alpha.projects.html |   91 +
 ...s.locations.authProviders.credentials.html |  166 ++
 ...lpha.projects.locations.authProviders.html |   91 +
 ...redentials_v1alpha.projects.locations.html |   91 +
 docs/dyn/agentidentitycredentials_v1beta.html |  111 ++
 ...ntidentitycredentials_v1beta.projects.html |   91 +
 ...s.locations.authProviders.credentials.html |  166 ++
 ...beta.projects.locations.authProviders.html |   91 +
 ...credentials_v1beta.projects.locations.html |   91 +
 ...dr_v1.projects.locations.backupVaults.html |   10 +-
 ...cy_v2.projects.locations.dataPolicies.html |   16 +-
 ...customers.enterprise.securityInsights.html |    8 +-
 ...romepolicy_v1.customers.policySchemas.html |    4 +-
 docs/dyn/classroom_v1.courses.html            |    2 +-
 ...ts.locations.singleTenantHsmInstances.html |    6 +-
 docs/dyn/cloudtrace_v1.projects.html          |   16 +-
 docs/dyn/cloudtrace_v1.projects.traces.html   |   38 +-
 docs/dyn/cloudtrace_v2.projects.traces.html   |  144 +-
 .../cloudtrace_v2.projects.traces.spans.html  |  290 ++--
 ...config_v1.projects.locations.previews.html |    6 +-
 docs/dyn/css_v1.accounts.quotas.html          |    2 +-
 docs/dyn/dns_v1.changes.html                  |    4 +-
 docs/dyn/dns_v1.managedZones.html             |    4 +-
 docs/dyn/dns_v1beta2.changes.html             |    4 +-
 docs/dyn/dns_v1beta2.managedZones.html        |    4 +-
 ...ta1.projects.androidApps.deliveryData.html |    2 +-
 ...storage_v1beta.projects.defaultBucket.html |    4 +-
 docs/dyn/firebasestorage_v1beta.projects.html |    2 +-
 ...ooker_v1.projects.locations.instances.html |    4 +-
 ...nessbusinessinformation_v1.attributes.html |   10 +-
 ...books_v2.projects.locations.instances.html |   50 +-
 ...locations.orgPolicyViolationsPreviews.html |    6 +-
 ...locations.orgPolicyViolationsPreviews.html |    8 +-
 .../dyn/pubsub_v1.projects.subscriptions.html |   12 +-
 ...iptionlinking_v1.publications.readers.html |    6 +-
 ....locations.catalogs.branches.products.html |   16 +-
 ...rojects.locations.catalogs.placements.html |   12 +-
 ...cts.locations.catalogs.servingConfigs.html |   12 +-
 ...rojects.locations.catalogs.userEvents.html |   34 +-
 docs/dyn/retail_v2alpha.projects.html         |   16 +-
 ....projects.locations.catalogs.branches.html |    4 +-
 ....locations.catalogs.branches.products.html |   16 +-
 ...rojects.locations.catalogs.placements.html |   12 +-
 ...cts.locations.catalogs.servingConfigs.html |   12 +-
 ...rojects.locations.catalogs.userEvents.html |   34 +-
 ...retail_v2alpha.projects.retailProject.html |    2 +-
 ....locations.catalogs.branches.products.html |   16 +-
 ...rojects.locations.catalogs.placements.html |   12 +-
 ...cts.locations.catalogs.servingConfigs.html |   12 +-
 ...rojects.locations.catalogs.userEvents.html |   34 +-
 ...ger_v1.projects.locations.deployments.html |    6 +-
 .../documents/agentidentity.v1.json           | 1546 +++++++++++++++++
 .../documents/agentidentity.v1alpha.json      | 1546 +++++++++++++++++
 .../documents/agentidentity.v1beta.json       | 1546 +++++++++++++++++
 .../agentidentitycredentials.v1.json          |  325 ++++
 .../agentidentitycredentials.v1alpha.json     |  325 ++++
 .../agentidentitycredentials.v1beta.json      |  325 ++++
 .../documents/alertcenter.v1beta1.json        |    8 +-
 .../documents/backupdr.v1.json                |    4 +-
 .../documents/bigquerydatapolicy.v2.json      |    4 +-
 .../documents/chromemanagement.v1.json        |    6 +-
 .../documents/chromepolicy.v1.json            |    4 +-
 .../documents/classroom.v1.json               |    4 +-
 .../documents/cloudkms.v1.json                |    4 +-
 .../documents/cloudtrace.v1.json              |   24 +-
 .../documents/cloudtrace.v2.json              |   88 +-
 .../discovery_cache/documents/config.v1.json  |    4 +-
 .../discovery_cache/documents/css.v1.json     |    4 +-
 .../discovery_cache/documents/dns.v1.json     |    6 +-
 .../documents/dns.v1beta2.json                |    6 +-
 .../documents/fcmdata.v1beta1.json            |    4 +-
 .../documents/firebasestorage.v1beta.json     |    4 +-
 .../discovery_cache/documents/looker.v1.json  |    6 +-
 .../mybusinessbusinessinformation.v1.json     |   12 +-
 .../documents/notebooks.v2.json               |   14 +-
 .../documents/policysimulator.v1.json         |    4 +-
 .../documents/policysimulator.v1alpha.json    |    4 +-
 .../documents/policysimulator.v1beta.json     |    4 +-
 .../discovery_cache/documents/pubsub.v1.json  |    4 +-
 .../readerrevenuesubscriptionlinking.v1.json  |    4 +-
 .../discovery_cache/documents/retail.v2.json  |   14 +-
 .../documents/retail.v2alpha.json             |   24 +-
 .../documents/retail.v2beta.json              |   14 +-
 .../documents/workloadmanager.v1.json         |    4 +-
 108 files changed, 13087 insertions(+), 596 deletions(-)
 create mode 100644 docs/dyn/agentidentity_v1.html
 create mode 100644 docs/dyn/agentidentity_v1.projects.html
 create mode 100644 docs/dyn/agentidentity_v1.projects.locations.accessSummaries.html
 create mode 100644 docs/dyn/agentidentity_v1.projects.locations.authProviders.authorizations.html
 create mode 100644 docs/dyn/agentidentity_v1.projects.locations.authProviders.html
 create mode 100644 docs/dyn/agentidentity_v1.projects.locations.html
 create mode 100644 docs/dyn/agentidentity_v1alpha.html
 create mode 100644 docs/dyn/agentidentity_v1alpha.projects.html
 create mode 100644 docs/dyn/agentidentity_v1alpha.projects.locations.accessSummaries.html
 create mode 100644 docs/dyn/agentidentity_v1alpha.projects.locations.authProviders.authorizations.html
 create mode 100644 docs/dyn/agentidentity_v1alpha.projects.locations.authProviders.html
 create mode 100644 docs/dyn/agentidentity_v1alpha.projects.locations.html
 create mode 100644 docs/dyn/agentidentity_v1beta.html
 create mode 100644 docs/dyn/agentidentity_v1beta.projects.html
 create mode 100644 docs/dyn/agentidentity_v1beta.projects.locations.accessSummaries.html
 create mode 100644 docs/dyn/agentidentity_v1beta.projects.locations.authProviders.authorizations.html
 create mode 100644 docs/dyn/agentidentity_v1beta.projects.locations.authProviders.html
 create mode 100644 docs/dyn/agentidentity_v1beta.projects.locations.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1.projects.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1.projects.locations.authProviders.credentials.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1.projects.locations.authProviders.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1.projects.locations.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1alpha.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1alpha.projects.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1alpha.projects.locations.authProviders.credentials.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1alpha.projects.locations.authProviders.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1alpha.projects.locations.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1beta.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1beta.projects.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1beta.projects.locations.authProviders.credentials.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1beta.projects.locations.authProviders.html
 create mode 100644 docs/dyn/agentidentitycredentials_v1beta.projects.locations.html
 create mode 100644 googleapiclient/discovery_cache/documents/agentidentity.v1.json
 create mode 100644 googleapiclient/discovery_cache/documents/agentidentity.v1alpha.json
 create mode 100644 googleapiclient/discovery_cache/documents/agentidentity.v1beta.json
 create mode 100644 googleapiclient/discovery_cache/documents/agentidentitycredentials.v1.json
 create mode 100644 googleapiclient/discovery_cache/documents/agentidentitycredentials.v1alpha.json
 create mode 100644 googleapiclient/discovery_cache/documents/agentidentitycredentials.v1beta.json

diff --git a/docs/dyn/agentidentity_v1.html b/docs/dyn/agentidentity_v1.html
new file mode 100644
index 0000000000..877df76ac9
--- /dev/null
+++ b/docs/dyn/agentidentity_v1.html
@@ -0,0 +1,111 @@
+
+
+
+

Agent Identity API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1.projects.html b/docs/dyn/agentidentity_v1.projects.html new file mode 100644 index 0000000000..11fe30ce75 --- /dev/null +++ b/docs/dyn/agentidentity_v1.projects.html @@ -0,0 +1,91 @@ + + + +

Agent Identity API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1.projects.locations.accessSummaries.html b/docs/dyn/agentidentity_v1.projects.locations.accessSummaries.html new file mode 100644 index 0000000000..28aa8c9898 --- /dev/null +++ b/docs/dyn/agentidentity_v1.projects.locations.accessSummaries.html @@ -0,0 +1,187 @@ + + + +

Agent Identity API . projects . locations . accessSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details of a single AccessSummary.

+

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

+

Lists AccessSummaries in a given project and location. Supported Filters: - `workload_id`: Filter by the SPIFFE ID of the agent. Example: `workload_id="spiffe://example.com/ns/default/sa/my-agent"`

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single AccessSummary.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AccessSummary object
+  "authProvider": "A String", # Output only. The auth_provider that this access summary is associated with.
+  "authProviderType": "A String", # Output only. The type of the connector that was used to create this access summary.
+  "firstAccessTime": "A String", # Output only. The first time this user has interacted with this workload. Rounded to the previous hour.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "lastAccessTime": "A String", # Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour.
+  "name": "A String", # Output only. Identifier. Name of the AccessSummary
+  "purgeTime": "A String", # Output only. The time when this access summary is permanently deleted.
+  "scopes": [ # Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.
+    "A String",
+  ],
+  "tokenUrl": "A String", # Output only. The url of the authentication server that was accessed.
+  "userId": "A String", # Output only. The user_id provided by the workload application for this user. Not verified by Google.
+  "workloadId": "A String", # Output only. The identity bound to the workload that this user interacted with to produce this AccessSummary. Will typically be an agentic spiffe id
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists AccessSummaries in a given project and location. Supported Filters: - `workload_id`: Filter by the SPIFFE ID of the agent. Example: `workload_id="spiffe://example.com/ns/default/sa/my-agent"`
+
+Args:
+  parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. Filter string to restrict the results. Currently supports filtering by `workload_id` or `auth_provider_name`. If no filter is provided, returns all access summaries for the requested project and location. Format: `workload_id=""` or `auth_provider_name=""`
+  orderBy: string, Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.
+  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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing AccessSummaries
+  "accessSummaries": [ # The list of AccessSummary
+    { # Message describing AccessSummary object
+      "authProvider": "A String", # Output only. The auth_provider that this access summary is associated with.
+      "authProviderType": "A String", # Output only. The type of the connector that was used to create this access summary.
+      "firstAccessTime": "A String", # Output only. The first time this user has interacted with this workload. Rounded to the previous hour.
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "lastAccessTime": "A String", # Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour.
+      "name": "A String", # Output only. Identifier. Name of the AccessSummary
+      "purgeTime": "A String", # Output only. The time when this access summary is permanently deleted.
+      "scopes": [ # Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.
+        "A String",
+      ],
+      "tokenUrl": "A String", # Output only. The url of the authentication server that was accessed.
+      "userId": "A String", # Output only. The user_id provided by the workload application for this user. Not verified by Google.
+      "workloadId": "A String", # Output only. The identity bound to the workload that this user interacted with to produce this AccessSummary. Will typically be an agentic spiffe id
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1.projects.locations.authProviders.authorizations.html b/docs/dyn/agentidentity_v1.projects.locations.authProviders.authorizations.html new file mode 100644 index 0000000000..bb5581ebc0 --- /dev/null +++ b/docs/dyn/agentidentity_v1.projects.locations.authProviders.authorizations.html @@ -0,0 +1,195 @@ + + + +

Agent Identity API . projects . locations . authProviders . authorizations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Deletes a single Authorization.

+

+ get(name, x__xgafv=None)

+

Gets details of a single Authorization.

+

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

+

Lists Authorizations in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes a single Authorization.
+
+Args:
+  name: string, Required. The name of the Authorization to delete. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization} (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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 details of a single Authorization.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing Authorization object
+  "clientUserId": "A String", # Output only. The client_user_id provided by the client application for their end user. Not verified by Google.
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "name": "A String", # Identifier. name of resource
+  "scopes": [ # Output only. The scopes actually granted by the end user during the consent flow.
+    "A String",
+  ],
+  "state": "A String", # Output only. The state of the authorization.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Authorizations in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  filter: string, Optional. Filter string to restrict the results. Currently supports filtering by `client_user_id` only. Format: `client_user_id=""`
+  orderBy: string, Optional. This field is currently ignored. Defaults to ordering by authorization_id in ascending order.
+  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 page token, received from a previous `ListAuthorizations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAuthorizations` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing Authorizations
+  "authorizations": [ # The list of Authorization
+    { # Message describing Authorization object
+      "clientUserId": "A String", # Output only. The client_user_id provided by the client application for their end user. Not verified by Google.
+      "createTime": "A String", # Output only. [Output only] Create time stamp
+      "name": "A String", # Identifier. name of resource
+      "scopes": [ # Output only. The scopes actually granted by the end user during the consent flow.
+        "A String",
+      ],
+      "state": "A String", # Output only. The state of the authorization.
+      "updateTime": "A String", # Output only. [Output only] Update time stamp
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1.projects.locations.authProviders.html b/docs/dyn/agentidentity_v1.projects.locations.authProviders.html new file mode 100644 index 0000000000..d1b55655b2 --- /dev/null +++ b/docs/dyn/agentidentity_v1.projects.locations.authProviders.html @@ -0,0 +1,976 @@ + + + +

Agent Identity API . projects . locations . authProviders

+

Instance Methods

+

+ authorizations() +

+

Returns the authorizations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, authProviderId=None, body=None, requestId=None, x__xgafv=None)

+

Creates a new AuthProvider in a given project and location.

+

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

+

Deletes a single AuthProvider.

+

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

+

Disables a single AuthProvider.

+

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

+

Enables a single AuthProvider.

+

+ get(name, x__xgafv=None)

+

Gets details of a single AuthProvider.

+

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

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

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

+

Lists AuthProviders in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the parameters of a single AuthProvider.

+

+ query(parent, pageSize=None, pageToken=None, workloadId=None, x__xgafv=None)

+

Queries what all auth_providers are used by a given workload_id.

+

+ queryWorkloads(name, pageSize=None, pageToken=None, x__xgafv=None)

+

Queries what all workloads are using a given auth_provider.

+

+ queryWorkloads_next()

+

Retrieves the next page of results.

+

+ query_next()

+

Retrieves the next page of results.

+

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

+

Revokes all authorizations for a specific user on an AuthProvider. This deletes all authorization records associated with the user and AuthProvider, effectively revoking access across all agents.

+

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

+

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

+

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

+

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

+

Undeletes a single AuthProvider.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, authProviderId=None, body=None, requestId=None, x__xgafv=None) +
Creates a new AuthProvider in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource where the AuthProvider is created. Format: projects/{project}/locations/{location} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+  authProviderId: string, Required. The ID to use for the AuthProvider, which will become the final segment of the AuthProvider's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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); }
+}
+
+ +
+ disable(name, body=None, x__xgafv=None) +
Disables a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for disabling an AuthProvider
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ enable(name, body=None, x__xgafv=None) +
Enables a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for enabling an AuthProvider
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) +
Lists AuthProviders in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. Filter results. This field is currently ignored.
+  orderBy: string, Optional. Currently ignored. Defaults to ordering by auth_provider_id in ascending order.
+  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, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned.
+  showDeleted: boolean, Optional. Deleted auth_providers will be kept with a soft-delete for 30 days before being purged. If this field is set to true, deleted auth_providers will also be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing AuthProviders
+  "authProviders": [ # The list of AuthProvider
+    { # Message describing AuthProvider object
+      "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+        "A String",
+      ],
+      "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+        "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+          "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+        },
+        "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+        },
+        "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+          "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+          "clientId": "A String", # Optional. The client ID of the OAuth client.
+          "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+          "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+          "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+          "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+          "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+        },
+        "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+          "clientId": "A String", # Optional. The client ID of the OAuth client.
+          "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+          "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+        },
+      },
+      "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. [Output only] Create time stamp
+      "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+      "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+      "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+      "state": "A String", # Output only. The state of the auth_provider.
+      "updateTime": "A String", # Output only. [Output only] Update time stamp
+      "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+        "A String",
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single AuthProvider.
+
+Args:
+  name: string, Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the AuthProvider resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ query(parent, pageSize=None, pageToken=None, workloadId=None, x__xgafv=None) +
Queries what all auth_providers are used by a given workload_id.
+
+Args:
+  parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location} (required)
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000.
+  pageToken: string, Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned. A page token, received from a previous QueryAuthProviders call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryAuthProviders must match the call that provided the page token.
+  workloadId: string, Required. The workload identifier to filter by.
+  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 QueryAuthProviders.
+  "authProviderNames": [ # The unique list of auth_provider resource names used by the workload.
+    "A String",
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ queryWorkloads(name, pageSize=None, pageToken=None, x__xgafv=None) +
Queries what all workloads are using a given auth_provider.
+
+Args:
+  name: string, Required. The name of the auth_provider to query. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  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, which can be sent as `page_token` to retrieve the next page. When paginating, all other parameters provided to QueryWorkloads must match the call that provided the page token. If this field is omitted, the first page is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for QueryWorkloads.
+  "nextPageToken": "A String", # A token to retrieve the next page of results.
+  "workloadIds": [ # The unique list of workload identifiers (agents) that used the auth_provider.
+    "A String",
+  ],
+}
+
+ +
+ queryWorkloads_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ query_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ revokeAuthorization(name, body=None, x__xgafv=None) +
Revokes all authorizations for a specific user on an AuthProvider. This deletes all authorization records associated with the user and AuthProvider, effectively revoking access across all agents.
+
+Args:
+  name: string, Required. The resource name of the AuthProvider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for RevokeAuthorization.
+  "userId": "A String", # Required. The identity of the user to revoke authorization for.
+}
+
+  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 RevokeAuthorization.
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+
+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 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.
+
+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) +
Undeletes a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for undeleting a AuthProvider
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1.projects.locations.html b/docs/dyn/agentidentity_v1.projects.locations.html new file mode 100644 index 0000000000..f75e6ea9d0 --- /dev/null +++ b/docs/dyn/agentidentity_v1.projects.locations.html @@ -0,0 +1,182 @@ + + + +

Agent Identity API . projects . locations

+

Instance Methods

+

+ accessSummaries() +

+

Returns the accessSummaries Resource.

+ +

+ authProviders() +

+

Returns the authProviders Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets information about a location.

+

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

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets information about a location.
+
+Args:
+  name: string, Resource name for the location. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource that represents a Google Cloud location.
+  "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+  "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+    "a_key": "A String",
+  },
+  "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+  "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+}
+
+ +
+ list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+
+Args:
+  name: string, The resource that owns the locations collection, if applicable. (required)
+  extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+  pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
+  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 Locations.ListLocations.
+  "locations": [ # A list of locations that matches the specified filter in the request.
+    { # A resource that represents a Google Cloud location.
+      "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+      "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+        "a_key": "A String",
+      },
+      "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+      "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+    },
+  ],
+  "nextPageToken": "A String", # The standard List next-page token.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1alpha.html b/docs/dyn/agentidentity_v1alpha.html new file mode 100644 index 0000000000..967045d91a --- /dev/null +++ b/docs/dyn/agentidentity_v1alpha.html @@ -0,0 +1,111 @@ + + + +

Agent Identity API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1alpha.projects.html b/docs/dyn/agentidentity_v1alpha.projects.html new file mode 100644 index 0000000000..c5a5519bcc --- /dev/null +++ b/docs/dyn/agentidentity_v1alpha.projects.html @@ -0,0 +1,91 @@ + + + +

Agent Identity API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1alpha.projects.locations.accessSummaries.html b/docs/dyn/agentidentity_v1alpha.projects.locations.accessSummaries.html new file mode 100644 index 0000000000..77c094f17a --- /dev/null +++ b/docs/dyn/agentidentity_v1alpha.projects.locations.accessSummaries.html @@ -0,0 +1,187 @@ + + + +

Agent Identity API . projects . locations . accessSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details of a single AccessSummary.

+

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

+

Lists AccessSummaries in a given project and location. Supported Filters: - `workload_id`: Filter by the SPIFFE ID of the agent. Example: `workload_id="spiffe://example.com/ns/default/sa/my-agent"`

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single AccessSummary.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AccessSummary object
+  "authProvider": "A String", # Output only. The auth_provider that this access summary is associated with.
+  "authProviderType": "A String", # Output only. The type of the connector that was used to create this access summary.
+  "firstAccessTime": "A String", # Output only. The first time this user has interacted with this workload. Rounded to the previous hour.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "lastAccessTime": "A String", # Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour.
+  "name": "A String", # Output only. Identifier. Name of the AccessSummary
+  "purgeTime": "A String", # Output only. The time when this access summary is permanently deleted.
+  "scopes": [ # Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.
+    "A String",
+  ],
+  "tokenUrl": "A String", # Output only. The url of the authentication server that was accessed.
+  "userId": "A String", # Output only. The user_id provided by the workload application for this user. Not verified by Google.
+  "workloadId": "A String", # Output only. The identity bound to the workload that this user interacted with to produce this AccessSummary. Will typically be an agentic spiffe id
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists AccessSummaries in a given project and location. Supported Filters: - `workload_id`: Filter by the SPIFFE ID of the agent. Example: `workload_id="spiffe://example.com/ns/default/sa/my-agent"`
+
+Args:
+  parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. Filter string to restrict the results. Currently supports filtering by `workload_id` or `auth_provider_name`. If no filter is provided, returns all access summaries for the requested project and location. Format: `workload_id=""` or `auth_provider_name=""`
+  orderBy: string, Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.
+  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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing AccessSummaries
+  "accessSummaries": [ # The list of AccessSummary
+    { # Message describing AccessSummary object
+      "authProvider": "A String", # Output only. The auth_provider that this access summary is associated with.
+      "authProviderType": "A String", # Output only. The type of the connector that was used to create this access summary.
+      "firstAccessTime": "A String", # Output only. The first time this user has interacted with this workload. Rounded to the previous hour.
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "lastAccessTime": "A String", # Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour.
+      "name": "A String", # Output only. Identifier. Name of the AccessSummary
+      "purgeTime": "A String", # Output only. The time when this access summary is permanently deleted.
+      "scopes": [ # Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.
+        "A String",
+      ],
+      "tokenUrl": "A String", # Output only. The url of the authentication server that was accessed.
+      "userId": "A String", # Output only. The user_id provided by the workload application for this user. Not verified by Google.
+      "workloadId": "A String", # Output only. The identity bound to the workload that this user interacted with to produce this AccessSummary. Will typically be an agentic spiffe id
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1alpha.projects.locations.authProviders.authorizations.html b/docs/dyn/agentidentity_v1alpha.projects.locations.authProviders.authorizations.html new file mode 100644 index 0000000000..a9f4e86595 --- /dev/null +++ b/docs/dyn/agentidentity_v1alpha.projects.locations.authProviders.authorizations.html @@ -0,0 +1,195 @@ + + + +

Agent Identity API . projects . locations . authProviders . authorizations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Deletes a single Authorization.

+

+ get(name, x__xgafv=None)

+

Gets details of a single Authorization.

+

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

+

Lists Authorizations in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes a single Authorization.
+
+Args:
+  name: string, Required. The name of the Authorization to delete. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization} (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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 details of a single Authorization.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing Authorization object
+  "clientUserId": "A String", # Output only. The client_user_id provided by the client application for their end user. Not verified by Google.
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "name": "A String", # Identifier. name of resource
+  "scopes": [ # Output only. The scopes actually granted by the end user during the consent flow.
+    "A String",
+  ],
+  "state": "A String", # Output only. The state of the authorization.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Authorizations in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  filter: string, Optional. Filter string to restrict the results. Currently supports filtering by `client_user_id` only. Format: `client_user_id=""`
+  orderBy: string, Optional. This field is currently ignored. Defaults to ordering by authorization_id in ascending order.
+  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 page token, received from a previous `ListAuthorizations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAuthorizations` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing Authorizations
+  "authorizations": [ # The list of Authorization
+    { # Message describing Authorization object
+      "clientUserId": "A String", # Output only. The client_user_id provided by the client application for their end user. Not verified by Google.
+      "createTime": "A String", # Output only. [Output only] Create time stamp
+      "name": "A String", # Identifier. name of resource
+      "scopes": [ # Output only. The scopes actually granted by the end user during the consent flow.
+        "A String",
+      ],
+      "state": "A String", # Output only. The state of the authorization.
+      "updateTime": "A String", # Output only. [Output only] Update time stamp
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1alpha.projects.locations.authProviders.html b/docs/dyn/agentidentity_v1alpha.projects.locations.authProviders.html new file mode 100644 index 0000000000..d6ef59fa3e --- /dev/null +++ b/docs/dyn/agentidentity_v1alpha.projects.locations.authProviders.html @@ -0,0 +1,976 @@ + + + +

Agent Identity API . projects . locations . authProviders

+

Instance Methods

+

+ authorizations() +

+

Returns the authorizations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, authProviderId=None, body=None, requestId=None, x__xgafv=None)

+

Creates a new AuthProvider in a given project and location.

+

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

+

Deletes a single AuthProvider.

+

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

+

Disables a single AuthProvider.

+

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

+

Enables a single AuthProvider.

+

+ get(name, x__xgafv=None)

+

Gets details of a single AuthProvider.

+

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

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

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

+

Lists AuthProviders in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the parameters of a single AuthProvider.

+

+ query(parent, pageSize=None, pageToken=None, workloadId=None, x__xgafv=None)

+

Queries what all auth_providers are used by a given workload_id.

+

+ queryWorkloads(name, pageSize=None, pageToken=None, x__xgafv=None)

+

Queries what all workloads are using a given auth_provider.

+

+ queryWorkloads_next()

+

Retrieves the next page of results.

+

+ query_next()

+

Retrieves the next page of results.

+

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

+

Revokes all authorizations for a specific user on an AuthProvider. This deletes all authorization records associated with the user and AuthProvider, effectively revoking access across all agents.

+

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

+

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

+

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

+

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

+

Undeletes a single AuthProvider.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, authProviderId=None, body=None, requestId=None, x__xgafv=None) +
Creates a new AuthProvider in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource where the AuthProvider is created. Format: projects/{project}/locations/{location} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+  authProviderId: string, Required. The ID to use for the AuthProvider, which will become the final segment of the AuthProvider's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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); }
+}
+
+ +
+ disable(name, body=None, x__xgafv=None) +
Disables a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for disabling an AuthProvider
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ enable(name, body=None, x__xgafv=None) +
Enables a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for enabling an AuthProvider
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) +
Lists AuthProviders in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. Filter results. This field is currently ignored.
+  orderBy: string, Optional. Currently ignored. Defaults to ordering by auth_provider_id in ascending order.
+  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, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned.
+  showDeleted: boolean, Optional. Deleted auth_providers will be kept with a soft-delete for 30 days before being purged. If this field is set to true, deleted auth_providers will also be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing AuthProviders
+  "authProviders": [ # The list of AuthProvider
+    { # Message describing AuthProvider object
+      "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+        "A String",
+      ],
+      "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+        "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+          "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+        },
+        "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+        },
+        "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+          "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+          "clientId": "A String", # Optional. The client ID of the OAuth client.
+          "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+          "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+          "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+          "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+          "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+        },
+        "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+          "clientId": "A String", # Optional. The client ID of the OAuth client.
+          "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+          "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+        },
+      },
+      "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. [Output only] Create time stamp
+      "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+      "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+      "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+      "state": "A String", # Output only. The state of the auth_provider.
+      "updateTime": "A String", # Output only. [Output only] Update time stamp
+      "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+        "A String",
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single AuthProvider.
+
+Args:
+  name: string, Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the AuthProvider resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ query(parent, pageSize=None, pageToken=None, workloadId=None, x__xgafv=None) +
Queries what all auth_providers are used by a given workload_id.
+
+Args:
+  parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location} (required)
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000.
+  pageToken: string, Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned. A page token, received from a previous QueryAuthProviders call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryAuthProviders must match the call that provided the page token.
+  workloadId: string, Required. The workload identifier to filter by.
+  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 QueryAuthProviders.
+  "authProviderNames": [ # The unique list of auth_provider resource names used by the workload.
+    "A String",
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ queryWorkloads(name, pageSize=None, pageToken=None, x__xgafv=None) +
Queries what all workloads are using a given auth_provider.
+
+Args:
+  name: string, Required. The name of the auth_provider to query. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  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, which can be sent as `page_token` to retrieve the next page. When paginating, all other parameters provided to QueryWorkloads must match the call that provided the page token. If this field is omitted, the first page is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for QueryWorkloads.
+  "nextPageToken": "A String", # A token to retrieve the next page of results.
+  "workloadIds": [ # The unique list of workload identifiers (agents) that used the auth_provider.
+    "A String",
+  ],
+}
+
+ +
+ queryWorkloads_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ query_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ revokeAuthorization(name, body=None, x__xgafv=None) +
Revokes all authorizations for a specific user on an AuthProvider. This deletes all authorization records associated with the user and AuthProvider, effectively revoking access across all agents.
+
+Args:
+  name: string, Required. The resource name of the AuthProvider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for RevokeAuthorization.
+  "userId": "A String", # Required. The identity of the user to revoke authorization for.
+}
+
+  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 RevokeAuthorization.
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+
+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 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.
+
+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) +
Undeletes a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for undeleting a AuthProvider
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1alpha.projects.locations.html b/docs/dyn/agentidentity_v1alpha.projects.locations.html new file mode 100644 index 0000000000..78bec947ef --- /dev/null +++ b/docs/dyn/agentidentity_v1alpha.projects.locations.html @@ -0,0 +1,182 @@ + + + +

Agent Identity API . projects . locations

+

Instance Methods

+

+ accessSummaries() +

+

Returns the accessSummaries Resource.

+ +

+ authProviders() +

+

Returns the authProviders Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets information about a location.

+

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

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets information about a location.
+
+Args:
+  name: string, Resource name for the location. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource that represents a Google Cloud location.
+  "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+  "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+    "a_key": "A String",
+  },
+  "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+  "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+}
+
+ +
+ list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+
+Args:
+  name: string, The resource that owns the locations collection, if applicable. (required)
+  extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+  pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
+  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 Locations.ListLocations.
+  "locations": [ # A list of locations that matches the specified filter in the request.
+    { # A resource that represents a Google Cloud location.
+      "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+      "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+        "a_key": "A String",
+      },
+      "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+      "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+    },
+  ],
+  "nextPageToken": "A String", # The standard List next-page token.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1beta.html b/docs/dyn/agentidentity_v1beta.html new file mode 100644 index 0000000000..cbc491d496 --- /dev/null +++ b/docs/dyn/agentidentity_v1beta.html @@ -0,0 +1,111 @@ + + + +

Agent Identity API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1beta.projects.html b/docs/dyn/agentidentity_v1beta.projects.html new file mode 100644 index 0000000000..743a9eb213 --- /dev/null +++ b/docs/dyn/agentidentity_v1beta.projects.html @@ -0,0 +1,91 @@ + + + +

Agent Identity API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1beta.projects.locations.accessSummaries.html b/docs/dyn/agentidentity_v1beta.projects.locations.accessSummaries.html new file mode 100644 index 0000000000..befbd438a6 --- /dev/null +++ b/docs/dyn/agentidentity_v1beta.projects.locations.accessSummaries.html @@ -0,0 +1,187 @@ + + + +

Agent Identity API . projects . locations . accessSummaries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details of a single AccessSummary.

+

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

+

Lists AccessSummaries in a given project and location. Supported Filters: - `workload_id`: Filter by the SPIFFE ID of the agent. Example: `workload_id="spiffe://example.com/ns/default/sa/my-agent"`

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single AccessSummary.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AccessSummary object
+  "authProvider": "A String", # Output only. The auth_provider that this access summary is associated with.
+  "authProviderType": "A String", # Output only. The type of the connector that was used to create this access summary.
+  "firstAccessTime": "A String", # Output only. The first time this user has interacted with this workload. Rounded to the previous hour.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "lastAccessTime": "A String", # Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour.
+  "name": "A String", # Output only. Identifier. Name of the AccessSummary
+  "purgeTime": "A String", # Output only. The time when this access summary is permanently deleted.
+  "scopes": [ # Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.
+    "A String",
+  ],
+  "tokenUrl": "A String", # Output only. The url of the authentication server that was accessed.
+  "userId": "A String", # Output only. The user_id provided by the workload application for this user. Not verified by Google.
+  "workloadId": "A String", # Output only. The identity bound to the workload that this user interacted with to produce this AccessSummary. Will typically be an agentic spiffe id
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists AccessSummaries in a given project and location. Supported Filters: - `workload_id`: Filter by the SPIFFE ID of the agent. Example: `workload_id="spiffe://example.com/ns/default/sa/my-agent"`
+
+Args:
+  parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. Filter string to restrict the results. Currently supports filtering by `workload_id` or `auth_provider_name`. If no filter is provided, returns all access summaries for the requested project and location. Format: `workload_id=""` or `auth_provider_name=""`
+  orderBy: string, Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.
+  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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing AccessSummaries
+  "accessSummaries": [ # The list of AccessSummary
+    { # Message describing AccessSummary object
+      "authProvider": "A String", # Output only. The auth_provider that this access summary is associated with.
+      "authProviderType": "A String", # Output only. The type of the connector that was used to create this access summary.
+      "firstAccessTime": "A String", # Output only. The first time this user has interacted with this workload. Rounded to the previous hour.
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "lastAccessTime": "A String", # Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour.
+      "name": "A String", # Output only. Identifier. Name of the AccessSummary
+      "purgeTime": "A String", # Output only. The time when this access summary is permanently deleted.
+      "scopes": [ # Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.
+        "A String",
+      ],
+      "tokenUrl": "A String", # Output only. The url of the authentication server that was accessed.
+      "userId": "A String", # Output only. The user_id provided by the workload application for this user. Not verified by Google.
+      "workloadId": "A String", # Output only. The identity bound to the workload that this user interacted with to produce this AccessSummary. Will typically be an agentic spiffe id
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1beta.projects.locations.authProviders.authorizations.html b/docs/dyn/agentidentity_v1beta.projects.locations.authProviders.authorizations.html new file mode 100644 index 0000000000..b76210f9c7 --- /dev/null +++ b/docs/dyn/agentidentity_v1beta.projects.locations.authProviders.authorizations.html @@ -0,0 +1,195 @@ + + + +

Agent Identity API . projects . locations . authProviders . authorizations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Deletes a single Authorization.

+

+ get(name, x__xgafv=None)

+

Gets details of a single Authorization.

+

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

+

Lists Authorizations in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes a single Authorization.
+
+Args:
+  name: string, Required. The name of the Authorization to delete. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization} (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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 details of a single Authorization.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing Authorization object
+  "clientUserId": "A String", # Output only. The client_user_id provided by the client application for their end user. Not verified by Google.
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "name": "A String", # Identifier. name of resource
+  "scopes": [ # Output only. The scopes actually granted by the end user during the consent flow.
+    "A String",
+  ],
+  "state": "A String", # Output only. The state of the authorization.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Authorizations in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  filter: string, Optional. Filter string to restrict the results. Currently supports filtering by `client_user_id` only. Format: `client_user_id=""`
+  orderBy: string, Optional. This field is currently ignored. Defaults to ordering by authorization_id in ascending order.
+  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 page token, received from a previous `ListAuthorizations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAuthorizations` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing Authorizations
+  "authorizations": [ # The list of Authorization
+    { # Message describing Authorization object
+      "clientUserId": "A String", # Output only. The client_user_id provided by the client application for their end user. Not verified by Google.
+      "createTime": "A String", # Output only. [Output only] Create time stamp
+      "name": "A String", # Identifier. name of resource
+      "scopes": [ # Output only. The scopes actually granted by the end user during the consent flow.
+        "A String",
+      ],
+      "state": "A String", # Output only. The state of the authorization.
+      "updateTime": "A String", # Output only. [Output only] Update time stamp
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1beta.projects.locations.authProviders.html b/docs/dyn/agentidentity_v1beta.projects.locations.authProviders.html new file mode 100644 index 0000000000..d560811531 --- /dev/null +++ b/docs/dyn/agentidentity_v1beta.projects.locations.authProviders.html @@ -0,0 +1,976 @@ + + + +

Agent Identity API . projects . locations . authProviders

+

Instance Methods

+

+ authorizations() +

+

Returns the authorizations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, authProviderId=None, body=None, requestId=None, x__xgafv=None)

+

Creates a new AuthProvider in a given project and location.

+

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

+

Deletes a single AuthProvider.

+

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

+

Disables a single AuthProvider.

+

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

+

Enables a single AuthProvider.

+

+ get(name, x__xgafv=None)

+

Gets details of a single AuthProvider.

+

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

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

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

+

Lists AuthProviders in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the parameters of a single AuthProvider.

+

+ query(parent, pageSize=None, pageToken=None, workloadId=None, x__xgafv=None)

+

Queries what all auth_providers are used by a given workload_id.

+

+ queryWorkloads(name, pageSize=None, pageToken=None, x__xgafv=None)

+

Queries what all workloads are using a given auth_provider.

+

+ queryWorkloads_next()

+

Retrieves the next page of results.

+

+ query_next()

+

Retrieves the next page of results.

+

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

+

Revokes all authorizations for a specific user on an AuthProvider. This deletes all authorization records associated with the user and AuthProvider, effectively revoking access across all agents.

+

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

+

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

+

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

+

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

+

Undeletes a single AuthProvider.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, authProviderId=None, body=None, requestId=None, x__xgafv=None) +
Creates a new AuthProvider in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource where the AuthProvider is created. Format: projects/{project}/locations/{location} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+  authProviderId: string, Required. The ID to use for the AuthProvider, which will become the final segment of the AuthProvider's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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); }
+}
+
+ +
+ disable(name, body=None, x__xgafv=None) +
Disables a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for disabling an AuthProvider
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ enable(name, body=None, x__xgafv=None) +
Enables a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for enabling an AuthProvider
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) +
Lists AuthProviders in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. Filter results. This field is currently ignored.
+  orderBy: string, Optional. Currently ignored. Defaults to ordering by auth_provider_id in ascending order.
+  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, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned.
+  showDeleted: boolean, Optional. Deleted auth_providers will be kept with a soft-delete for 30 days before being purged. If this field is set to true, deleted auth_providers will also be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing AuthProviders
+  "authProviders": [ # The list of AuthProvider
+    { # Message describing AuthProvider object
+      "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+        "A String",
+      ],
+      "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+        "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+          "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+        },
+        "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+        },
+        "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+          "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+          "clientId": "A String", # Optional. The client ID of the OAuth client.
+          "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+          "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+          "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+          "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+          "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+        },
+        "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+          "clientId": "A String", # Optional. The client ID of the OAuth client.
+          "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+          "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+        },
+      },
+      "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. [Output only] Create time stamp
+      "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+      "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+      "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+      "state": "A String", # Output only. The state of the auth_provider.
+      "updateTime": "A String", # Output only. [Output only] Update time stamp
+      "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+        "A String",
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single AuthProvider.
+
+Args:
+  name: string, Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the AuthProvider resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ +
+ query(parent, pageSize=None, pageToken=None, workloadId=None, x__xgafv=None) +
Queries what all auth_providers are used by a given workload_id.
+
+Args:
+  parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location} (required)
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000.
+  pageToken: string, Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned. A page token, received from a previous QueryAuthProviders call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryAuthProviders must match the call that provided the page token.
+  workloadId: string, Required. The workload identifier to filter by.
+  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 QueryAuthProviders.
+  "authProviderNames": [ # The unique list of auth_provider resource names used by the workload.
+    "A String",
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ queryWorkloads(name, pageSize=None, pageToken=None, x__xgafv=None) +
Queries what all workloads are using a given auth_provider.
+
+Args:
+  name: string, Required. The name of the auth_provider to query. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  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, which can be sent as `page_token` to retrieve the next page. When paginating, all other parameters provided to QueryWorkloads must match the call that provided the page token. If this field is omitted, the first page is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for QueryWorkloads.
+  "nextPageToken": "A String", # A token to retrieve the next page of results.
+  "workloadIds": [ # The unique list of workload identifiers (agents) that used the auth_provider.
+    "A String",
+  ],
+}
+
+ +
+ queryWorkloads_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ query_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ revokeAuthorization(name, body=None, x__xgafv=None) +
Revokes all authorizations for a specific user on an AuthProvider. This deletes all authorization records associated with the user and AuthProvider, effectively revoking access across all agents.
+
+Args:
+  name: string, Required. The resource name of the AuthProvider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for RevokeAuthorization.
+  "userId": "A String", # Required. The identity of the user to revoke authorization for.
+}
+
+  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 RevokeAuthorization.
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+
+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 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.
+
+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) +
Undeletes a single AuthProvider.
+
+Args:
+  name: string, Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for undeleting a AuthProvider
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing AuthProvider object
+  "allowedScopes": [ # Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.
+    "A String",
+  ],
+  "authProviderTypeParams": { # AuthProvider type specific parameters. Required when creating an auth_provider. # Required. AuthProvider type specific parameters.
+    "apiKey": { # Message describing ApiKeyParams object. # ApiKey AuthProvider type parameters.
+      "apiKey": "A String", # Optional. Input only. The API key for this auth_provider.
+    },
+    "geAuthProvider": { # Message describing GeminiEnterpriseAuthProviderParams object. # GeminiEnterprise auth_provider type parameters.
+    },
+    "threeLeggedOauth": { # Message describing ThreeLeggedOAuth object. # ThreeLeggedOAuth AuthProvider type parameters.
+      "authorizationUrl": "A String", # Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "defaultContinueUri": "A String", # Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
+      "enablePkce": True or False, # Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
+      "redirectUrl": "A String", # Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
+      "tokenUrl": "A String", # Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
+    },
+    "twoLeggedOauth": { # Message describing TwoLeggedOAuth object. # TwoLeggedOAuth AuthProvider type parameters.
+      "clientId": "A String", # Optional. The client ID of the OAuth client.
+      "clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client.
+      "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client.
+    },
+  },
+  "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "deleted": True or False, # Output only. This is set to true if the auth_provider is deleted.
+  "description": "A String", # Optional. Description of the resource. Must be less than 256 characters.
+  "expireTime": "A String", # Output only. The time when the auth_provider will expire.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
+  "state": "A String", # Output only. The state of the auth_provider.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "workloadIds": [ # Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentity_v1beta.projects.locations.html b/docs/dyn/agentidentity_v1beta.projects.locations.html new file mode 100644 index 0000000000..cbc7a20c49 --- /dev/null +++ b/docs/dyn/agentidentity_v1beta.projects.locations.html @@ -0,0 +1,182 @@ + + + +

Agent Identity API . projects . locations

+

Instance Methods

+

+ accessSummaries() +

+

Returns the accessSummaries Resource.

+ +

+ authProviders() +

+

Returns the authProviders Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets information about a location.

+

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

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets information about a location.
+
+Args:
+  name: string, Resource name for the location. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource that represents a Google Cloud location.
+  "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+  "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+    "a_key": "A String",
+  },
+  "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+  "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+}
+
+ +
+ list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+
+Args:
+  name: string, The resource that owns the locations collection, if applicable. (required)
+  extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+  pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
+  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 Locations.ListLocations.
+  "locations": [ # A list of locations that matches the specified filter in the request.
+    { # A resource that represents a Google Cloud location.
+      "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+      "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+        "a_key": "A String",
+      },
+      "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+      "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+    },
+  ],
+  "nextPageToken": "A String", # The standard List next-page token.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentitycredentials_v1.html b/docs/dyn/agentidentitycredentials_v1.html new file mode 100644 index 0000000000..7d0c9d5fef --- /dev/null +++ b/docs/dyn/agentidentitycredentials_v1.html @@ -0,0 +1,111 @@ + + + +

Agent Identity Credentials API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentitycredentials_v1.projects.html b/docs/dyn/agentidentitycredentials_v1.projects.html new file mode 100644 index 0000000000..4caf6b2d48 --- /dev/null +++ b/docs/dyn/agentidentitycredentials_v1.projects.html @@ -0,0 +1,91 @@ + + + +

Agent Identity Credentials API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentitycredentials_v1.projects.locations.authProviders.credentials.html b/docs/dyn/agentidentitycredentials_v1.projects.locations.authProviders.credentials.html new file mode 100644 index 0000000000..9ccb78e481 --- /dev/null +++ b/docs/dyn/agentidentitycredentials_v1.projects.locations.authProviders.credentials.html @@ -0,0 +1,166 @@ + + + +

Agent Identity Credentials API . projects . locations . authProviders . credentials

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ finalize(authProvider, body=None, x__xgafv=None)

+

Finalizes the credentials after a successful consent flow.

+

+ retrieve(authProvider, body=None, x__xgafv=None)

+

Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ finalize(authProvider, body=None, x__xgafv=None) +
Finalizes the credentials after a successful consent flow.
+
+Args:
+  authProvider: string, Required. The resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for FinalizeCredentials.
+  "consentNonce": "A String", # Required. The same consent_nonce value that was provided during redirect in the UriConsentRequired metadata.
+  "userId": "A String", # Required. The identity of the end user.
+  "userIdValidationState": "A String", # Required. The encrypted state passed back from the consent flow.
+}
+
+  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 FinalizeCredentials. Intentionally empty
+}
+
+ +
+ retrieve(authProvider, body=None, x__xgafv=None) +
Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.
+
+Args:
+  authProvider: string, Required. The parent resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for RetrieveCredentials.
+  "continueUri": "A String", # Optional. The URI to redirect the user to after consent is completed. This field is required for authproviders using the 3-legged OAuth flow. For other authprovider types, this field is unused but not rejected.
+  "forceRefreshToken": "A String", # Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Will trigger a refresh of the access token with a stored refresh token, if possible, or a new consent flow.
+  "scopes": [ # Optional. The OAuth scopes required for this access.
+    "A String",
+  ],
+  "userId": "A String", # Required. The identity of the end user.
+}
+
+  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 RetrieveCredentials. Contains the access tokens and related artifacts.
+  "consentRejected": { # Indicates the user has rejected the permission delegation or cancelled the request. # Message indicating consent was rejected.
+  },
+  "pending": { # Indicates that the credential retrieval is pending. The caller should retry the RetrieveCredentials request after some time. # Message indicating credential retrieval is pending.
+  },
+  "success": { # Message indicating successful retrieval of credentials. # Message indicating credentials were successfully retrieved.
+    "expireTime": "A String", # The expiration time of the token. This does not guarantee that the token will be valid until this time, since the token could be revoked earlier. There could also be clock skew between the auth provider and the client so it may expire slightly earlier. If not set, the token might be permanent or it may be that the service does not (or cannot) know when it will expire.
+    "header": "A String", # The HTTP header name where the token should be placed.
+    "scopes": [ # The scopes actually associated with the retrieved token. End users may have rejected some requested scopes, or the third-party authorization servers can return a different set of scopes than what was asked for. Callers should verify that all required scopes for their intended use are included in this list.
+      "A String",
+    ],
+    "token": "A String", # The retrieved access token or credential for the end user. On MCPTool call, for an invalid token OAuth spec says this should return 401 or 403, but MCPServers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to RetrieveCredentials with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow.
+  },
+  "uriConsentRequired": { # Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback # Message indicating uri based consent is required.
+    "authorizationUri": "A String", # Output only. The URL where the user should be redirected to grant consent. This will always be present.
+    "consentNonce": "A String", # Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the FinalizeCredentials request to complete the OAuth exchange. This will always be present. Implemented per https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5
+    "uid": "A String", # Output only. The unique ID of the credentials retrieval operation.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentitycredentials_v1.projects.locations.authProviders.html b/docs/dyn/agentidentitycredentials_v1.projects.locations.authProviders.html new file mode 100644 index 0000000000..5a4d526679 --- /dev/null +++ b/docs/dyn/agentidentitycredentials_v1.projects.locations.authProviders.html @@ -0,0 +1,91 @@ + + + +

Agent Identity Credentials API . projects . locations . authProviders

+

Instance Methods

+

+ credentials() +

+

Returns the credentials Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

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

Agent Identity Credentials API . projects . locations

+

Instance Methods

+

+ authProviders() +

+

Returns the authProviders Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentitycredentials_v1alpha.html b/docs/dyn/agentidentitycredentials_v1alpha.html new file mode 100644 index 0000000000..0955016f80 --- /dev/null +++ b/docs/dyn/agentidentitycredentials_v1alpha.html @@ -0,0 +1,111 @@ + + + +

Agent Identity Credentials API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentitycredentials_v1alpha.projects.html b/docs/dyn/agentidentitycredentials_v1alpha.projects.html new file mode 100644 index 0000000000..b4538e9a94 --- /dev/null +++ b/docs/dyn/agentidentitycredentials_v1alpha.projects.html @@ -0,0 +1,91 @@ + + + +

Agent Identity Credentials API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentitycredentials_v1alpha.projects.locations.authProviders.credentials.html b/docs/dyn/agentidentitycredentials_v1alpha.projects.locations.authProviders.credentials.html new file mode 100644 index 0000000000..a85c61b10e --- /dev/null +++ b/docs/dyn/agentidentitycredentials_v1alpha.projects.locations.authProviders.credentials.html @@ -0,0 +1,166 @@ + + + +

Agent Identity Credentials API . projects . locations . authProviders . credentials

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ finalize(authProvider, body=None, x__xgafv=None)

+

Finalizes the credentials after a successful consent flow.

+

+ retrieve(authProvider, body=None, x__xgafv=None)

+

Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ finalize(authProvider, body=None, x__xgafv=None) +
Finalizes the credentials after a successful consent flow.
+
+Args:
+  authProvider: string, Required. The resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for FinalizeCredentials.
+  "consentNonce": "A String", # Required. The same consent_nonce value that was provided during redirect in the UriConsentRequired metadata.
+  "userId": "A String", # Required. The identity of the end user.
+  "userIdValidationState": "A String", # Required. The encrypted state passed back from the consent flow.
+}
+
+  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 FinalizeCredentials. Intentionally empty
+}
+
+ +
+ retrieve(authProvider, body=None, x__xgafv=None) +
Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.
+
+Args:
+  authProvider: string, Required. The parent resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for RetrieveCredentials.
+  "continueUri": "A String", # Optional. The URI to redirect the user to after consent is completed. This field is required for authproviders using the 3-legged OAuth flow. For other authprovider types, this field is unused but not rejected.
+  "forceRefreshToken": "A String", # Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Will trigger a refresh of the access token with a stored refresh token, if possible, or a new consent flow.
+  "scopes": [ # Optional. The OAuth scopes required for this access.
+    "A String",
+  ],
+  "userId": "A String", # Required. The identity of the end user.
+}
+
+  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 RetrieveCredentials. Contains the access tokens and related artifacts.
+  "consentRejected": { # Indicates the user has rejected the permission delegation or cancelled the request. # Message indicating consent was rejected.
+  },
+  "pending": { # Indicates that the credential retrieval is pending. The caller should retry the RetrieveCredentials request after some time. # Message indicating credential retrieval is pending.
+  },
+  "success": { # Message indicating successful retrieval of credentials. # Message indicating credentials were successfully retrieved.
+    "expireTime": "A String", # The expiration time of the token. This does not guarantee that the token will be valid until this time, since the token could be revoked earlier. There could also be clock skew between the auth provider and the client so it may expire slightly earlier. If not set, the token might be permanent or it may be that the service does not (or cannot) know when it will expire.
+    "header": "A String", # The HTTP header name where the token should be placed.
+    "scopes": [ # The scopes actually associated with the retrieved token. End users may have rejected some requested scopes, or the third-party authorization servers can return a different set of scopes than what was asked for. Callers should verify that all required scopes for their intended use are included in this list.
+      "A String",
+    ],
+    "token": "A String", # The retrieved access token or credential for the end user. On MCPTool call, for an invalid token OAuth spec says this should return 401 or 403, but MCPServers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to RetrieveCredentials with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow.
+  },
+  "uriConsentRequired": { # Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback # Message indicating uri based consent is required.
+    "authorizationUri": "A String", # Output only. The URL where the user should be redirected to grant consent. This will always be present.
+    "consentNonce": "A String", # Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the FinalizeCredentials request to complete the OAuth exchange. This will always be present. Implemented per https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5
+    "uid": "A String", # Output only. The unique ID of the credentials retrieval operation.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentitycredentials_v1alpha.projects.locations.authProviders.html b/docs/dyn/agentidentitycredentials_v1alpha.projects.locations.authProviders.html new file mode 100644 index 0000000000..cb897e364a --- /dev/null +++ b/docs/dyn/agentidentitycredentials_v1alpha.projects.locations.authProviders.html @@ -0,0 +1,91 @@ + + + +

Agent Identity Credentials API . projects . locations . authProviders

+

Instance Methods

+

+ credentials() +

+

Returns the credentials Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

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

Agent Identity Credentials API . projects . locations

+

Instance Methods

+

+ authProviders() +

+

Returns the authProviders Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

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

Agent Identity Credentials API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentitycredentials_v1beta.projects.html b/docs/dyn/agentidentitycredentials_v1beta.projects.html new file mode 100644 index 0000000000..060713fcd4 --- /dev/null +++ b/docs/dyn/agentidentitycredentials_v1beta.projects.html @@ -0,0 +1,91 @@ + + + +

Agent Identity Credentials API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentitycredentials_v1beta.projects.locations.authProviders.credentials.html b/docs/dyn/agentidentitycredentials_v1beta.projects.locations.authProviders.credentials.html new file mode 100644 index 0000000000..b6bf2235f6 --- /dev/null +++ b/docs/dyn/agentidentitycredentials_v1beta.projects.locations.authProviders.credentials.html @@ -0,0 +1,166 @@ + + + +

Agent Identity Credentials API . projects . locations . authProviders . credentials

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ finalize(authProvider, body=None, x__xgafv=None)

+

Finalizes the credentials after a successful consent flow.

+

+ retrieve(authProvider, body=None, x__xgafv=None)

+

Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ finalize(authProvider, body=None, x__xgafv=None) +
Finalizes the credentials after a successful consent flow.
+
+Args:
+  authProvider: string, Required. The resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for FinalizeCredentials.
+  "consentNonce": "A String", # Required. The same consent_nonce value that was provided during redirect in the UriConsentRequired metadata.
+  "userId": "A String", # Required. The identity of the end user.
+  "userIdValidationState": "A String", # Required. The encrypted state passed back from the consent flow.
+}
+
+  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 FinalizeCredentials. Intentionally empty
+}
+
+ +
+ retrieve(authProvider, body=None, x__xgafv=None) +
Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.
+
+Args:
+  authProvider: string, Required. The parent resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for RetrieveCredentials.
+  "continueUri": "A String", # Optional. The URI to redirect the user to after consent is completed. This field is required for authproviders using the 3-legged OAuth flow. For other authprovider types, this field is unused but not rejected.
+  "forceRefreshToken": "A String", # Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Will trigger a refresh of the access token with a stored refresh token, if possible, or a new consent flow.
+  "scopes": [ # Optional. The OAuth scopes required for this access.
+    "A String",
+  ],
+  "userId": "A String", # Required. The identity of the end user.
+}
+
+  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 RetrieveCredentials. Contains the access tokens and related artifacts.
+  "consentRejected": { # Indicates the user has rejected the permission delegation or cancelled the request. # Message indicating consent was rejected.
+  },
+  "pending": { # Indicates that the credential retrieval is pending. The caller should retry the RetrieveCredentials request after some time. # Message indicating credential retrieval is pending.
+  },
+  "success": { # Message indicating successful retrieval of credentials. # Message indicating credentials were successfully retrieved.
+    "expireTime": "A String", # The expiration time of the token. This does not guarantee that the token will be valid until this time, since the token could be revoked earlier. There could also be clock skew between the auth provider and the client so it may expire slightly earlier. If not set, the token might be permanent or it may be that the service does not (or cannot) know when it will expire.
+    "header": "A String", # The HTTP header name where the token should be placed.
+    "scopes": [ # The scopes actually associated with the retrieved token. End users may have rejected some requested scopes, or the third-party authorization servers can return a different set of scopes than what was asked for. Callers should verify that all required scopes for their intended use are included in this list.
+      "A String",
+    ],
+    "token": "A String", # The retrieved access token or credential for the end user. On MCPTool call, for an invalid token OAuth spec says this should return 401 or 403, but MCPServers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to RetrieveCredentials with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow.
+  },
+  "uriConsentRequired": { # Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback # Message indicating uri based consent is required.
+    "authorizationUri": "A String", # Output only. The URL where the user should be redirected to grant consent. This will always be present.
+    "consentNonce": "A String", # Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the FinalizeCredentials request to complete the OAuth exchange. This will always be present. Implemented per https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5
+    "uid": "A String", # Output only. The unique ID of the credentials retrieval operation.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentidentitycredentials_v1beta.projects.locations.authProviders.html b/docs/dyn/agentidentitycredentials_v1beta.projects.locations.authProviders.html new file mode 100644 index 0000000000..f524317954 --- /dev/null +++ b/docs/dyn/agentidentitycredentials_v1beta.projects.locations.authProviders.html @@ -0,0 +1,91 @@ + + + +

Agent Identity Credentials API . projects . locations . authProviders

+

Instance Methods

+

+ credentials() +

+

Returns the credentials Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

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

Agent Identity Credentials API . projects . locations

+

Instance Methods

+

+ authProviders() +

+

Returns the authProviders Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html index 42ebbbd32b..f182d4c460 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html @@ -125,7 +125,7 @@

Method Details

The object takes the form of: { # Message describing a BackupVault object. - "accessRestriction": "A String", # Optional. Note: This field is added for future use case and will not be supported in the current release. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation. + "accessRestriction": "A String", # Optional. Restricts access to certain sources and destinations for data being sent into, or restored from, the backup vault. Defaults to WITHIN_ORGANIZATION if not provided during creation. "annotations": { # Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. "a_key": "A String", }, @@ -245,7 +245,7 @@

Method Details

{ # Response message for fetching usable BackupVaults. "backupVaults": [ # The list of BackupVault instances in the project for the specified location. If the '{location}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup vaults in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. { # Message describing a BackupVault object. - "accessRestriction": "A String", # Optional. Note: This field is added for future use case and will not be supported in the current release. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation. + "accessRestriction": "A String", # Optional. Restricts access to certain sources and destinations for data being sent into, or restored from, the backup vault. Defaults to WITHIN_ORGANIZATION if not provided during creation. "annotations": { # Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. "a_key": "A String", }, @@ -312,7 +312,7 @@

Method Details

An object of the form: { # Message describing a BackupVault object. - "accessRestriction": "A String", # Optional. Note: This field is added for future use case and will not be supported in the current release. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation. + "accessRestriction": "A String", # Optional. Restricts access to certain sources and destinations for data being sent into, or restored from, the backup vault. Defaults to WITHIN_ORGANIZATION if not provided during creation. "annotations": { # Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. "a_key": "A String", }, @@ -365,7 +365,7 @@

Method Details

{ # Response message for listing BackupVaults. "backupVaults": [ # The list of BackupVault instances in the project for the specified location. If the '{location}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup vaults in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. { # Message describing a BackupVault object. - "accessRestriction": "A String", # Optional. Note: This field is added for future use case and will not be supported in the current release. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation. + "accessRestriction": "A String", # Optional. Restricts access to certain sources and destinations for data being sent into, or restored from, the backup vault. Defaults to WITHIN_ORGANIZATION if not provided during creation. "annotations": { # Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. "a_key": "A String", }, @@ -422,7 +422,7 @@

Method Details

The object takes the form of: { # Message describing a BackupVault object. - "accessRestriction": "A String", # Optional. Note: This field is added for future use case and will not be supported in the current release. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation. + "accessRestriction": "A String", # Optional. Restricts access to certain sources and destinations for data being sent into, or restored from, the backup vault. Defaults to WITHIN_ORGANIZATION if not provided during creation. "annotations": { # Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. "a_key": "A String", }, diff --git a/docs/dyn/bigquerydatapolicy_v2.projects.locations.dataPolicies.html b/docs/dyn/bigquerydatapolicy_v2.projects.locations.dataPolicies.html index fc09ad6e3f..95ee968673 100644 --- a/docs/dyn/bigquerydatapolicy_v2.projects.locations.dataPolicies.html +++ b/docs/dyn/bigquerydatapolicy_v2.projects.locations.dataPolicies.html @@ -135,7 +135,7 @@

Method Details

An object of the form: { # Represents the label-policy binding. - "dataGovernanceTag": { # Data Governance tag This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. + "dataGovernanceTag": { # This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. "key": "A String", # Optional. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example `parent-id/pii` where `parent-id` is the ID of the parent organization or project resource for this tag key. "value": "A String", # Optional. Specifies the tag value as the short name, for example `sensitive`. }, @@ -171,7 +171,7 @@

Method Details

{ # Request message for the CreateDataPolicy method. "dataPolicy": { # Represents the label-policy binding. # Required. The data policy to create. The `name` field does not need to be provided for the data policy creation. - "dataGovernanceTag": { # Data Governance tag This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. + "dataGovernanceTag": { # This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. "key": "A String", # Optional. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example `parent-id/pii` where `parent-id` is the ID of the parent organization or project resource for this tag key. "value": "A String", # Optional. Specifies the tag value as the short name, for example `sensitive`. }, @@ -201,7 +201,7 @@

Method Details

An object of the form: { # Represents the label-policy binding. - "dataGovernanceTag": { # Data Governance tag This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. + "dataGovernanceTag": { # This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. "key": "A String", # Optional. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example `parent-id/pii` where `parent-id` is the ID of the parent organization or project resource for this tag key. "value": "A String", # Optional. Specifies the tag value as the short name, for example `sensitive`. }, @@ -254,7 +254,7 @@

Method Details

An object of the form: { # Represents the label-policy binding. - "dataGovernanceTag": { # Data Governance tag This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. + "dataGovernanceTag": { # This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. "key": "A String", # Optional. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example `parent-id/pii` where `parent-id` is the ID of the parent organization or project resource for this tag key. "value": "A String", # Optional. Specifies the tag value as the short name, for example `sensitive`. }, @@ -350,7 +350,7 @@

Method Details

{ # Response message for the ListDataPolicies method. "dataPolicies": [ # Data policies that belong to the requested project. { # Represents the label-policy binding. - "dataGovernanceTag": { # Data Governance tag This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. + "dataGovernanceTag": { # This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. "key": "A String", # Optional. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example `parent-id/pii` where `parent-id` is the ID of the parent organization or project resource for this tag key. "value": "A String", # Optional. Specifies the tag value as the short name, for example `sensitive`. }, @@ -397,7 +397,7 @@

Method Details

The object takes the form of: { # Represents the label-policy binding. - "dataGovernanceTag": { # Data Governance tag This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. + "dataGovernanceTag": { # This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. "key": "A String", # Optional. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example `parent-id/pii` where `parent-id` is the ID of the parent organization or project resource for this tag key. "value": "A String", # Optional. Specifies the tag value as the short name, for example `sensitive`. }, @@ -427,7 +427,7 @@

Method Details

An object of the form: { # Represents the label-policy binding. - "dataGovernanceTag": { # Data Governance tag This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. + "dataGovernanceTag": { # This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. "key": "A String", # Optional. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example `parent-id/pii` where `parent-id` is the ID of the parent organization or project resource for this tag key. "value": "A String", # Optional. Specifies the tag value as the short name, for example `sensitive`. }, @@ -471,7 +471,7 @@

Method Details

An object of the form: { # Represents the label-policy binding. - "dataGovernanceTag": { # Data Governance tag This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. + "dataGovernanceTag": { # This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`. # Optional. Data Governance tag bound to the Data Policy. "key": "A String", # Optional. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example `parent-id/pii` where `parent-id` is the ID of the parent organization or project resource for this tag key. "value": "A String", # Optional. Specifies the tag value as the short name, for example `sensitive`. }, diff --git a/docs/dyn/chromemanagement_v1.customers.enterprise.securityInsights.html b/docs/dyn/chromemanagement_v1.customers.enterprise.securityInsights.html index 558556a202..4385785301 100644 --- a/docs/dyn/chromemanagement_v1.customers.enterprise.securityInsights.html +++ b/docs/dyn/chromemanagement_v1.customers.enterprise.securityInsights.html @@ -97,10 +97,10 @@

Instance Methods

Retrieves the next page of results.

queryUrlVisits(customer, filter=None, x__xgafv=None)

-

Returns a high-level summary of URL visits for a given customer.

+

Returns a high-level summary of URL visits for a given customer. Requires a Chrome Enterprise Premium subscription. If the customer does not have this subscription, query results will be empty.

queryUrlVisitsBreakdowns(customer, breakdown=None, filter=None, fixedTimeRange=None, metric=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Returns summaries of URL visits for a given metric and breakdown dimension.

+

Returns summaries of URL visits for a given metric and breakdown dimension. Requires a Chrome Enterprise Premium subscription. If the customer does not have this subscription, query results will be empty.

queryUrlVisitsBreakdowns_next()

Retrieves the next page of results.

@@ -280,7 +280,7 @@

Method Details

queryUrlVisits(customer, filter=None, x__xgafv=None) -
Returns a high-level summary of URL visits for a given customer.
+  
Returns a high-level summary of URL visits for a given customer. Requires a Chrome Enterprise Premium subscription. If the customer does not have this subscription, query results will be empty.
 
 Args:
   customer: string, Required. The customer ID in the format "customers/{customer_id}". (required)
@@ -305,7 +305,7 @@ 

Method Details

queryUrlVisitsBreakdowns(customer, breakdown=None, filter=None, fixedTimeRange=None, metric=None, pageSize=None, pageToken=None, x__xgafv=None) -
Returns summaries of URL visits for a given metric and breakdown dimension.
+  
Returns summaries of URL visits for a given metric and breakdown dimension. Requires a Chrome Enterprise Premium subscription. If the customer does not have this subscription, query results will be empty.
 
 Args:
   customer: string, Required. The customer ID in the format "customers/{customer_id}". (required)
diff --git a/docs/dyn/chromepolicy_v1.customers.policySchemas.html b/docs/dyn/chromepolicy_v1.customers.policySchemas.html
index cd48b69bfc..6b48993a7d 100644
--- a/docs/dyn/chromepolicy_v1.customers.policySchemas.html
+++ b/docs/dyn/chromepolicy_v1.customers.policySchemas.html
@@ -118,7 +118,7 @@ 

Method Details

], "categoryTitle": "A String", # Title of the category in which a setting belongs. "definition": { # Describes a complete .proto file. # Schema definition using proto descriptor. - "editionDeprecated": "A String", # copybara:strip_begin TODO(b/297898292) Deprecate and remove this field in favor of enums. copybara:strip_end + "editionDeprecated": "A String", # copybara:strip_begin TODO(b/538805613) Deprecate and remove this field in favor of enums. copybara:strip_end "enumType": [ { # Describes an enum type. "name": "A String", @@ -298,7 +298,7 @@

Method Details

], "categoryTitle": "A String", # Title of the category in which a setting belongs. "definition": { # Describes a complete .proto file. # Schema definition using proto descriptor. - "editionDeprecated": "A String", # copybara:strip_begin TODO(b/297898292) Deprecate and remove this field in favor of enums. copybara:strip_end + "editionDeprecated": "A String", # copybara:strip_begin TODO(b/538805613) Deprecate and remove this field in favor of enums. copybara:strip_end "enumType": [ { # Describes an enum type. "name": "A String", diff --git a/docs/dyn/classroom_v1.courses.html b/docs/dyn/classroom_v1.courses.html index d40cbc5634..26c1824921 100644 --- a/docs/dyn/classroom_v1.courses.html +++ b/docs/dyn/classroom_v1.courses.html @@ -644,7 +644,7 @@

Method Details

"updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. } - updateMask: string, Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` * `levels` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...` + updateMask: string, Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` * `learningStandardSettings` * `levels` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/cloudkms_v1.projects.locations.singleTenantHsmInstances.html b/docs/dyn/cloudkms_v1.projects.locations.singleTenantHsmInstances.html index 7a391bfeda..bd059b600d 100644 --- a/docs/dyn/cloudkms_v1.projects.locations.singleTenantHsmInstances.html +++ b/docs/dyn/cloudkms_v1.projects.locations.singleTenantHsmInstances.html @@ -113,7 +113,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the SingleTenantHsmInstance was created. "deleteTime": "A String", # Output only. The time at which the SingleTenantHsmInstance was deleted. "disableTime": "A String", # Output only. The time at which the instance will be automatically disabled if not refreshed. This field is updated upon creation and after each successful refresh operation and enable. A RefreshSingleTenantHsmInstance operation must be made via a SingleTenantHsmInstanceProposal before this time otherwise the SingleTenantHsmInstance will become disabled. - "keyPortabilityEnabled": True or False, # Optional. Immutable. Indicates whether key portability is enabled for the SingleTenantHsmInstance. This can only be set at creation time. Key portability features are disabled by default and not yet available in GA. + "keyPortabilityEnabled": True or False, # Optional. Immutable. Indicates whether key portability is enabled for the SingleTenantHsmInstance. This can only be set at creation time. Key portability features are disabled by default. "name": "A String", # Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/*/locations/*/singleTenantHsmInstances/*`. "quorumAuth": { # Configuration for M of N quorum auth. # Required. The quorum auth configuration for the SingleTenantHsmInstance. "requiredApproverCount": 42, # Output only. The required numbers of approvers. The M value used for M of N quorum auth. Must be greater than or equal to 2 and less than or equal to total_approver_count - 1. @@ -174,7 +174,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the SingleTenantHsmInstance was created. "deleteTime": "A String", # Output only. The time at which the SingleTenantHsmInstance was deleted. "disableTime": "A String", # Output only. The time at which the instance will be automatically disabled if not refreshed. This field is updated upon creation and after each successful refresh operation and enable. A RefreshSingleTenantHsmInstance operation must be made via a SingleTenantHsmInstanceProposal before this time otherwise the SingleTenantHsmInstance will become disabled. - "keyPortabilityEnabled": True or False, # Optional. Immutable. Indicates whether key portability is enabled for the SingleTenantHsmInstance. This can only be set at creation time. Key portability features are disabled by default and not yet available in GA. + "keyPortabilityEnabled": True or False, # Optional. Immutable. Indicates whether key portability is enabled for the SingleTenantHsmInstance. This can only be set at creation time. Key portability features are disabled by default. "name": "A String", # Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/*/locations/*/singleTenantHsmInstances/*`. "quorumAuth": { # Configuration for M of N quorum auth. # Required. The quorum auth configuration for the SingleTenantHsmInstance. "requiredApproverCount": 42, # Output only. The required numbers of approvers. The M value used for M of N quorum auth. Must be greater than or equal to 2 and less than or equal to total_approver_count - 1. @@ -214,7 +214,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the SingleTenantHsmInstance was created. "deleteTime": "A String", # Output only. The time at which the SingleTenantHsmInstance was deleted. "disableTime": "A String", # Output only. The time at which the instance will be automatically disabled if not refreshed. This field is updated upon creation and after each successful refresh operation and enable. A RefreshSingleTenantHsmInstance operation must be made via a SingleTenantHsmInstanceProposal before this time otherwise the SingleTenantHsmInstance will become disabled. - "keyPortabilityEnabled": True or False, # Optional. Immutable. Indicates whether key portability is enabled for the SingleTenantHsmInstance. This can only be set at creation time. Key portability features are disabled by default and not yet available in GA. + "keyPortabilityEnabled": True or False, # Optional. Immutable. Indicates whether key portability is enabled for the SingleTenantHsmInstance. This can only be set at creation time. Key portability features are disabled by default. "name": "A String", # Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/*/locations/*/singleTenantHsmInstances/*`. "quorumAuth": { # Configuration for M of N quorum auth. # Required. The quorum auth configuration for the SingleTenantHsmInstance. "requiredApproverCount": 42, # Output only. The required numbers of approvers. The M value used for M of N quorum auth. Must be greater than or equal to 2 and less than or equal to total_approver_count - 1. diff --git a/docs/dyn/cloudtrace_v1.projects.html b/docs/dyn/cloudtrace_v1.projects.html index 092fca4deb..ee36715099 100644 --- a/docs/dyn/cloudtrace_v1.projects.html +++ b/docs/dyn/cloudtrace_v1.projects.html @@ -103,21 +103,21 @@

Method Details

{ # List of new or updated traces. "traces": [ # List of traces. { # A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation. - "projectId": "A String", # Project ID of the Cloud project where the trace data is stored. + "projectId": "A String", # Required. Project ID of the Cloud project where the trace data is stored. "spans": [ # Collection of spans in the trace. { # A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace. - "endTime": "A String", # End time of the span in seconds and nanoseconds from the UNIX epoch. - "kind": "A String", # Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span. - "labels": { # Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own. For more information, see [Cloud Trace labels](https://cloud.google.com/trace/docs/trace-labels). + "endTime": "A String", # Required. End time of the span in seconds and nanoseconds from the UNIX epoch. + "kind": "A String", # Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span. + "labels": { # Optional. Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own. For more information, see [Cloud Trace labels](https://cloud.google.com/trace/docs/trace-labels). "a_key": "A String", }, - "name": "A String", # Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans. + "name": "A String", # Required. Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans. "parentSpanId": "A String", # Optional. ID of the parent span, if any. - "spanId": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, `2205310701640571284`. - "startTime": "A String", # Start time of the span in seconds and nanoseconds from the UNIX epoch. + "spanId": "A String", # Required. Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, `2205310701640571284`. + "startTime": "A String", # Required. Start time of the span in seconds and nanoseconds from the UNIX epoch. }, ], - "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string. For example, `382d4f4c6b7bb2f4a972559d9085001d`. The numeric value should not be zero. + "traceId": "A String", # Required. Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string. For example, `382d4f4c6b7bb2f4a972559d9085001d`. The numeric value should not be zero. }, ], } diff --git a/docs/dyn/cloudtrace_v1.projects.traces.html b/docs/dyn/cloudtrace_v1.projects.traces.html index 0d33e182fc..cad4df9b6f 100644 --- a/docs/dyn/cloudtrace_v1.projects.traces.html +++ b/docs/dyn/cloudtrace_v1.projects.traces.html @@ -108,21 +108,21 @@

Method Details

An object of the form: { # A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation. - "projectId": "A String", # Project ID of the Cloud project where the trace data is stored. + "projectId": "A String", # Required. Project ID of the Cloud project where the trace data is stored. "spans": [ # Collection of spans in the trace. { # A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace. - "endTime": "A String", # End time of the span in seconds and nanoseconds from the UNIX epoch. - "kind": "A String", # Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span. - "labels": { # Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own. For more information, see [Cloud Trace labels](https://cloud.google.com/trace/docs/trace-labels). + "endTime": "A String", # Required. End time of the span in seconds and nanoseconds from the UNIX epoch. + "kind": "A String", # Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span. + "labels": { # Optional. Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own. For more information, see [Cloud Trace labels](https://cloud.google.com/trace/docs/trace-labels). "a_key": "A String", }, - "name": "A String", # Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans. + "name": "A String", # Required. Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans. "parentSpanId": "A String", # Optional. ID of the parent span, if any. - "spanId": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, `2205310701640571284`. - "startTime": "A String", # Start time of the span in seconds and nanoseconds from the UNIX epoch. + "spanId": "A String", # Required. Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, `2205310701640571284`. + "startTime": "A String", # Required. Start time of the span in seconds and nanoseconds from the UNIX epoch. }, ], - "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string. For example, `382d4f4c6b7bb2f4a972559d9085001d`. The numeric value should not be zero. + "traceId": "A String", # Required. Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string. For example, `382d4f4c6b7bb2f4a972559d9085001d`. The numeric value should not be zero. }
@@ -132,12 +132,12 @@

Method Details

Args: projectId: string, Required. ID of the Cloud project where the trace data is stored. (required) - endTime: string, End of the time interval (inclusive) during which the trace data was collected from the application. + endTime: string, Required. End of the time interval (inclusive) during which the trace data was collected from the application. filter: string, Optional. A filter against properties of the trace. See [filter syntax documentation](https://cloud.google.com/trace/docs/trace-filters) for details. orderBy: string, Optional. Field used to sort the returned traces. Can be one of the following: * `trace_id` * `name` (`name` field of root span in the trace) * `duration` (difference between `end_time` and `start_time` fields of the root span) * `start` (`start_time` field of the root span) Descending order can be specified by appending `desc` to the sort field (for example, `name desc`). Only one sort field is permitted. pageSize: integer, Optional. Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. - pageToken: string, Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request. - startTime: string, Start of the time interval (inclusive) during which the trace data was collected from the application. + pageToken: string, Optional. Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request. + startTime: string, Required. Start of the time interval (inclusive) during which the trace data was collected from the application. view: string, Optional. Type of data returned for traces in the list. Default is `MINIMAL`. Allowed values VIEW_TYPE_UNSPECIFIED - Default is `MINIMAL` if unspecified. @@ -156,21 +156,21 @@

Method Details

"nextPageToken": "A String", # If defined, indicates that there are more traces that match the request and that this value should be passed to the next request to continue retrieving additional traces. "traces": [ # List of trace records as specified by the view parameter. { # A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation. - "projectId": "A String", # Project ID of the Cloud project where the trace data is stored. + "projectId": "A String", # Required. Project ID of the Cloud project where the trace data is stored. "spans": [ # Collection of spans in the trace. { # A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace. - "endTime": "A String", # End time of the span in seconds and nanoseconds from the UNIX epoch. - "kind": "A String", # Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span. - "labels": { # Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own. For more information, see [Cloud Trace labels](https://cloud.google.com/trace/docs/trace-labels). + "endTime": "A String", # Required. End time of the span in seconds and nanoseconds from the UNIX epoch. + "kind": "A String", # Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span. + "labels": { # Optional. Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own. For more information, see [Cloud Trace labels](https://cloud.google.com/trace/docs/trace-labels). "a_key": "A String", }, - "name": "A String", # Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans. + "name": "A String", # Required. Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans. "parentSpanId": "A String", # Optional. ID of the parent span, if any. - "spanId": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, `2205310701640571284`. - "startTime": "A String", # Start time of the span in seconds and nanoseconds from the UNIX epoch. + "spanId": "A String", # Required. Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, `2205310701640571284`. + "startTime": "A String", # Required. Start time of the span in seconds and nanoseconds from the UNIX epoch. }, ], - "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string. For example, `382d4f4c6b7bb2f4a972559d9085001d`. The numeric value should not be zero. + "traceId": "A String", # Required. Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string. For example, `382d4f4c6b7bb2f4a972559d9085001d`. The numeric value should not be zero. }, ], }
diff --git a/docs/dyn/cloudtrace_v2.projects.traces.html b/docs/dyn/cloudtrace_v2.projects.traces.html index d73e50415e..4ade1f831d 100644 --- a/docs/dyn/cloudtrace_v2.projects.traces.html +++ b/docs/dyn/cloudtrace_v2.projects.traces.html @@ -98,90 +98,90 @@

Method Details

{ # The request message for the `BatchWriteSpans` method. "spans": [ # Required. A list of new spans. The span names must not match existing spans, otherwise the results are undefined. { # A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous. There might be gaps or overlaps between spans in a trace. - "attributes": { # A set of attributes as key-value pairs. # A set of attributes on the span. You can have up to 32 attributes per span. - "attributeMap": { # A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } + "attributes": { # A set of attributes as key-value pairs. # Optional. A set of attributes on the span. You can have up to 32 attributes per span. + "attributeMap": { # Optional. A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } "a_key": { # The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute. - "boolValue": True or False, # A Boolean value represented by `true` or `false`. - "intValue": "A String", # A 64-bit signed integer. - "stringValue": { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long. - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "boolValue": True or False, # Optional. A Boolean value represented by `true` or `false`. + "intValue": "A String", # Optional. A 64-bit signed integer. + "stringValue": { # Represents a string that might be shortened to a specified length. # Optional. A string up to 256 bytes long. + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, }, - "droppedAttributesCount": 42, # The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. + "droppedAttributesCount": 42, # Optional. The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. }, "childSpanCount": 42, # Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans. "displayName": { # Represents a string that might be shortened to a specified length. # Required. A description of the span's operation (up to 128 bytes). Cloud Trace displays the description in the Cloud console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces. - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, "endTime": "A String", # Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running. - "links": { # A collection of links, which are references from this span to a span in the same or different trace. # Links associated with the span. You can have up to 128 links per Span. - "droppedLinksCount": 42, # The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped. - "link": [ # A collection of links. + "links": { # A collection of links, which are references from this span to a span in the same or different trace. # Optional. Links associated with the span. You can have up to 128 links per Span. + "droppedLinksCount": 42, # Optional. The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped. + "link": [ # Optional. A collection of links. { # A pointer from the current span to another span in the same trace or in a different trace. For example, this can be used in batching operations, where a single batch handler processes multiple requests from different traces or when the handler receives a request from a different project. - "attributes": { # A set of attributes as key-value pairs. # A set of attributes on the link. Up to 32 attributes can be specified per link. - "attributeMap": { # A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } + "attributes": { # A set of attributes as key-value pairs. # Optional. A set of attributes on the link. Up to 32 attributes can be specified per link. + "attributeMap": { # Optional. A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } "a_key": { # The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute. - "boolValue": True or False, # A Boolean value represented by `true` or `false`. - "intValue": "A String", # A 64-bit signed integer. - "stringValue": { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long. - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "boolValue": True or False, # Optional. A Boolean value represented by `true` or `false`. + "intValue": "A String", # Optional. A 64-bit signed integer. + "stringValue": { # Represents a string that might be shortened to a specified length. # Optional. A string up to 256 bytes long. + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, }, - "droppedAttributesCount": 42, # The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. + "droppedAttributesCount": 42, # Optional. The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. }, - "spanId": "A String", # The `[SPAN_ID]` for a span within a trace. - "traceId": "A String", # The `[TRACE_ID]` for a trace within a project. - "type": "A String", # The relationship of the current span relative to the linked span. + "spanId": "A String", # Optional. The `[SPAN_ID]` for a span within a trace. + "traceId": "A String", # Optional. The `[TRACE_ID]` for a trace within a project. + "type": "A String", # Optional. The relationship of the current span relative to the linked span. }, ], }, - "name": "A String", # Required. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. . - "parentSpanId": "A String", # The `[SPAN_ID]` of this span's parent span. If this is a root span, then this field must be empty. + "name": "A String", # Identifier. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. . + "parentSpanId": "A String", # Optional. The `[SPAN_ID]` of this span's parent span. If this is a root span, then this field must be empty. "sameProcessAsParentSpan": True or False, # Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Trace is unable to take advantage of this helpful information. "spanId": "A String", # Required. The `[SPAN_ID]` portion of the span's resource name. "spanKind": "A String", # Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call. - "stackTrace": { # A call stack appearing in a trace. # Stack trace captured at the start of the span. - "stackFrames": { # A collection of stack frames, which can be truncated. # Stack frames in this stack trace. A maximum of 128 frames are allowed. - "droppedFramesCount": 42, # The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped. - "frame": [ # Stack frames in this call stack. + "stackTrace": { # A call stack appearing in a trace. # Optional. Stack trace captured at the start of the span. + "stackFrames": { # A collection of stack frames, which can be truncated. # Optional. Stack frames in this stack trace. A maximum of 128 frames are allowed. + "droppedFramesCount": 42, # Optional. The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped. + "frame": [ # Optional. Stack frames in this call stack. { # Represents a single stack frame in a stack trace. - "columnNumber": "A String", # The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions. - "fileName": { # Represents a string that might be shortened to a specified length. # The name of the source file where the function call appears (up to 256 bytes). - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "columnNumber": "A String", # Optional. The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions. + "fileName": { # Represents a string that might be shortened to a specified length. # Optional. The name of the source file where the function call appears (up to 256 bytes). + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, - "functionName": { # Represents a string that might be shortened to a specified length. # The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes). - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "functionName": { # Represents a string that might be shortened to a specified length. # Optional. The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes). + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, - "lineNumber": "A String", # The line number in `file_name` where the function call appears. - "loadModule": { # Binary module. # The binary module from where the code was loaded. - "buildId": { # Represents a string that might be shortened to a specified length. # A unique identifier for the module, usually a hash of its contents (up to 128 bytes). - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "lineNumber": "A String", # Optional. The line number in `file_name` where the function call appears. + "loadModule": { # Binary module. # Optional. The binary module from where the code was loaded. + "buildId": { # Represents a string that might be shortened to a specified length. # Optional. A unique identifier for the module, usually a hash of its contents (up to 128 bytes). + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, - "module": { # Represents a string that might be shortened to a specified length. # For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes). - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "module": { # Represents a string that might be shortened to a specified length. # Optional. For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes). + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, - "originalFunctionName": { # Represents a string that might be shortened to a specified length. # An un-mangled function name, if `function_name` is mangled. To get information about name mangling, run [this search](https://www.google.com/search?q=cxx+name+mangling). The name can be fully-qualified (up to 1024 bytes). - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "originalFunctionName": { # Represents a string that might be shortened to a specified length. # Optional. An un-mangled function name, if `function_name` is mangled. To get information about name mangling, run [this search](https://www.google.com/search?q=cxx+name+mangling). The name can be fully-qualified (up to 1024 bytes). + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, - "sourceVersion": { # Represents a string that might be shortened to a specified length. # The version of the deployed source code (up to 128 bytes). - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "sourceVersion": { # Represents a string that might be shortened to a specified length. # Optional. The version of the deployed source code (up to 128 bytes). + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, ], }, - "stackTraceHashId": "A String", # The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both the `stackFrame` content and a value in `stackTraceHashId`. Subsequent spans within the same request can refer to that stack trace by only setting `stackTraceHashId`. + "stackTraceHashId": "A String", # Optional. The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both the `stackFrame` content and a value in `stackTraceHashId`. Subsequent spans within the same request can refer to that stack trace by only setting `stackTraceHashId`. }, "startTime": "A String", # Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running. "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Optional. The final status for this span. @@ -193,37 +193,37 @@

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. }, - "timeEvents": { # A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans. # A set of time events. You can have up to 32 annotations and 128 message events per span. - "droppedAnnotationsCount": 42, # The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped. - "droppedMessageEventsCount": 42, # The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped. - "timeEvent": [ # A collection of `TimeEvent`s. + "timeEvents": { # A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans. # Optional. A set of time events. You can have up to 32 annotations and 128 message events per span. + "droppedAnnotationsCount": 42, # Optional. The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped. + "droppedMessageEventsCount": 42, # Optional. The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped. + "timeEvent": [ # Optional. A collection of `TimeEvent`s. { # A time-stamped annotation or message event in the Span. "annotation": { # Text annotation with a set of attributes. # Text annotation with a set of attributes. - "attributes": { # A set of attributes as key-value pairs. # A set of attributes on the annotation. You can have up to 4 attributes per Annotation. - "attributeMap": { # A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } + "attributes": { # A set of attributes as key-value pairs. # Optional. A set of attributes on the annotation. You can have up to 4 attributes per Annotation. + "attributeMap": { # Optional. A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } "a_key": { # The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute. - "boolValue": True or False, # A Boolean value represented by `true` or `false`. - "intValue": "A String", # A 64-bit signed integer. - "stringValue": { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long. - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "boolValue": True or False, # Optional. A Boolean value represented by `true` or `false`. + "intValue": "A String", # Optional. A 64-bit signed integer. + "stringValue": { # Represents a string that might be shortened to a specified length. # Optional. A string up to 256 bytes long. + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, }, - "droppedAttributesCount": 42, # The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. + "droppedAttributesCount": 42, # Optional. The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. }, - "description": { # Represents a string that might be shortened to a specified length. # A user-supplied message describing the event. The maximum length for the description is 256 bytes. - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "description": { # Represents a string that might be shortened to a specified length. # Optional. A user-supplied message describing the event. The maximum length for the description is 256 bytes. + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, "messageEvent": { # An event describing a message sent/received between Spans. # An event describing a message sent/received between Spans. - "compressedSizeBytes": "A String", # The number of compressed bytes sent or received. If missing, the compressed size is assumed to be the same size as the uncompressed size. - "id": "A String", # An identifier for the MessageEvent's message that can be used to match `SENT` and `RECEIVED` MessageEvents. - "type": "A String", # Type of MessageEvent. Indicates whether the message was sent or received. - "uncompressedSizeBytes": "A String", # The number of uncompressed bytes sent or received. + "compressedSizeBytes": "A String", # Optional. The number of compressed bytes sent or received. If missing, the compressed size is assumed to be the same size as the uncompressed size. + "id": "A String", # Optional. An identifier for the MessageEvent's message that can be used to match `SENT` and `RECEIVED` MessageEvents. + "type": "A String", # Optional. Type of MessageEvent. Indicates whether the message was sent or received. + "uncompressedSizeBytes": "A String", # Optional. The number of uncompressed bytes sent or received. }, - "time": "A String", # The timestamp indicating the time the event occurred. + "time": "A String", # Optional. The timestamp indicating the time the event occurred. }, ], }, diff --git a/docs/dyn/cloudtrace_v2.projects.traces.spans.html b/docs/dyn/cloudtrace_v2.projects.traces.spans.html index f18dffa678..f9b984c229 100644 --- a/docs/dyn/cloudtrace_v2.projects.traces.spans.html +++ b/docs/dyn/cloudtrace_v2.projects.traces.spans.html @@ -91,95 +91,95 @@

Method Details

Creates a new span. If a span ID already exists, an additional copy of the span will be stored.
 
 Args:
-  name: string, Required. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. . (required)
+  name: string, Identifier. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. . (required)
   body: object, The request body.
     The object takes the form of:
 
 { # A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous. There might be gaps or overlaps between spans in a trace.
-  "attributes": { # A set of attributes as key-value pairs. # A set of attributes on the span. You can have up to 32 attributes per span.
-    "attributeMap": { # A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false }
+  "attributes": { # A set of attributes as key-value pairs. # Optional. A set of attributes on the span. You can have up to 32 attributes per span.
+    "attributeMap": { # Optional. A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false }
       "a_key": { # The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute.
-        "boolValue": True or False, # A Boolean value represented by `true` or `false`.
-        "intValue": "A String", # A 64-bit signed integer.
-        "stringValue": { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.
-          "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
-          "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
+        "boolValue": True or False, # Optional. A Boolean value represented by `true` or `false`.
+        "intValue": "A String", # Optional. A 64-bit signed integer.
+        "stringValue": { # Represents a string that might be shortened to a specified length. # Optional. A string up to 256 bytes long.
+          "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
+          "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
         },
       },
     },
-    "droppedAttributesCount": 42, # The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid.
+    "droppedAttributesCount": 42, # Optional. The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid.
   },
   "childSpanCount": 42, # Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.
   "displayName": { # Represents a string that might be shortened to a specified length. # Required. A description of the span's operation (up to 128 bytes). Cloud Trace displays the description in the Cloud console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces.
-    "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
-    "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
+    "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
+    "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
   },
   "endTime": "A String", # Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.
-  "links": { # A collection of links, which are references from this span to a span in the same or different trace. # Links associated with the span. You can have up to 128 links per Span.
-    "droppedLinksCount": 42, # The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.
-    "link": [ # A collection of links.
+  "links": { # A collection of links, which are references from this span to a span in the same or different trace. # Optional. Links associated with the span. You can have up to 128 links per Span.
+    "droppedLinksCount": 42, # Optional. The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.
+    "link": [ # Optional. A collection of links.
       { # A pointer from the current span to another span in the same trace or in a different trace. For example, this can be used in batching operations, where a single batch handler processes multiple requests from different traces or when the handler receives a request from a different project.
-        "attributes": { # A set of attributes as key-value pairs. # A set of attributes on the link. Up to 32 attributes can be specified per link.
-          "attributeMap": { # A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false }
+        "attributes": { # A set of attributes as key-value pairs. # Optional. A set of attributes on the link. Up to 32 attributes can be specified per link.
+          "attributeMap": { # Optional. A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false }
             "a_key": { # The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute.
-              "boolValue": True or False, # A Boolean value represented by `true` or `false`.
-              "intValue": "A String", # A 64-bit signed integer.
-              "stringValue": { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.
-                "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
-                "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
+              "boolValue": True or False, # Optional. A Boolean value represented by `true` or `false`.
+              "intValue": "A String", # Optional. A 64-bit signed integer.
+              "stringValue": { # Represents a string that might be shortened to a specified length. # Optional. A string up to 256 bytes long.
+                "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
+                "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
               },
             },
           },
-          "droppedAttributesCount": 42, # The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid.
+          "droppedAttributesCount": 42, # Optional. The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid.
         },
-        "spanId": "A String", # The `[SPAN_ID]` for a span within a trace.
-        "traceId": "A String", # The `[TRACE_ID]` for a trace within a project.
-        "type": "A String", # The relationship of the current span relative to the linked span.
+        "spanId": "A String", # Optional. The `[SPAN_ID]` for a span within a trace.
+        "traceId": "A String", # Optional. The `[TRACE_ID]` for a trace within a project.
+        "type": "A String", # Optional. The relationship of the current span relative to the linked span.
       },
     ],
   },
-  "name": "A String", # Required. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. .
-  "parentSpanId": "A String", # The `[SPAN_ID]` of this span's parent span. If this is a root span, then this field must be empty.
+  "name": "A String", # Identifier. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. .
+  "parentSpanId": "A String", # Optional. The `[SPAN_ID]` of this span's parent span. If this is a root span, then this field must be empty.
   "sameProcessAsParentSpan": True or False, # Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Trace is unable to take advantage of this helpful information.
   "spanId": "A String", # Required. The `[SPAN_ID]` portion of the span's resource name.
   "spanKind": "A String", # Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call.
-  "stackTrace": { # A call stack appearing in a trace. # Stack trace captured at the start of the span.
-    "stackFrames": { # A collection of stack frames, which can be truncated. # Stack frames in this stack trace. A maximum of 128 frames are allowed.
-      "droppedFramesCount": 42, # The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped.
-      "frame": [ # Stack frames in this call stack.
+  "stackTrace": { # A call stack appearing in a trace. # Optional. Stack trace captured at the start of the span.
+    "stackFrames": { # A collection of stack frames, which can be truncated. # Optional. Stack frames in this stack trace. A maximum of 128 frames are allowed.
+      "droppedFramesCount": 42, # Optional. The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped.
+      "frame": [ # Optional. Stack frames in this call stack.
         { # Represents a single stack frame in a stack trace.
-          "columnNumber": "A String", # The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions.
-          "fileName": { # Represents a string that might be shortened to a specified length. # The name of the source file where the function call appears (up to 256 bytes).
-            "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
-            "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
+          "columnNumber": "A String", # Optional. The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions.
+          "fileName": { # Represents a string that might be shortened to a specified length. # Optional. The name of the source file where the function call appears (up to 256 bytes).
+            "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
+            "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
           },
-          "functionName": { # Represents a string that might be shortened to a specified length. # The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes).
-            "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
-            "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
+          "functionName": { # Represents a string that might be shortened to a specified length. # Optional. The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes).
+            "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
+            "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
           },
-          "lineNumber": "A String", # The line number in `file_name` where the function call appears.
-          "loadModule": { # Binary module. # The binary module from where the code was loaded.
-            "buildId": { # Represents a string that might be shortened to a specified length. # A unique identifier for the module, usually a hash of its contents (up to 128 bytes).
-              "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
-              "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
+          "lineNumber": "A String", # Optional. The line number in `file_name` where the function call appears.
+          "loadModule": { # Binary module. # Optional. The binary module from where the code was loaded.
+            "buildId": { # Represents a string that might be shortened to a specified length. # Optional. A unique identifier for the module, usually a hash of its contents (up to 128 bytes).
+              "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
+              "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
             },
-            "module": { # Represents a string that might be shortened to a specified length. # For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes).
-              "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
-              "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
+            "module": { # Represents a string that might be shortened to a specified length. # Optional. For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes).
+              "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
+              "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
             },
           },
-          "originalFunctionName": { # Represents a string that might be shortened to a specified length. # An un-mangled function name, if `function_name` is mangled. To get information about name mangling, run [this search](https://www.google.com/search?q=cxx+name+mangling). The name can be fully-qualified (up to 1024 bytes).
-            "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
-            "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
+          "originalFunctionName": { # Represents a string that might be shortened to a specified length. # Optional. An un-mangled function name, if `function_name` is mangled. To get information about name mangling, run [this search](https://www.google.com/search?q=cxx+name+mangling). The name can be fully-qualified (up to 1024 bytes).
+            "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
+            "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
           },
-          "sourceVersion": { # Represents a string that might be shortened to a specified length. # The version of the deployed source code (up to 128 bytes).
-            "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
-            "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
+          "sourceVersion": { # Represents a string that might be shortened to a specified length. # Optional. The version of the deployed source code (up to 128 bytes).
+            "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
+            "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
           },
         },
       ],
     },
-    "stackTraceHashId": "A String", # The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both the `stackFrame` content and a value in `stackTraceHashId`. Subsequent spans within the same request can refer to that stack trace by only setting `stackTraceHashId`.
+    "stackTraceHashId": "A String", # Optional. The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both the `stackFrame` content and a value in `stackTraceHashId`. Subsequent spans within the same request can refer to that stack trace by only setting `stackTraceHashId`.
   },
   "startTime": "A String", # Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Optional. The final status for this span.
@@ -191,37 +191,37 @@ 

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. }, - "timeEvents": { # A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans. # A set of time events. You can have up to 32 annotations and 128 message events per span. - "droppedAnnotationsCount": 42, # The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped. - "droppedMessageEventsCount": 42, # The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped. - "timeEvent": [ # A collection of `TimeEvent`s. + "timeEvents": { # A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans. # Optional. A set of time events. You can have up to 32 annotations and 128 message events per span. + "droppedAnnotationsCount": 42, # Optional. The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped. + "droppedMessageEventsCount": 42, # Optional. The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped. + "timeEvent": [ # Optional. A collection of `TimeEvent`s. { # A time-stamped annotation or message event in the Span. "annotation": { # Text annotation with a set of attributes. # Text annotation with a set of attributes. - "attributes": { # A set of attributes as key-value pairs. # A set of attributes on the annotation. You can have up to 4 attributes per Annotation. - "attributeMap": { # A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } + "attributes": { # A set of attributes as key-value pairs. # Optional. A set of attributes on the annotation. You can have up to 4 attributes per Annotation. + "attributeMap": { # Optional. A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } "a_key": { # The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute. - "boolValue": True or False, # A Boolean value represented by `true` or `false`. - "intValue": "A String", # A 64-bit signed integer. - "stringValue": { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long. - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "boolValue": True or False, # Optional. A Boolean value represented by `true` or `false`. + "intValue": "A String", # Optional. A 64-bit signed integer. + "stringValue": { # Represents a string that might be shortened to a specified length. # Optional. A string up to 256 bytes long. + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, }, - "droppedAttributesCount": 42, # The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. + "droppedAttributesCount": 42, # Optional. The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. }, - "description": { # Represents a string that might be shortened to a specified length. # A user-supplied message describing the event. The maximum length for the description is 256 bytes. - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "description": { # Represents a string that might be shortened to a specified length. # Optional. A user-supplied message describing the event. The maximum length for the description is 256 bytes. + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, "messageEvent": { # An event describing a message sent/received between Spans. # An event describing a message sent/received between Spans. - "compressedSizeBytes": "A String", # The number of compressed bytes sent or received. If missing, the compressed size is assumed to be the same size as the uncompressed size. - "id": "A String", # An identifier for the MessageEvent's message that can be used to match `SENT` and `RECEIVED` MessageEvents. - "type": "A String", # Type of MessageEvent. Indicates whether the message was sent or received. - "uncompressedSizeBytes": "A String", # The number of uncompressed bytes sent or received. + "compressedSizeBytes": "A String", # Optional. The number of compressed bytes sent or received. If missing, the compressed size is assumed to be the same size as the uncompressed size. + "id": "A String", # Optional. An identifier for the MessageEvent's message that can be used to match `SENT` and `RECEIVED` MessageEvents. + "type": "A String", # Optional. Type of MessageEvent. Indicates whether the message was sent or received. + "uncompressedSizeBytes": "A String", # Optional. The number of uncompressed bytes sent or received. }, - "time": "A String", # The timestamp indicating the time the event occurred. + "time": "A String", # Optional. The timestamp indicating the time the event occurred. }, ], }, @@ -236,90 +236,90 @@

Method Details

An object of the form: { # A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous. There might be gaps or overlaps between spans in a trace. - "attributes": { # A set of attributes as key-value pairs. # A set of attributes on the span. You can have up to 32 attributes per span. - "attributeMap": { # A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } + "attributes": { # A set of attributes as key-value pairs. # Optional. A set of attributes on the span. You can have up to 32 attributes per span. + "attributeMap": { # Optional. A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } "a_key": { # The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute. - "boolValue": True or False, # A Boolean value represented by `true` or `false`. - "intValue": "A String", # A 64-bit signed integer. - "stringValue": { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long. - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "boolValue": True or False, # Optional. A Boolean value represented by `true` or `false`. + "intValue": "A String", # Optional. A 64-bit signed integer. + "stringValue": { # Represents a string that might be shortened to a specified length. # Optional. A string up to 256 bytes long. + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, }, - "droppedAttributesCount": 42, # The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. + "droppedAttributesCount": 42, # Optional. The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. }, "childSpanCount": 42, # Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans. "displayName": { # Represents a string that might be shortened to a specified length. # Required. A description of the span's operation (up to 128 bytes). Cloud Trace displays the description in the Cloud console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces. - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, "endTime": "A String", # Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running. - "links": { # A collection of links, which are references from this span to a span in the same or different trace. # Links associated with the span. You can have up to 128 links per Span. - "droppedLinksCount": 42, # The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped. - "link": [ # A collection of links. + "links": { # A collection of links, which are references from this span to a span in the same or different trace. # Optional. Links associated with the span. You can have up to 128 links per Span. + "droppedLinksCount": 42, # Optional. The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped. + "link": [ # Optional. A collection of links. { # A pointer from the current span to another span in the same trace or in a different trace. For example, this can be used in batching operations, where a single batch handler processes multiple requests from different traces or when the handler receives a request from a different project. - "attributes": { # A set of attributes as key-value pairs. # A set of attributes on the link. Up to 32 attributes can be specified per link. - "attributeMap": { # A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } + "attributes": { # A set of attributes as key-value pairs. # Optional. A set of attributes on the link. Up to 32 attributes can be specified per link. + "attributeMap": { # Optional. A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } "a_key": { # The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute. - "boolValue": True or False, # A Boolean value represented by `true` or `false`. - "intValue": "A String", # A 64-bit signed integer. - "stringValue": { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long. - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "boolValue": True or False, # Optional. A Boolean value represented by `true` or `false`. + "intValue": "A String", # Optional. A 64-bit signed integer. + "stringValue": { # Represents a string that might be shortened to a specified length. # Optional. A string up to 256 bytes long. + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, }, - "droppedAttributesCount": 42, # The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. + "droppedAttributesCount": 42, # Optional. The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. }, - "spanId": "A String", # The `[SPAN_ID]` for a span within a trace. - "traceId": "A String", # The `[TRACE_ID]` for a trace within a project. - "type": "A String", # The relationship of the current span relative to the linked span. + "spanId": "A String", # Optional. The `[SPAN_ID]` for a span within a trace. + "traceId": "A String", # Optional. The `[TRACE_ID]` for a trace within a project. + "type": "A String", # Optional. The relationship of the current span relative to the linked span. }, ], }, - "name": "A String", # Required. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. . - "parentSpanId": "A String", # The `[SPAN_ID]` of this span's parent span. If this is a root span, then this field must be empty. + "name": "A String", # Identifier. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. . + "parentSpanId": "A String", # Optional. The `[SPAN_ID]` of this span's parent span. If this is a root span, then this field must be empty. "sameProcessAsParentSpan": True or False, # Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Trace is unable to take advantage of this helpful information. "spanId": "A String", # Required. The `[SPAN_ID]` portion of the span's resource name. "spanKind": "A String", # Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call. - "stackTrace": { # A call stack appearing in a trace. # Stack trace captured at the start of the span. - "stackFrames": { # A collection of stack frames, which can be truncated. # Stack frames in this stack trace. A maximum of 128 frames are allowed. - "droppedFramesCount": 42, # The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped. - "frame": [ # Stack frames in this call stack. + "stackTrace": { # A call stack appearing in a trace. # Optional. Stack trace captured at the start of the span. + "stackFrames": { # A collection of stack frames, which can be truncated. # Optional. Stack frames in this stack trace. A maximum of 128 frames are allowed. + "droppedFramesCount": 42, # Optional. The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped. + "frame": [ # Optional. Stack frames in this call stack. { # Represents a single stack frame in a stack trace. - "columnNumber": "A String", # The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions. - "fileName": { # Represents a string that might be shortened to a specified length. # The name of the source file where the function call appears (up to 256 bytes). - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "columnNumber": "A String", # Optional. The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions. + "fileName": { # Represents a string that might be shortened to a specified length. # Optional. The name of the source file where the function call appears (up to 256 bytes). + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, - "functionName": { # Represents a string that might be shortened to a specified length. # The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes). - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "functionName": { # Represents a string that might be shortened to a specified length. # Optional. The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes). + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, - "lineNumber": "A String", # The line number in `file_name` where the function call appears. - "loadModule": { # Binary module. # The binary module from where the code was loaded. - "buildId": { # Represents a string that might be shortened to a specified length. # A unique identifier for the module, usually a hash of its contents (up to 128 bytes). - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "lineNumber": "A String", # Optional. The line number in `file_name` where the function call appears. + "loadModule": { # Binary module. # Optional. The binary module from where the code was loaded. + "buildId": { # Represents a string that might be shortened to a specified length. # Optional. A unique identifier for the module, usually a hash of its contents (up to 128 bytes). + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, - "module": { # Represents a string that might be shortened to a specified length. # For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes). - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "module": { # Represents a string that might be shortened to a specified length. # Optional. For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes). + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, - "originalFunctionName": { # Represents a string that might be shortened to a specified length. # An un-mangled function name, if `function_name` is mangled. To get information about name mangling, run [this search](https://www.google.com/search?q=cxx+name+mangling). The name can be fully-qualified (up to 1024 bytes). - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "originalFunctionName": { # Represents a string that might be shortened to a specified length. # Optional. An un-mangled function name, if `function_name` is mangled. To get information about name mangling, run [this search](https://www.google.com/search?q=cxx+name+mangling). The name can be fully-qualified (up to 1024 bytes). + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, - "sourceVersion": { # Represents a string that might be shortened to a specified length. # The version of the deployed source code (up to 128 bytes). - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "sourceVersion": { # Represents a string that might be shortened to a specified length. # Optional. The version of the deployed source code (up to 128 bytes). + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, ], }, - "stackTraceHashId": "A String", # The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both the `stackFrame` content and a value in `stackTraceHashId`. Subsequent spans within the same request can refer to that stack trace by only setting `stackTraceHashId`. + "stackTraceHashId": "A String", # Optional. The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both the `stackFrame` content and a value in `stackTraceHashId`. Subsequent spans within the same request can refer to that stack trace by only setting `stackTraceHashId`. }, "startTime": "A String", # Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running. "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Optional. The final status for this span. @@ -331,37 +331,37 @@

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. }, - "timeEvents": { # A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans. # A set of time events. You can have up to 32 annotations and 128 message events per span. - "droppedAnnotationsCount": 42, # The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped. - "droppedMessageEventsCount": 42, # The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped. - "timeEvent": [ # A collection of `TimeEvent`s. + "timeEvents": { # A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans. # Optional. A set of time events. You can have up to 32 annotations and 128 message events per span. + "droppedAnnotationsCount": 42, # Optional. The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped. + "droppedMessageEventsCount": 42, # Optional. The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped. + "timeEvent": [ # Optional. A collection of `TimeEvent`s. { # A time-stamped annotation or message event in the Span. "annotation": { # Text annotation with a set of attributes. # Text annotation with a set of attributes. - "attributes": { # A set of attributes as key-value pairs. # A set of attributes on the annotation. You can have up to 4 attributes per Annotation. - "attributeMap": { # A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } + "attributes": { # A set of attributes as key-value pairs. # Optional. A set of attributes on the annotation. You can have up to 4 attributes per Annotation. + "attributeMap": { # Optional. A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "example.com/myattribute": { "bool_value": false } "a_key": { # The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute. - "boolValue": True or False, # A Boolean value represented by `true` or `false`. - "intValue": "A String", # A 64-bit signed integer. - "stringValue": { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long. - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "boolValue": True or False, # Optional. A Boolean value represented by `true` or `false`. + "intValue": "A String", # Optional. A 64-bit signed integer. + "stringValue": { # Represents a string that might be shortened to a specified length. # Optional. A string up to 256 bytes long. + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, }, - "droppedAttributesCount": 42, # The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. + "droppedAttributesCount": 42, # Optional. The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. }, - "description": { # Represents a string that might be shortened to a specified length. # A user-supplied message describing the event. The maximum length for the description is 256 bytes. - "truncatedByteCount": 42, # The number of bytes removed from the original string. If this value is 0, then the string was not shortened. - "value": "A String", # The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + "description": { # Represents a string that might be shortened to a specified length. # Optional. A user-supplied message describing the event. The maximum length for the description is 256 bytes. + "truncatedByteCount": 42, # Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + "value": "A String", # Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. }, }, "messageEvent": { # An event describing a message sent/received between Spans. # An event describing a message sent/received between Spans. - "compressedSizeBytes": "A String", # The number of compressed bytes sent or received. If missing, the compressed size is assumed to be the same size as the uncompressed size. - "id": "A String", # An identifier for the MessageEvent's message that can be used to match `SENT` and `RECEIVED` MessageEvents. - "type": "A String", # Type of MessageEvent. Indicates whether the message was sent or received. - "uncompressedSizeBytes": "A String", # The number of uncompressed bytes sent or received. + "compressedSizeBytes": "A String", # Optional. The number of compressed bytes sent or received. If missing, the compressed size is assumed to be the same size as the uncompressed size. + "id": "A String", # Optional. An identifier for the MessageEvent's message that can be used to match `SENT` and `RECEIVED` MessageEvents. + "type": "A String", # Optional. Type of MessageEvent. Indicates whether the message was sent or received. + "uncompressedSizeBytes": "A String", # Optional. The number of uncompressed bytes sent or received. }, - "time": "A String", # The timestamp indicating the time the event occurred. + "time": "A String", # Optional. The timestamp indicating the time the event occurred. }, ], }, diff --git a/docs/dyn/config_v1.projects.locations.previews.html b/docs/dyn/config_v1.projects.locations.previews.html index a26b20a903..2e868a88e6 100644 --- a/docs/dyn/config_v1.projects.locations.previews.html +++ b/docs/dyn/config_v1.projects.locations.previews.html @@ -127,7 +127,7 @@

Method Details

"artifactsGcsBucket": "A String", # User-defined location of Cloud Build logs, artifacts, and in Google Cloud Storage. Format: `gs://{bucket}/{folder}` A default bucket will be bootstrapped if the field is not set or empty Default Bucket Format: `gs://--blueprint-config` Constraints: - The bucket needs to be in the same project as the deployment - The path cannot be within the path of `gcs_source` If omitted and deployment resource ref provided has artifacts_gcs_bucket defined, that artifact bucket is used. "build": "A String", # Output only. Cloud Build instance UUID associated with this preview. "createTime": "A String", # Output only. Time the preview was created. - "deployment": "A String", # Optional. Optional deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request. + "deployment": "A String", # Optional. Deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request. "errorCode": "A String", # Output only. Code describing any errors that may have occurred. "errorLogs": "A String", # Output only. Link to tf-error.ndjson file, which contains the full list of the errors encountered during a Terraform preview. Format: `gs://{bucket}/{object}`. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Additional information regarding the current state. @@ -312,7 +312,7 @@

Method Details

"artifactsGcsBucket": "A String", # User-defined location of Cloud Build logs, artifacts, and in Google Cloud Storage. Format: `gs://{bucket}/{folder}` A default bucket will be bootstrapped if the field is not set or empty Default Bucket Format: `gs://--blueprint-config` Constraints: - The bucket needs to be in the same project as the deployment - The path cannot be within the path of `gcs_source` If omitted and deployment resource ref provided has artifacts_gcs_bucket defined, that artifact bucket is used. "build": "A String", # Output only. Cloud Build instance UUID associated with this preview. "createTime": "A String", # Output only. Time the preview was created. - "deployment": "A String", # Optional. Optional deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request. + "deployment": "A String", # Optional. Deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request. "errorCode": "A String", # Output only. Code describing any errors that may have occurred. "errorLogs": "A String", # Output only. Link to tf-error.ndjson file, which contains the full list of the errors encountered during a Terraform preview. Format: `gs://{bucket}/{object}`. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Additional information regarding the current state. @@ -410,7 +410,7 @@

Method Details

"artifactsGcsBucket": "A String", # User-defined location of Cloud Build logs, artifacts, and in Google Cloud Storage. Format: `gs://{bucket}/{folder}` A default bucket will be bootstrapped if the field is not set or empty Default Bucket Format: `gs://--blueprint-config` Constraints: - The bucket needs to be in the same project as the deployment - The path cannot be within the path of `gcs_source` If omitted and deployment resource ref provided has artifacts_gcs_bucket defined, that artifact bucket is used. "build": "A String", # Output only. Cloud Build instance UUID associated with this preview. "createTime": "A String", # Output only. Time the preview was created. - "deployment": "A String", # Optional. Optional deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request. + "deployment": "A String", # Optional. Deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request. "errorCode": "A String", # Output only. Code describing any errors that may have occurred. "errorLogs": "A String", # Output only. Link to tf-error.ndjson file, which contains the full list of the errors encountered during a Terraform preview. Format: `gs://{bucket}/{object}`. "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Additional information regarding the current state. diff --git a/docs/dyn/css_v1.accounts.quotas.html b/docs/dyn/css_v1.accounts.quotas.html index b356b9344e..1c292ff030 100644 --- a/docs/dyn/css_v1.accounts.quotas.html +++ b/docs/dyn/css_v1.accounts.quotas.html @@ -120,7 +120,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the quota group. Format: accounts/{account}/quotas/{group} Example: `accounts/12345678/quotas/css-products-insert` Note: The {group} part is not guaranteed to follow a specific pattern. "quotaLimit": "A String", # Output only. The maximum number of calls allowed per day for the group. "quotaMinuteLimit": "A String", # Output only. The maximum number of calls allowed per minute for the group. - "quotaUsage": "A String", # Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at at 12:00 PM midday UTC. + "quotaUsage": "A String", # Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at 12:00 PM midday UTC. }, ], }
diff --git a/docs/dyn/dns_v1.changes.html b/docs/dyn/dns_v1.changes.html index 140228bdd6..20ded007ab 100644 --- a/docs/dyn/dns_v1.changes.html +++ b/docs/dyn/dns_v1.changes.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)

-

Atomically updates the ResourceRecordSet collection.

+

Atomically updates the ResourceRecordSet collection. Note: While `dns.changes.create` is the baseline permission required to invoke this method, additional permissions are checked depending on the specific additions or deletions contained in the payload.

get(project, managedZone, changeId, clientOperationId=None, x__xgafv=None)

Fetches the representation of an existing Change.

@@ -97,7 +97,7 @@

Method Details

create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None) -
Atomically updates the ResourceRecordSet collection.
+  
Atomically updates the ResourceRecordSet collection. Note: While `dns.changes.create` is the baseline permission required to invoke this method, additional permissions are checked depending on the specific additions or deletions contained in the payload.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
diff --git a/docs/dyn/dns_v1.managedZones.html b/docs/dyn/dns_v1.managedZones.html
index f665656b24..b9d58b30fd 100644
--- a/docs/dyn/dns_v1.managedZones.html
+++ b/docs/dyn/dns_v1.managedZones.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

create(project, body=None, clientOperationId=None, x__xgafv=None)

-

Creates a new ManagedZone.

+

Creates a new ManagedZone. Note: While `dns.managedZones.create` is the baseline permission required to invoke this method, additional permissions are required if the managed zone configuration references other resources.

delete(project, managedZone, clientOperationId=None, x__xgafv=None)

Deletes a previously created ManagedZone.

@@ -115,7 +115,7 @@

Method Details

create(project, body=None, clientOperationId=None, x__xgafv=None) -
Creates a new ManagedZone.
+  
Creates a new ManagedZone. Note: While `dns.managedZones.create` is the baseline permission required to invoke this method, additional permissions are required if the managed zone configuration references other resources.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
diff --git a/docs/dyn/dns_v1beta2.changes.html b/docs/dyn/dns_v1beta2.changes.html
index 2e684e4260..22834ac8dd 100644
--- a/docs/dyn/dns_v1beta2.changes.html
+++ b/docs/dyn/dns_v1beta2.changes.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)

-

Atomically updates the ResourceRecordSet collection.

+

Atomically updates the ResourceRecordSet collection. Note: While `dns.changes.create` is the baseline permission required to invoke this method, additional permissions are checked depending on the specific additions or deletions contained in the payload.

get(project, managedZone, changeId, clientOperationId=None, x__xgafv=None)

Fetches the representation of an existing Change.

@@ -97,7 +97,7 @@

Method Details

create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None) -
Atomically updates the ResourceRecordSet collection.
+  
Atomically updates the ResourceRecordSet collection. Note: While `dns.changes.create` is the baseline permission required to invoke this method, additional permissions are checked depending on the specific additions or deletions contained in the payload.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
diff --git a/docs/dyn/dns_v1beta2.managedZones.html b/docs/dyn/dns_v1beta2.managedZones.html
index 3d1b954217..6dc9cf90cf 100644
--- a/docs/dyn/dns_v1beta2.managedZones.html
+++ b/docs/dyn/dns_v1beta2.managedZones.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

create(project, body=None, clientOperationId=None, x__xgafv=None)

-

Creates a new ManagedZone.

+

Creates a new ManagedZone. Note: While `dns.managedZones.create` is the baseline permission required to invoke this method, additional permissions are required if the managed zone configuration references other resources.

delete(project, managedZone, clientOperationId=None, x__xgafv=None)

Deletes a previously created ManagedZone.

@@ -115,7 +115,7 @@

Method Details

create(project, body=None, clientOperationId=None, x__xgafv=None) -
Creates a new ManagedZone.
+  
Creates a new ManagedZone. Note: While `dns.managedZones.create` is the baseline permission required to invoke this method, additional permissions are required if the managed zone configuration references other resources.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
diff --git a/docs/dyn/fcmdata_v1beta1.projects.androidApps.deliveryData.html b/docs/dyn/fcmdata_v1beta1.projects.androidApps.deliveryData.html
index 9a8ff733f7..b7672a20a8 100644
--- a/docs/dyn/fcmdata_v1beta1.projects.androidApps.deliveryData.html
+++ b/docs/dyn/fcmdata_v1beta1.projects.androidApps.deliveryData.html
@@ -116,7 +116,7 @@ 

Method Details

"deliveryPerformancePercents": { # Overview of delivery performance for messages that were successfully delivered. All percentages are calculated with countMessagesAccepted as the denominator. These categories are not mutually exclusive; a message can be delayed for multiple reasons. # Additional information about delivery performance for messages that were successfully delivered. "delayedDeviceDoze": 3.14, # The percentage of accepted messages that were delayed because the device was in doze mode. Only [normal priority messages](https://firebase.google.com/docs/cloud-messaging/concept-options#setting-the-priority-of-a-message) should be delayed due to doze mode. "delayedDeviceOffline": 3.14, # The percentage of accepted messages that were delayed because the target device was not connected at the time of sending. These messages were eventually delivered when the device reconnected. - "delayedMessageThrottled": 3.14, # The percentage of accepted messages that were delayed due to message throttling, such as [collapsible message throttling](https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_throttling) or [maximum message rate throttling](https://firebase.google.com/docs/cloud-messaging/concept-options#device_throttling). + "delayedMessageThrottled": 3.14, # The percentage of accepted messages that were delayed due to message throttling, such as [collapsible message throttling](https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_throttling). "delayedUserStopped": 3.14, # The percentage of accepted messages that were delayed because the intended device user-profile was [stopped](https://firebase.google.com/docs/cloud-messaging/android/receive#handling_messages) on the target device at the time of the send. The messages were eventually delivered when the user-profile was started again. "deliveredNoDelay": 3.14, # The percentage of accepted messages that were delivered to the device without delay from the FCM system. }, diff --git a/docs/dyn/firebasestorage_v1beta.projects.defaultBucket.html b/docs/dyn/firebasestorage_v1beta.projects.defaultBucket.html index 2b5523edef..48b6489793 100644 --- a/docs/dyn/firebasestorage_v1beta.projects.defaultBucket.html +++ b/docs/dyn/firebasestorage_v1beta.projects.defaultBucket.html @@ -99,7 +99,7 @@

Method Details

"bucket": { # A storage bucket and its relation to a parent Firebase project. # Output only. Underlying bucket resource. "name": "A String", # Output only. Resource name of the bucket. }, - "location": "A String", # Immutable. Location of the default bucket. + "location": "A String", # Required. Immutable. Location of the default bucket. "name": "A String", # Identifier. Resource name of the default bucket. "storageClass": "A String", # Immutable. Storage class of the default bucket. Supported values are available at https://cloud.google.com/storage/docs/storage-classes#classes. } @@ -116,7 +116,7 @@

Method Details

"bucket": { # A storage bucket and its relation to a parent Firebase project. # Output only. Underlying bucket resource. "name": "A String", # Output only. Resource name of the bucket. }, - "location": "A String", # Immutable. Location of the default bucket. + "location": "A String", # Required. Immutable. Location of the default bucket. "name": "A String", # Identifier. Resource name of the default bucket. "storageClass": "A String", # Immutable. Storage class of the default bucket. Supported values are available at https://cloud.google.com/storage/docs/storage-classes#classes. }
diff --git a/docs/dyn/firebasestorage_v1beta.projects.html b/docs/dyn/firebasestorage_v1beta.projects.html index 61adcd6072..9defd0fc79 100644 --- a/docs/dyn/firebasestorage_v1beta.projects.html +++ b/docs/dyn/firebasestorage_v1beta.projects.html @@ -135,7 +135,7 @@

Method Details

"bucket": { # A storage bucket and its relation to a parent Firebase project. # Output only. Underlying bucket resource. "name": "A String", # Output only. Resource name of the bucket. }, - "location": "A String", # Immutable. Location of the default bucket. + "location": "A String", # Required. Immutable. Location of the default bucket. "name": "A String", # Identifier. Resource name of the default bucket. "storageClass": "A String", # Immutable. Storage class of the default bucket. Supported values are available at https://cloud.google.com/storage/docs/storage-classes#classes. }
diff --git a/docs/dyn/looker_v1.projects.locations.instances.html b/docs/dyn/looker_v1.projects.locations.instances.html index 7a95140743..2e871abd66 100644 --- a/docs/dyn/looker_v1.projects.locations.instances.html +++ b/docs/dyn/looker_v1.projects.locations.instances.html @@ -614,7 +614,7 @@

Method Details

An object of the form: { # Response from ListInstances. - "instances": [ # The list of instances matching the request filters, up to the requested ListInstancesRequest.pageSize. + "instances": [ # The list of instances matching the request filters, up to the requested `pageSize`. { # A Looker instance. "acceleratedSecurityPatchEnabled": True or False, # Optional. Accelerated security patch enabled for the instance. "adminSettings": { # Looker instance Admin settings fields. # Looker Instance Admin settings. @@ -764,7 +764,7 @@

Method Details

}, }, ], - "nextPageToken": "A String", # If provided, a page token that can look up the next ListInstancesRequest.pageSize results. If empty, the results list is exhausted. + "nextPageToken": "A String", # If provided, a page token that can look up the next `pageSize` results. If empty, the results list is exhausted. "unreachable": [ # Locations that could not be reached. "A String", ], diff --git a/docs/dyn/mybusinessbusinessinformation_v1.attributes.html b/docs/dyn/mybusinessbusinessinformation_v1.attributes.html index ced1ad20a0..83dfb7e61a 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.attributes.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.attributes.html @@ -94,13 +94,13 @@

Method Details

Returns the list of attributes that would be available for a location with the given primary category and country.
 
 Args:
-  categoryName: string, The primary category stable ID to find available attributes. Must be of the format categories/{category_id}.
-  languageCode: string, The BCP 47 code of language to get attribute display names in. If this language is not available, they will be provided in English.
+  categoryName: string, Optional. The primary category stable ID to find available attributes. Must be of the format `categories/{category_id}` (e.g., `categories/gcid:restaurant`). Required if `parent` is not set and `show_all` is false.
+  languageCode: string, Optional. The BCP 47 code of language to get attribute display names in. If this language is not available, they will be provided in English.
   pageSize: integer, How many attributes to include per page. Default is 200, minimum is 1.
   pageToken: string, If specified, the next page of attribute metadata is retrieved.
-  parent: string, Resource name of the location to look up available attributes. If this field is set, category_name, region_code, language_code and show_all are not required and must not be set.
-  regionCode: string, The ISO 3166-1 alpha-2 country code to find available attributes.
-  showAll: boolean, Metadata for all available attributes are returned when this field is set to true, disregarding parent and category_name fields. language_code and region_code are required when show_all is set to true.
+  parent: string, Optional. Resource name of the location to look up available attributes. If this field is set, `category_name`, `region_code`, `language_code` and `show_all` are not required and must not be set. Format: `locations/{location_id}` (e.g., `locations/1234567890`).
+  regionCode: string, Optional. The ISO 3166-1 alpha-2 country code to find available attributes. Required if `parent` is not set.
+  showAll: boolean, Optional. If set to true, metadata for all available attributes are returned, disregarding `parent` and `category_name` fields. `language_code` and `region_code` are required when `show_all` is set to true.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/notebooks_v2.projects.locations.instances.html b/docs/dyn/notebooks_v2.projects.locations.instances.html
index 910e970857..aba315aa00 100644
--- a/docs/dyn/notebooks_v2.projects.locations.instances.html
+++ b/docs/dyn/notebooks_v2.projects.locations.instances.html
@@ -228,10 +228,10 @@ 

Method Details

}, ], "bootDisk": { # The definition of a boot disk. # Optional. The boot disk for the VM. - "diskEncryption": "A String", # Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. + "diskEncryption": "A String", # Optional. Disk encryption method used on the boot and data disks, defaults to GMEK. "diskSizeGb": "A String", # Optional. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to the recommended value of 150GB. "diskType": "A String", # Optional. Indicates the type of the disk. - "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. }, "confidentialInstanceConfig": { # A set of Confidential Instance options. # Optional. Confidential instance configuration. "confidentialInstanceType": "A String", # Optional. Defines the type of technology used by the confidential instance. @@ -242,10 +242,10 @@

Method Details

}, "dataDisks": [ # Optional. Data disks attached to the VM instance. Currently supports only one data disk. { # An instance-attached disk resource. - "diskEncryption": "A String", # Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. + "diskEncryption": "A String", # Optional. Disk encryption method used on the boot and data disks, defaults to GMEK. "diskSizeGb": "A String", # Optional. The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to 100. "diskType": "A String", # Optional. Indicates the type of the disk. - "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. "resourcePolicies": [ # Optional. The resource policies to apply to the data disk. "A String", ], @@ -267,7 +267,7 @@

Method Details

{ # The definition of a network interface resource attached to a VM. "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If no accessConfigs specified, the instance will have an external internet access through an ephemeral external IP address. { # An access configuration attached to an instance's network interface. - "externalIp": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. + "externalIp": "A String", # Optional. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. }, ], "network": "A String", # Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}` @@ -511,10 +511,10 @@

Method Details

}, ], "bootDisk": { # The definition of a boot disk. # Optional. The boot disk for the VM. - "diskEncryption": "A String", # Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. + "diskEncryption": "A String", # Optional. Disk encryption method used on the boot and data disks, defaults to GMEK. "diskSizeGb": "A String", # Optional. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to the recommended value of 150GB. "diskType": "A String", # Optional. Indicates the type of the disk. - "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. }, "confidentialInstanceConfig": { # A set of Confidential Instance options. # Optional. Confidential instance configuration. "confidentialInstanceType": "A String", # Optional. Defines the type of technology used by the confidential instance. @@ -525,10 +525,10 @@

Method Details

}, "dataDisks": [ # Optional. Data disks attached to the VM instance. Currently supports only one data disk. { # An instance-attached disk resource. - "diskEncryption": "A String", # Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. + "diskEncryption": "A String", # Optional. Disk encryption method used on the boot and data disks, defaults to GMEK. "diskSizeGb": "A String", # Optional. The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to 100. "diskType": "A String", # Optional. Indicates the type of the disk. - "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. "resourcePolicies": [ # Optional. The resource policies to apply to the data disk. "A String", ], @@ -550,7 +550,7 @@

Method Details

{ # The definition of a network interface resource attached to a VM. "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If no accessConfigs specified, the instance will have an external internet access through an ephemeral external IP address. { # An access configuration attached to an instance's network interface. - "externalIp": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. + "externalIp": "A String", # Optional. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. }, ], "network": "A String", # Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}` @@ -729,10 +729,10 @@

Method Details

}, ], "bootDisk": { # The definition of a boot disk. # Optional. The boot disk for the VM. - "diskEncryption": "A String", # Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. + "diskEncryption": "A String", # Optional. Disk encryption method used on the boot and data disks, defaults to GMEK. "diskSizeGb": "A String", # Optional. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to the recommended value of 150GB. "diskType": "A String", # Optional. Indicates the type of the disk. - "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. }, "confidentialInstanceConfig": { # A set of Confidential Instance options. # Optional. Confidential instance configuration. "confidentialInstanceType": "A String", # Optional. Defines the type of technology used by the confidential instance. @@ -743,10 +743,10 @@

Method Details

}, "dataDisks": [ # Optional. Data disks attached to the VM instance. Currently supports only one data disk. { # An instance-attached disk resource. - "diskEncryption": "A String", # Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. + "diskEncryption": "A String", # Optional. Disk encryption method used on the boot and data disks, defaults to GMEK. "diskSizeGb": "A String", # Optional. The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to 100. "diskType": "A String", # Optional. Indicates the type of the disk. - "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. "resourcePolicies": [ # Optional. The resource policies to apply to the data disk. "A String", ], @@ -768,7 +768,7 @@

Method Details

{ # The definition of a network interface resource attached to a VM. "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If no accessConfigs specified, the instance will have an external internet access through an ephemeral external IP address. { # An access configuration attached to an instance's network interface. - "externalIp": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. + "externalIp": "A String", # Optional. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. }, ], "network": "A String", # Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}` @@ -883,10 +883,10 @@

Method Details

}, ], "bootDisk": { # The definition of a boot disk. # Optional. The boot disk for the VM. - "diskEncryption": "A String", # Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. + "diskEncryption": "A String", # Optional. Disk encryption method used on the boot and data disks, defaults to GMEK. "diskSizeGb": "A String", # Optional. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to the recommended value of 150GB. "diskType": "A String", # Optional. Indicates the type of the disk. - "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. }, "confidentialInstanceConfig": { # A set of Confidential Instance options. # Optional. Confidential instance configuration. "confidentialInstanceType": "A String", # Optional. Defines the type of technology used by the confidential instance. @@ -897,10 +897,10 @@

Method Details

}, "dataDisks": [ # Optional. Data disks attached to the VM instance. Currently supports only one data disk. { # An instance-attached disk resource. - "diskEncryption": "A String", # Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. + "diskEncryption": "A String", # Optional. Disk encryption method used on the boot and data disks, defaults to GMEK. "diskSizeGb": "A String", # Optional. The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to 100. "diskType": "A String", # Optional. Indicates the type of the disk. - "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. "resourcePolicies": [ # Optional. The resource policies to apply to the data disk. "A String", ], @@ -922,7 +922,7 @@

Method Details

{ # The definition of a network interface resource attached to a VM. "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If no accessConfigs specified, the instance will have an external internet access through an ephemeral external IP address. { # An access configuration attached to an instance's network interface. - "externalIp": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. + "externalIp": "A String", # Optional. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. }, ], "network": "A String", # Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}` @@ -993,7 +993,7 @@

Method Details

} requestId: string, Optional. Idempotent request UUID. - updateMask: string, Required. Mask used to update an instance. Updatable fields: * `labels` * `gce_setup.min_cpu_platform` * `gce_setup.metadata` * `gce_setup.machine_type` * `gce_setup.accelerator_configs` * `gce_setup.accelerator_configs.type` * `gce_setup.accelerator_configs.core_count` * `gce_setup.gpu_driver_config` * `gce_setup.gpu_driver_config.enable_gpu_driver` * `gce_setup.gpu_driver_config.custom_gpu_driver_path` * `gce_setup.shielded_instance_config` * `gce_setup.shielded_instance_config.enable_secure_boot` * `gce_setup.shielded_instance_config.enable_vtpm` * `gce_setup.shielded_instance_config.enable_integrity_monitoring` * `gce_setup.reservation_affinity` * `gce_setup.reservation_affinity.consume_reservation_type` * `gce_setup.reservation_affinity.key` * `gce_setup.reservation_affinity.values` * `gce_setup.tags` * `gce_setup.container_image` * `gce_setup.container_image.repository` * `gce_setup.container_image.tag` * `gce_setup.disable_public_ip` * `disable_proxy_access` + updateMask: string, Required. Mask used to update an instance. Updatable fields: * `labels` * `gce_setup.min_cpu_platform` * `gce_setup.metadata` * `gce_setup.machine_type` * `gce_setup.accelerator_configs` * `gce_setup.accelerator_configs.type` * `gce_setup.accelerator_configs.core_count` * `gce_setup.gpu_driver_config` * `gce_setup.gpu_driver_config.enable_gpu_driver` * `gce_setup.gpu_driver_config.custom_gpu_driver_path` * `gce_setup.shielded_instance_config` * `gce_setup.shielded_instance_config.enable_secure_boot` * `gce_setup.shielded_instance_config.enable_vtpm` * `gce_setup.shielded_instance_config.enable_integrity_monitoring` * `gce_setup.reservation_affinity` * `gce_setup.reservation_affinity.consume_reservation_type` * `gce_setup.reservation_affinity.key` * `gce_setup.reservation_affinity.values` * `gce_setup.tags` * `gce_setup.container_image` * `gce_setup.container_image.repository` * `gce_setup.container_image.tag` * `gce_setup.disable_public_ip` * `disable_proxy_access` Note: `gce_setup.disable_public_ip` and `disable_proxy_access` are one-way on update -- they can only be used to *disable* the feature (set the field to `true`). Requests that set either field back to `false` (re-enabling the external IP or proxy access) are rejected with `INVALID_ARGUMENT`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1124,16 +1124,16 @@

Method Details

{ # Request for resizing the notebook instance disks "bootDisk": { # The definition of a boot disk. # Required. The boot disk to be resized. Only disk_size_gb will be used. - "diskEncryption": "A String", # Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. + "diskEncryption": "A String", # Optional. Disk encryption method used on the boot and data disks, defaults to GMEK. "diskSizeGb": "A String", # Optional. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to the recommended value of 150GB. "diskType": "A String", # Optional. Indicates the type of the disk. - "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. }, "dataDisk": { # An instance-attached disk resource. # Required. The data disk to be resized. Only disk_size_gb will be used. - "diskEncryption": "A String", # Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. + "diskEncryption": "A String", # Optional. Disk encryption method used on the boot and data disks, defaults to GMEK. "diskSizeGb": "A String", # Optional. The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to 100. "diskType": "A String", # Optional. Indicates the type of the disk. - "kmsKey": "A String", # Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys. "resourcePolicies": [ # Optional. The resource policies to apply to the data disk. "A String", ], diff --git a/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html b/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html index f0d1a5622f..870c4399fe 100644 --- a/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html +++ b/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html @@ -207,7 +207,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -391,7 +391,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -551,7 +551,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. diff --git a/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.html b/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.html index 7ea5eec1eb..7b21d38bb3 100644 --- a/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.html +++ b/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.html @@ -210,7 +210,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -389,7 +389,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -572,7 +572,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. @@ -732,7 +732,7 @@

Method Details

"updateTime": "A String", # Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. }, "etag": "A String", # Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This entity tag (ETag) is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. + "name": "A String", # Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. "spec": { # Defines a Google Cloud policy specification that is used to specify constraints for configurations of Google Cloud resources. # Basic information about the organization policy. "etag": "A String", # An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this entity tag (ETag) indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the ETag will be unset. "inheritFromParent": True or False, # Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies that configure list constraints. diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html index d3770834cb..d9e1d40b3e 100644 --- a/docs/dyn/pubsub_v1.projects.subscriptions.html +++ b/docs/dyn/pubsub_v1.projects.subscriptions.html @@ -171,7 +171,7 @@

Method Details

"subscription": "A String", # Optional. The name of the associated Analytics Hub subscription resource. Pattern: "projects/{project}/locations/{location}/subscriptions/{subscription}" }, "bigqueryConfig": { # Configuration for a BigQuery subscription. # Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it. - "dropUnknownFields": True or False, # Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. + "dropUnknownFields": True or False, # Optional. If true and `use_topic_schema` is true, drops any fields that are part of the topic schema that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. If true and `use_table_schema` is true, drops any fields in the message that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the write to BigQuery will fail. "serviceAccountEmail": "A String", # Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. "table": "A String", # Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId} @@ -285,7 +285,7 @@

Method Details

"subscription": "A String", # Optional. The name of the associated Analytics Hub subscription resource. Pattern: "projects/{project}/locations/{location}/subscriptions/{subscription}" }, "bigqueryConfig": { # Configuration for a BigQuery subscription. # Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it. - "dropUnknownFields": True or False, # Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. + "dropUnknownFields": True or False, # Optional. If true and `use_topic_schema` is true, drops any fields that are part of the topic schema that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. If true and `use_table_schema` is true, drops any fields in the message that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the write to BigQuery will fail. "serviceAccountEmail": "A String", # Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. "table": "A String", # Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId} @@ -442,7 +442,7 @@

Method Details

"subscription": "A String", # Optional. The name of the associated Analytics Hub subscription resource. Pattern: "projects/{project}/locations/{location}/subscriptions/{subscription}" }, "bigqueryConfig": { # Configuration for a BigQuery subscription. # Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it. - "dropUnknownFields": True or False, # Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. + "dropUnknownFields": True or False, # Optional. If true and `use_topic_schema` is true, drops any fields that are part of the topic schema that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. If true and `use_table_schema` is true, drops any fields in the message that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the write to BigQuery will fail. "serviceAccountEmail": "A String", # Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. "table": "A String", # Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId} @@ -603,7 +603,7 @@

Method Details

"subscription": "A String", # Optional. The name of the associated Analytics Hub subscription resource. Pattern: "projects/{project}/locations/{location}/subscriptions/{subscription}" }, "bigqueryConfig": { # Configuration for a BigQuery subscription. # Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it. - "dropUnknownFields": True or False, # Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. + "dropUnknownFields": True or False, # Optional. If true and `use_topic_schema` is true, drops any fields that are part of the topic schema that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. If true and `use_table_schema` is true, drops any fields in the message that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the write to BigQuery will fail. "serviceAccountEmail": "A String", # Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. "table": "A String", # Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId} @@ -803,7 +803,7 @@

Method Details

"subscription": "A String", # Optional. The name of the associated Analytics Hub subscription resource. Pattern: "projects/{project}/locations/{location}/subscriptions/{subscription}" }, "bigqueryConfig": { # Configuration for a BigQuery subscription. # Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it. - "dropUnknownFields": True or False, # Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. + "dropUnknownFields": True or False, # Optional. If true and `use_topic_schema` is true, drops any fields that are part of the topic schema that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. If true and `use_table_schema` is true, drops any fields in the message that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the write to BigQuery will fail. "serviceAccountEmail": "A String", # Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. "table": "A String", # Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId} @@ -919,7 +919,7 @@

Method Details

"subscription": "A String", # Optional. The name of the associated Analytics Hub subscription resource. Pattern: "projects/{project}/locations/{location}/subscriptions/{subscription}" }, "bigqueryConfig": { # Configuration for a BigQuery subscription. # Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it. - "dropUnknownFields": True or False, # Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. + "dropUnknownFields": True or False, # Optional. If true and `use_topic_schema` is true, drops any fields that are part of the topic schema that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. If true and `use_table_schema` is true, drops any fields in the message that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the write to BigQuery will fail. "serviceAccountEmail": "A String", # Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. "table": "A String", # Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId} diff --git a/docs/dyn/readerrevenuesubscriptionlinking_v1.publications.readers.html b/docs/dyn/readerrevenuesubscriptionlinking_v1.publications.readers.html index 0439c6705e..328bebef26 100644 --- a/docs/dyn/readerrevenuesubscriptionlinking_v1.publications.readers.html +++ b/docs/dyn/readerrevenuesubscriptionlinking_v1.publications.readers.html @@ -155,7 +155,7 @@

Method Details

"entitlements": [ # All of the entitlements for a publication reader. { # A single entitlement for a publication reader "detail": "A String", # The detail field can carry a description of the SKU that corresponds to what the user has been granted access to. This description, which is opaque to Google, can be displayed in the Google user subscription console for users who linked the subscription to a Google Account. Max 80 character limit. - "expireTime": "A String", # Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. The max expire_time is 398 days from now(). + "expireTime": "A String", # Optional. Expiration time of the entitlement. If unset, the entitlement does not expire (indefinite entitlement). We need to support indefinite entitlements for platform publishers. dd: go/rrm-sl-notedotcom Entitlements that have expired over 30 days will be purged. "productId": "A String", # Required. The publication's product ID that the user has access to. This is the same product ID as can be found in Schema.org markup (http://schema.org/productID). E.g. "dailybugle.com:basic" "subscriptionToken": "A String", # A source-specific subscription token. This is an opaque string that the publisher provides to Google. This token is opaque and has no meaning to Google. }, @@ -177,7 +177,7 @@

Method Details

"entitlements": [ # All of the entitlements for a publication reader. { # A single entitlement for a publication reader "detail": "A String", # The detail field can carry a description of the SKU that corresponds to what the user has been granted access to. This description, which is opaque to Google, can be displayed in the Google user subscription console for users who linked the subscription to a Google Account. Max 80 character limit. - "expireTime": "A String", # Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. The max expire_time is 398 days from now(). + "expireTime": "A String", # Optional. Expiration time of the entitlement. If unset, the entitlement does not expire (indefinite entitlement). We need to support indefinite entitlements for platform publishers. dd: go/rrm-sl-notedotcom Entitlements that have expired over 30 days will be purged. "productId": "A String", # Required. The publication's product ID that the user has access to. This is the same product ID as can be found in Schema.org markup (http://schema.org/productID). E.g. "dailybugle.com:basic" "subscriptionToken": "A String", # A source-specific subscription token. This is an opaque string that the publisher provides to Google. This token is opaque and has no meaning to Google. }, @@ -198,7 +198,7 @@

Method Details

"entitlements": [ # All of the entitlements for a publication reader. { # A single entitlement for a publication reader "detail": "A String", # The detail field can carry a description of the SKU that corresponds to what the user has been granted access to. This description, which is opaque to Google, can be displayed in the Google user subscription console for users who linked the subscription to a Google Account. Max 80 character limit. - "expireTime": "A String", # Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. The max expire_time is 398 days from now(). + "expireTime": "A String", # Optional. Expiration time of the entitlement. If unset, the entitlement does not expire (indefinite entitlement). We need to support indefinite entitlements for platform publishers. dd: go/rrm-sl-notedotcom Entitlements that have expired over 30 days will be purged. "productId": "A String", # Required. The publication's product ID that the user has access to. This is the same product ID as can be found in Schema.org markup (http://schema.org/productID). E.g. "dailybugle.com:basic" "subscriptionToken": "A String", # A source-specific subscription token. This is an opaque string that the publisher provides to Google. This token is opaque and has no meaning to Google. }, diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html index 983f08d48f..a252943d79 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html @@ -414,7 +414,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -588,7 +588,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -786,7 +786,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -986,7 +986,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1209,7 +1209,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1400,7 +1400,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1575,7 +1575,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1888,7 +1888,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html index e95aa97e0a..56e058075e 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html @@ -229,8 +229,8 @@

Method Details

"params": { # Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given 'score' indicates the probability of a product being clicked/purchased given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results. * `priceRerankLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-price-reranking', 'low-price-reranking', 'medium-price-reranking', 'high-price-reranking'}. This gives request-level control and adjusts prediction results based on product price. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-diversity', 'low-diversity', 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives request-level control and adjusts prediction results based on product category. * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter` field is interpreteted according to the new, attribute-based syntax. "a_key": "", }, - "userEvent": { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. + "userEvent": { # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -252,7 +252,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -420,7 +420,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -592,7 +592,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1064,7 +1064,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html index b3f48e4d43..ced95c9591 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html @@ -711,8 +711,8 @@

Method Details

"params": { # Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given 'score' indicates the probability of a product being clicked/purchased given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results. * `priceRerankLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-price-reranking', 'low-price-reranking', 'medium-price-reranking', 'high-price-reranking'}. This gives request-level control and adjusts prediction results based on product price. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-diversity', 'low-diversity', 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives request-level control and adjusts prediction results based on product category. * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter` field is interpreteted according to the new, attribute-based syntax. "a_key": "", }, - "userEvent": { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. + "userEvent": { # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -734,7 +734,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -902,7 +902,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1074,7 +1074,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1615,7 +1615,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html index 646eb8add4..69f173b042 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

+

Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the AI Commerce Search API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

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

Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.

@@ -100,7 +100,7 @@

Method Details

collect(parent, body=None, x__xgafv=None) -
Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
+  
Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the AI Commerce Search API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
 
 Args:
   parent: string, Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`. (required)
@@ -168,8 +168,8 @@ 

Method Details

}, "userEventInlineSource": { # The inline source for the input config for ImportUserEvents method. # Required. The Inline source for the input content for UserEvents. "userEvents": [ # Required. A list of user events to import. Recommended max of 10k items. - { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. + { # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -191,7 +191,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -359,7 +359,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -531,7 +531,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -695,8 +695,8 @@

Method Details

body: object, The request body. The object takes the form of: -{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. +{ # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -718,7 +718,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -886,7 +886,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1058,7 +1058,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1104,8 +1104,8 @@

Method Details

Returns: An object of the form: - { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. + { # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -1127,7 +1127,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -1295,7 +1295,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1467,7 +1467,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). diff --git a/docs/dyn/retail_v2alpha.projects.html b/docs/dyn/retail_v2alpha.projects.html index b049f4f4fe..359daa4589 100644 --- a/docs/dyn/retail_v2alpha.projects.html +++ b/docs/dyn/retail_v2alpha.projects.html @@ -94,7 +94,7 @@

Instance Methods

Close httplib2 connections.

enrollSolution(project, body=None, x__xgafv=None)

-

The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables Retail API, so you don't need to call the enrollSolution method for recommendations.

+

The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables AI Commerce Search API, so you don't need to call the enrollSolution method for recommendations.

getAlertConfig(name, x__xgafv=None)

Get the AlertConfig of the requested project.

@@ -103,10 +103,10 @@

Instance Methods

Gets the LoggingConfig of the requested project.

getRetailProject(name, x__xgafv=None)

-

Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the Retail API service.

+

Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the AI Commerce Search API service.

listEnrolledSolutions(parent, x__xgafv=None)

-

Lists all the retail API solutions the project has enrolled.

+

Lists all the AI Commerce Search API solutions the project has enrolled.

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

Update the alert config of the requested project.

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

Method Details

enrollSolution(project, body=None, x__xgafv=None) -
The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables Retail API, so you don't need to call the enrollSolution method for recommendations.
+  
The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables AI Commerce Search API, so you don't need to call the enrollSolution method for recommendations.
 
 Args:
   project: string, Required. Full resource name of parent. Format: `projects/{project_number_or_id}` (required)
@@ -225,7 +225,7 @@ 

Method Details

getRetailProject(name, x__xgafv=None) -
Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the Retail API service.
+  
Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the AI Commerce Search API service.
 
 Args:
   name: string, Required. Full resource name of the project. Format: `projects/{project_number_or_id}/retailProject` (required)
@@ -238,7 +238,7 @@ 

Method Details

An object of the form: { # Metadata that describes a Cloud Retail Project. - "enrolledSolutions": [ # Output only. Retail API solutions that the project has enrolled. + "enrolledSolutions": [ # Output only. AI Commerce Search API solutions that the project has enrolled. "A String", ], "name": "A String", # Output only. Full resource name of the retail project, such as `projects/{project_id_or_number}/retailProject`. @@ -247,7 +247,7 @@

Method Details

listEnrolledSolutions(parent, x__xgafv=None) -
Lists all the retail API solutions the project has enrolled.
+  
Lists all the AI Commerce Search API solutions the project has enrolled.
 
 Args:
   parent: string, Required. Full resource name of parent. Format: `projects/{project_number_or_id}` (required)
@@ -260,7 +260,7 @@ 

Method Details

An object of the form: { # Response for ListEnrolledSolutions method. - "enrolledSolutions": [ # Retail API solutions that the project has enrolled. + "enrolledSolutions": [ # AI Commerce Search API solutions that the project has enrolled. "A String", ], }
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html index c16b88f5f7..faa16592fb 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html @@ -294,7 +294,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -506,7 +506,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html index 5c4c541fa5..1755e97f4e 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html @@ -419,7 +419,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -594,7 +594,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -846,7 +846,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1047,7 +1047,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1273,7 +1273,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1466,7 +1466,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1642,7 +1642,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1956,7 +1956,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html index d097786f53..335fa73c98 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html @@ -229,8 +229,8 @@

Method Details

"params": { # Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given 'score' indicates the probability of a product being clicked/purchased given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results. * `priceRerankLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-price-reranking', 'low-price-reranking', 'medium-price-reranking', 'high-price-reranking'}. This gives request-level control and adjusts prediction results based on product price. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-diversity', 'low-diversity', 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives request-level control and adjusts prediction results based on product category. * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter` field is interpreteted according to the new, attribute-based syntax. "a_key": "", }, - "userEvent": { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. + "userEvent": { # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -252,7 +252,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -421,7 +421,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -594,7 +594,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1069,7 +1069,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html index e37d1eafaa..abcc489382 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html @@ -711,8 +711,8 @@

Method Details

"params": { # Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given 'score' indicates the probability of a product being clicked/purchased given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results. * `priceRerankLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-price-reranking', 'low-price-reranking', 'medium-price-reranking', 'high-price-reranking'}. This gives request-level control and adjusts prediction results based on product price. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-diversity', 'low-diversity', 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives request-level control and adjusts prediction results based on product category. * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter` field is interpreteted according to the new, attribute-based syntax. "a_key": "", }, - "userEvent": { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. + "userEvent": { # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -734,7 +734,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -903,7 +903,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1076,7 +1076,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1620,7 +1620,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html index ce5a8ba175..2ec8efb40b 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

+

Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the AI Commerce Search API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

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

Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.

@@ -103,7 +103,7 @@

Method Details

collect(parent, body=None, x__xgafv=None) -
Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
+  
Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the AI Commerce Search API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
 
 Args:
   parent: string, Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`. (required)
@@ -223,8 +223,8 @@ 

Method Details

}, "userEventInlineSource": { # The inline source for the input config for ImportUserEvents method. # Required. The Inline source for the input content for UserEvents. "userEvents": [ # Required. A list of user events to import. Recommended max of 10k items. - { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. + { # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -246,7 +246,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -415,7 +415,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -588,7 +588,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -752,8 +752,8 @@

Method Details

body: object, The request body. The object takes the form of: -{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. +{ # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -775,7 +775,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -944,7 +944,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1117,7 +1117,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1163,8 +1163,8 @@

Method Details

Returns: An object of the form: - { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. + { # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -1186,7 +1186,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -1355,7 +1355,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1528,7 +1528,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). diff --git a/docs/dyn/retail_v2alpha.projects.retailProject.html b/docs/dyn/retail_v2alpha.projects.retailProject.html index 0e004aad6a..16e672bbb1 100644 --- a/docs/dyn/retail_v2alpha.projects.retailProject.html +++ b/docs/dyn/retail_v2alpha.projects.retailProject.html @@ -102,7 +102,7 @@

Method Details

An object of the form: { # Metadata that describes a Cloud Retail Project. - "enrolledSolutions": [ # Output only. Retail API solutions that the project has enrolled. + "enrolledSolutions": [ # Output only. AI Commerce Search API solutions that the project has enrolled. "A String", ], "name": "A String", # Output only. Full resource name of the retail project, such as `projects/{project_id_or_number}/retailProject`. diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html index 055c9418b9..ab8c266413 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html @@ -417,7 +417,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -591,7 +591,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -841,7 +841,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1041,7 +1041,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1264,7 +1264,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1455,7 +1455,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1630,7 +1630,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1943,7 +1943,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html index 1d1d4a141c..01b80ae7dc 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html @@ -229,8 +229,8 @@

Method Details

"params": { # Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given 'score' indicates the probability of a product being clicked/purchased given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results. * `priceRerankLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-price-reranking', 'low-price-reranking', 'medium-price-reranking', 'high-price-reranking'}. This gives request-level control and adjusts prediction results based on product price. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-diversity', 'low-diversity', 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives request-level control and adjusts prediction results based on product category. * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter` field is interpreteted according to the new, attribute-based syntax. "a_key": "", }, - "userEvent": { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. + "userEvent": { # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -252,7 +252,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -420,7 +420,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -592,7 +592,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1064,7 +1064,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html index 655dea2b6d..c9954b28ed 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html @@ -711,8 +711,8 @@

Method Details

"params": { # Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given 'score' indicates the probability of a product being clicked/purchased given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results. * `priceRerankLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-price-reranking', 'low-price-reranking', 'medium-price-reranking', 'high-price-reranking'}. This gives request-level control and adjusts prediction results based on product price. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-diversity', 'low-diversity', 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives request-level control and adjusts prediction results based on product category. * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter` field is interpreteted according to the new, attribute-based syntax. "a_key": "", }, - "userEvent": { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. + "userEvent": { # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -734,7 +734,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -902,7 +902,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1074,7 +1074,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1615,7 +1615,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html index 2b53dc75c3..16a27f9692 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

+

Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the AI Commerce Search API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

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

Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.

@@ -103,7 +103,7 @@

Method Details

collect(parent, body=None, x__xgafv=None) -
Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
+  
Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the AI Commerce Search API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
 
 Args:
   parent: string, Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`. (required)
@@ -223,8 +223,8 @@ 

Method Details

}, "userEventInlineSource": { # The inline source for the input config for ImportUserEvents method. # Required. The Inline source for the input content for UserEvents. "userEvents": [ # Required. A list of user events to import. Recommended max of 10k items. - { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. + { # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -246,7 +246,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -414,7 +414,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -586,7 +586,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -750,8 +750,8 @@

Method Details

body: object, The request body. The object takes the form of: -{ # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. +{ # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -773,7 +773,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -941,7 +941,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1113,7 +1113,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1159,8 +1159,8 @@

Method Details

Returns: An object of the form: - { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. - "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. + { # UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website. + "attributes": { # Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. "a_key": { # A custom attribute that is not explicitly modeled in Product. "indexable": True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. "numbers": [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. @@ -1182,7 +1182,7 @@

Method Details

"entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. - "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). + "experimentIds": [ # A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). "A String", ], "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. @@ -1350,7 +1350,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). @@ -1522,7 +1522,7 @@

Method Details

], }, "retrievableFields": "A String", # Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. - "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). + "sizes": [ # The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). "A String", ], "tags": [ # Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). diff --git a/docs/dyn/workloadmanager_v1.projects.locations.deployments.html b/docs/dyn/workloadmanager_v1.projects.locations.deployments.html index 6aaa62cd61..2ac0882c2b 100644 --- a/docs/dyn/workloadmanager_v1.projects.locations.deployments.html +++ b/docs/dyn/workloadmanager_v1.projects.locations.deployments.html @@ -179,7 +179,7 @@

Method Details

"sqlServerWorkload": { # Message for MS SQL workload. # MS SQL workload input. "activeDirectory": { # Active Directory details. # Required. Active Directory details. "dnsAddress": "A String", # Optional. DNS IP address. - "domain": "A String", # Optional. Human readable form of a domain such as “google.com”. + "domain": "A String", # Optional. Human readable form of a domain such as `example.com`. "domainUsername": "A String", # Optional. Domain username. "secretManagerSecret": "A String", # Required. Secret Manager secret. "type": "A String", # Required. Active Directory type. @@ -389,7 +389,7 @@

Method Details

"sqlServerWorkload": { # Message for MS SQL workload. # MS SQL workload input. "activeDirectory": { # Active Directory details. # Required. Active Directory details. "dnsAddress": "A String", # Optional. DNS IP address. - "domain": "A String", # Optional. Human readable form of a domain such as “google.com”. + "domain": "A String", # Optional. Human readable form of a domain such as `example.com`. "domainUsername": "A String", # Optional. Domain username. "secretManagerSecret": "A String", # Required. Secret Manager secret. "type": "A String", # Required. Active Directory type. @@ -539,7 +539,7 @@

Method Details

"sqlServerWorkload": { # Message for MS SQL workload. # MS SQL workload input. "activeDirectory": { # Active Directory details. # Required. Active Directory details. "dnsAddress": "A String", # Optional. DNS IP address. - "domain": "A String", # Optional. Human readable form of a domain such as “google.com”. + "domain": "A String", # Optional. Human readable form of a domain such as `example.com`. "domainUsername": "A String", # Optional. Domain username. "secretManagerSecret": "A String", # Required. Secret Manager secret. "type": "A String", # Required. Active Directory type. diff --git a/googleapiclient/discovery_cache/documents/agentidentity.v1.json b/googleapiclient/discovery_cache/documents/agentidentity.v1.json new file mode 100644 index 0000000000..2c7588e35c --- /dev/null +++ b/googleapiclient/discovery_cache/documents/agentidentity.v1.json @@ -0,0 +1,1546 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"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." +} +} +} +}, +"basePath": "", +"baseUrl": "https://agentidentity.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Agent Identity", +"description": "", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/iam/docs/", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "agentidentity:v1", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://agentidentity.mtls.googleapis.com/", +"name": "agentidentity", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"projects": { +"resources": { +"locations": { +"methods": { +"get": { +"description": "Gets information about a location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Resource name for the location.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Location" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"flatPath": "v1/projects/{projectsId}/locations", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"extraLocationTypes": { +"description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", +"location": "query", +"repeated": true, +"type": "string" +}, +"filter": { +"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"name": { +"description": "The resource that owns the locations collection, if applicable.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The maximum number of results to return. If not set, the service selects a default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}/locations", +"response": { +"$ref": "ListLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"accessSummaries": { +"methods": { +"get": { +"description": "Gets details of a single AccessSummary.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/accessSummaries/{accessSummariesId}", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.accessSummaries.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/accessSummaries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "AccessSummary" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists AccessSummaries in a given project and location. Supported Filters: - `workload_id`: Filter by the SPIFFE ID of the agent. Example: `workload_id=\"spiffe://example.com/ns/default/sa/my-agent\"`", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/accessSummaries", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.accessSummaries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter string to restrict the results. Currently supports filtering by `workload_id` or `auth_provider_name`. If no filter is provided, returns all access summaries for the requested project and location. Format: `workload_id=\"\"` or `auth_provider_name=\"\"`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/accessSummaries", +"response": { +"$ref": "ListAccessSummariesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"authProviders": { +"methods": { +"create": { +"description": "Creates a new AuthProvider in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"authProviderId": { +"description": "Required. The ID to use for the AuthProvider, which will become the final segment of the AuthProvider's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the AuthProvider is created. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/authProviders", +"request": { +"$ref": "AuthProvider" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single AuthProvider.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}", +"httpMethod": "DELETE", +"id": "agentidentity.projects.locations.authProviders.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"disable": { +"description": "Disables a single AuthProvider.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:disable", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.disable", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:disable", +"request": { +"$ref": "DisableAuthProviderRequest" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"enable": { +"description": "Enables a single AuthProvider.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:enable", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.enable", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:enable", +"request": { +"$ref": "EnableAuthProviderRequest" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single AuthProvider.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:getIamPolicy", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.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/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists AuthProviders in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter results. This field is currently ignored.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Currently ignored. Defaults to ordering by auth_provider_id in ascending order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"showDeleted": { +"description": "Optional. Deleted auth_providers will be kept with a soft-delete for 30 days before being purged. If this field is set to true, deleted auth_providers will also be returned.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+parent}/authProviders", +"response": { +"$ref": "ListAuthProvidersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single AuthProvider.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}", +"httpMethod": "PATCH", +"id": "agentidentity.projects.locations.authProviders.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the AuthProvider resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "AuthProvider" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"query": { +"description": "Queries what all auth_providers are used by a given workload_id.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders:query", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.query", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned. A page token, received from a previous QueryAuthProviders call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryAuthProviders must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"workloadId": { +"description": "Required. The workload identifier to filter by.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/authProviders:query", +"response": { +"$ref": "QueryAuthProvidersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"queryWorkloads": { +"description": "Queries what all workloads are using a given auth_provider.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:queryWorkloads", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.queryWorkloads", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the auth_provider to query. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. When paginating, all other parameters provided to QueryWorkloads must match the call that provided the page token. If this field is omitted, the first page is returned.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:queryWorkloads", +"response": { +"$ref": "QueryWorkloadsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"revokeAuthorization": { +"description": "Revokes all authorizations for a specific user on an AuthProvider. This deletes all authorization records associated with the user and AuthProvider, effectively revoking access across all agents.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:revokeAuthorization", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.revokeAuthorization", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the AuthProvider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:revokeAuthorization", +"request": { +"$ref": "RevokeAuthorizationRequest" +}, +"response": { +"$ref": "RevokeAuthorizationResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:setIamPolicy", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.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/[^/]+/authProviders/[^/]+$", +"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 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}/authProviders/{authProvidersId}:testIamPermissions", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.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": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"undelete": { +"description": "Undeletes a single AuthProvider.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:undelete", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.undelete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:undelete", +"request": { +"$ref": "UndeleteAuthProviderRequest" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"authorizations": { +"methods": { +"delete": { +"description": "Deletes a single Authorization.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}", +"httpMethod": "DELETE", +"id": "agentidentity.projects.locations.authProviders.authorizations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Authorization to delete. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single Authorization.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.authorizations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Authorization" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Authorizations in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.authorizations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter string to restrict the results. Currently supports filtering by `client_user_id` only. Format: `client_user_id=\"\"`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. This field is currently ignored. Defaults to ordering by authorization_id in ascending order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListAuthorizations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAuthorizations` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/authorizations", +"response": { +"$ref": "ListAuthorizationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +} +}, +"revision": "20260722", +"rootUrl": "https://agentidentity.googleapis.com/", +"schemas": { +"AccessSummary": { +"description": "Message describing AccessSummary object", +"id": "AccessSummary", +"properties": { +"authProvider": { +"description": "Output only. The auth_provider that this access summary is associated with.", +"readOnly": true, +"type": "string" +}, +"authProviderType": { +"description": "Output only. The type of the connector that was used to create this access summary.", +"enum": [ +"AUTH_PROVIDER_TYPE_UNSPECIFIED", +"AUTH_PROVIDER_TYPE_THREE_LEGGED_OAUTH", +"AUTH_PROVIDER_TYPE_TWO_LEGGED_OAUTH", +"AUTH_PROVIDER_TYPE_API_KEY", +"AUTH_PROVIDER_TYPE_GEMINI_ENTERPRISE" +], +"enumDescriptions": [ +"Unspecified auth-provider type.", +"Three Legged OAuth auth-provider type.", +"Two Legged OAuth auth-provider type.", +"API Key auth-provider type.", +"Gemini Enterprise auth-provider type." +], +"readOnly": true, +"type": "string" +}, +"firstAccessTime": { +"description": "Output only. The first time this user has interacted with this workload. Rounded to the previous hour.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"lastAccessTime": { +"description": "Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Identifier. Name of the AccessSummary", +"readOnly": true, +"type": "string" +}, +"purgeTime": { +"description": "Output only. The time when this access summary is permanently deleted.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"scopes": { +"description": "Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"tokenUrl": { +"description": "Output only. The url of the authentication server that was accessed.", +"readOnly": true, +"type": "string" +}, +"userId": { +"description": "Output only. The user_id provided by the workload application for this user. Not verified by Google.", +"readOnly": true, +"type": "string" +}, +"workloadId": { +"description": "Output only. The identity bound to the workload that this user interacted with to produce this AccessSummary. Will typically be an agentic spiffe id", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ApiKeyParams": { +"description": "Message describing ApiKeyParams object.", +"id": "ApiKeyParams", +"properties": { +"apiKey": { +"description": "Optional. Input only. The API key for this auth_provider.", +"type": "string" +} +}, +"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", +"properties": { +"auditLogConfigs": { +"description": "The configuration for logging of each type of permission.", +"items": { +"$ref": "AuditLogConfig" +}, +"type": "array" +}, +"service": { +"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", +"type": "string" +} +}, +"type": "object" +}, +"AuditLogConfig": { +"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", +"id": "AuditLogConfig", +"properties": { +"exemptedMembers": { +"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", +"items": { +"type": "string" +}, +"type": "array" +}, +"logType": { +"description": "The log type that this config enables.", +"enum": [ +"LOG_TYPE_UNSPECIFIED", +"ADMIN_READ", +"DATA_WRITE", +"DATA_READ" +], +"enumDescriptions": [ +"Default case. Should never be this.", +"Admin reads. Example: CloudIAM getIamPolicy", +"Data writes. Example: CloudSQL Users create", +"Data reads. Example: CloudSQL Users list" +], +"type": "string" +} +}, +"type": "object" +}, +"AuthProvider": { +"description": "Message describing AuthProvider object", +"id": "AuthProvider", +"properties": { +"allowedScopes": { +"description": "Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.", +"items": { +"type": "string" +}, +"type": "array" +}, +"authProviderTypeParams": { +"$ref": "AuthProviderTypeParams", +"description": "Required. AuthProvider type specific parameters." +}, +"blockedScopes": { +"description": "Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.", +"items": { +"type": "string" +}, +"type": "array" +}, +"createTime": { +"description": "Output only. [Output only] Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"deleted": { +"description": "Output only. This is set to true if the auth_provider is deleted.", +"readOnly": true, +"type": "boolean" +}, +"description": { +"description": "Optional. Description of the resource. Must be less than 256 characters.", +"type": "string" +}, +"expireTime": { +"description": "Output only. The time when the auth_provider will expire.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"name": { +"description": "Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"type": "string" +}, +"state": { +"description": "Output only. The state of the auth_provider.", +"enum": [ +"STATE_UNSPECIFIED", +"ENABLED", +"DISABLED" +], +"enumDescriptions": [ +"Unspecified state.", +"Enabled and can be used.", +"Disabled and cannot be used." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. [Output only] Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"workloadIds": { +"description": "Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AuthProviderTypeParams": { +"description": "AuthProvider type specific parameters. Required when creating an auth_provider.", +"id": "AuthProviderTypeParams", +"properties": { +"apiKey": { +"$ref": "ApiKeyParams", +"description": "ApiKey AuthProvider type parameters." +}, +"geAuthProvider": { +"$ref": "GeminiEnterpriseAuthProviderParams", +"description": "GeminiEnterprise auth_provider type parameters." +}, +"threeLeggedOauth": { +"$ref": "ThreeLeggedOAuth", +"description": "ThreeLeggedOAuth AuthProvider type parameters." +}, +"twoLeggedOauth": { +"$ref": "TwoLeggedOAuth", +"description": "TwoLeggedOAuth AuthProvider type parameters." +} +}, +"type": "object" +}, +"Authorization": { +"description": "Message describing Authorization object", +"id": "Authorization", +"properties": { +"clientUserId": { +"description": "Output only. The client_user_id provided by the client application for their end user. Not verified by Google.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. [Output only] Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. name of resource", +"type": "string" +}, +"scopes": { +"description": "Output only. The scopes actually granted by the end user during the consent flow.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"state": { +"description": "Output only. The state of the authorization.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"SUSPENDED" +], +"enumDescriptions": [ +"Unspecified state.", +"Active.", +"Suspended." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. [Output only] Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Binding": { +"description": "Associates `members`, or principals, with a `role`.", +"id": "Binding", +"properties": { +"condition": { +"$ref": "Expr", +"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." +}, +"members": { +"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"role": { +"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", +"type": "string" +} +}, +"type": "object" +}, +"DisableAuthProviderRequest": { +"description": "Message for disabling an AuthProvider", +"id": "DisableAuthProviderRequest", +"properties": { +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"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", +"properties": {}, +"type": "object" +}, +"EnableAuthProviderRequest": { +"description": "Message for enabling an AuthProvider", +"id": "EnableAuthProviderRequest", +"properties": { +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +} +}, +"type": "object" +}, +"Expr": { +"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", +"id": "Expr", +"properties": { +"description": { +"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", +"type": "string" +}, +"expression": { +"description": "Textual representation of an expression in Common Expression Language syntax.", +"type": "string" +}, +"location": { +"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", +"type": "string" +}, +"title": { +"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", +"type": "string" +} +}, +"type": "object" +}, +"GeminiEnterpriseAuthProviderParams": { +"description": "Message describing GeminiEnterpriseAuthProviderParams object.", +"id": "GeminiEnterpriseAuthProviderParams", +"properties": {}, +"type": "object" +}, +"ListAccessSummariesResponse": { +"description": "Message for response to listing AccessSummaries", +"id": "ListAccessSummariesResponse", +"properties": { +"accessSummaries": { +"description": "The list of AccessSummary", +"items": { +"$ref": "AccessSummary" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListAuthProvidersResponse": { +"description": "Message for response to listing AuthProviders", +"id": "ListAuthProvidersResponse", +"properties": { +"authProviders": { +"description": "The list of AuthProvider", +"items": { +"$ref": "AuthProvider" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListAuthorizationsResponse": { +"description": "Message for response to listing Authorizations", +"id": "ListAuthorizationsResponse", +"properties": { +"authorizations": { +"description": "The list of Authorization", +"items": { +"$ref": "Authorization" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListLocationsResponse": { +"description": "The response message for Locations.ListLocations.", +"id": "ListLocationsResponse", +"properties": { +"locations": { +"description": "A list of locations that matches the specified filter in the request.", +"items": { +"$ref": "Location" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +} +}, +"type": "object" +}, +"Location": { +"description": "A resource that represents a Google Cloud location.", +"id": "Location", +"properties": { +"displayName": { +"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", +"type": "object" +}, +"locationId": { +"description": "The canonical id for this location. For example: `\"us-east1\"`.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata. For example the available capacity at the given location.", +"type": "object" +}, +"name": { +"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", +"type": "string" +} +}, +"type": "object" +}, +"Policy": { +"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", +"id": "Policy", +"properties": { +"auditConfigs": { +"description": "Specifies cloud audit logging configuration for this policy.", +"items": { +"$ref": "AuditConfig" +}, +"type": "array" +}, +"bindings": { +"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", +"items": { +"$ref": "Binding" +}, +"type": "array" +}, +"etag": { +"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", +"format": "byte", +"type": "string" +}, +"version": { +"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"QueryAuthProvidersResponse": { +"description": "Response message for QueryAuthProviders.", +"id": "QueryAuthProvidersResponse", +"properties": { +"authProviderNames": { +"description": "The unique list of auth_provider resource names used by the workload.", +"items": { +"type": "string" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"QueryWorkloadsResponse": { +"description": "Response message for QueryWorkloads.", +"id": "QueryWorkloadsResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve the next page of results.", +"type": "string" +}, +"workloadIds": { +"description": "The unique list of workload identifiers (agents) that used the auth_provider.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"RevokeAuthorizationRequest": { +"description": "Request message for RevokeAuthorization.", +"id": "RevokeAuthorizationRequest", +"properties": { +"userId": { +"description": "Required. The identity of the user to revoke authorization for.", +"type": "string" +} +}, +"type": "object" +}, +"RevokeAuthorizationResponse": { +"description": "Response message for RevokeAuthorization.", +"id": "RevokeAuthorizationResponse", +"properties": {}, +"type": "object" +}, +"SetIamPolicyRequest": { +"description": "Request message for `SetIamPolicy` method.", +"id": "SetIamPolicyRequest", +"properties": { +"policy": { +"$ref": "Policy", +"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." +}, +"updateMask": { +"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, +"TestIamPermissionsRequest": { +"description": "Request message for `TestIamPermissions` method.", +"id": "TestIamPermissionsRequest", +"properties": { +"permissions": { +"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"TestIamPermissionsResponse": { +"description": "Response message for `TestIamPermissions` method.", +"id": "TestIamPermissionsResponse", +"properties": { +"permissions": { +"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ThreeLeggedOAuth": { +"description": "Message describing ThreeLeggedOAuth object.", +"id": "ThreeLeggedOAuth", +"properties": { +"authorizationUrl": { +"description": "Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. \"https://auth.atlassian.com/authorize\"", +"type": "string" +}, +"clientId": { +"description": "Optional. The client ID of the OAuth client.", +"type": "string" +}, +"clientSecret": { +"description": "Optional. Input only. The client secret of the OAuth client.", +"type": "string" +}, +"defaultContinueUri": { +"description": "Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.", +"type": "string" +}, +"enablePkce": { +"description": "Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.", +"type": "boolean" +}, +"redirectUrl": { +"description": "Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.", +"readOnly": true, +"type": "string" +}, +"tokenUrl": { +"description": "Optional. The token endpoint for requesting tokens on behalf of an end user. eg. \"https://auth.atlassian.com/oauth/token\"", +"type": "string" +} +}, +"type": "object" +}, +"TwoLeggedOAuth": { +"description": "Message describing TwoLeggedOAuth object.", +"id": "TwoLeggedOAuth", +"properties": { +"clientId": { +"description": "Optional. The client ID of the OAuth client.", +"type": "string" +}, +"clientSecret": { +"description": "Optional. Input only. The client secret of the OAuth client.", +"type": "string" +}, +"tokenUrl": { +"description": "Optional. The token endpoint of the OAuth client.", +"type": "string" +} +}, +"type": "object" +}, +"UndeleteAuthProviderRequest": { +"description": "Message for undeleting a AuthProvider", +"id": "UndeleteAuthProviderRequest", +"properties": { +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Agent Identity API", +"version": "v1", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/agentidentity.v1alpha.json b/googleapiclient/discovery_cache/documents/agentidentity.v1alpha.json new file mode 100644 index 0000000000..7259a258c3 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/agentidentity.v1alpha.json @@ -0,0 +1,1546 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"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." +} +} +} +}, +"basePath": "", +"baseUrl": "https://agentidentity.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Agent Identity", +"description": "", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/iam/docs/", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "agentidentity:v1alpha", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://agentidentity.mtls.googleapis.com/", +"name": "agentidentity", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"projects": { +"resources": { +"locations": { +"methods": { +"get": { +"description": "Gets information about a location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Resource name for the location.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Location" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"flatPath": "v1alpha/projects/{projectsId}/locations", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"extraLocationTypes": { +"description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", +"location": "query", +"repeated": true, +"type": "string" +}, +"filter": { +"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"name": { +"description": "The resource that owns the locations collection, if applicable.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The maximum number of results to return. If not set, the service selects a default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}/locations", +"response": { +"$ref": "ListLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"accessSummaries": { +"methods": { +"get": { +"description": "Gets details of a single AccessSummary.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/accessSummaries/{accessSummariesId}", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.accessSummaries.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/accessSummaries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "AccessSummary" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists AccessSummaries in a given project and location. Supported Filters: - `workload_id`: Filter by the SPIFFE ID of the agent. Example: `workload_id=\"spiffe://example.com/ns/default/sa/my-agent\"`", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/accessSummaries", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.accessSummaries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter string to restrict the results. Currently supports filtering by `workload_id` or `auth_provider_name`. If no filter is provided, returns all access summaries for the requested project and location. Format: `workload_id=\"\"` or `auth_provider_name=\"\"`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/accessSummaries", +"response": { +"$ref": "ListAccessSummariesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"authProviders": { +"methods": { +"create": { +"description": "Creates a new AuthProvider in a given project and location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"authProviderId": { +"description": "Required. The ID to use for the AuthProvider, which will become the final segment of the AuthProvider's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the AuthProvider is created. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+parent}/authProviders", +"request": { +"$ref": "AuthProvider" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single AuthProvider.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}", +"httpMethod": "DELETE", +"id": "agentidentity.projects.locations.authProviders.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"disable": { +"description": "Disables a single AuthProvider.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:disable", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.disable", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:disable", +"request": { +"$ref": "DisableAuthProviderRequest" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"enable": { +"description": "Enables a single AuthProvider.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:enable", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.enable", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:enable", +"request": { +"$ref": "EnableAuthProviderRequest" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single AuthProvider.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:getIamPolicy", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.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/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists AuthProviders in a given project and location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter results. This field is currently ignored.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Currently ignored. Defaults to ordering by auth_provider_id in ascending order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"showDeleted": { +"description": "Optional. Deleted auth_providers will be kept with a soft-delete for 30 days before being purged. If this field is set to true, deleted auth_providers will also be returned.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+parent}/authProviders", +"response": { +"$ref": "ListAuthProvidersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single AuthProvider.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}", +"httpMethod": "PATCH", +"id": "agentidentity.projects.locations.authProviders.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the AuthProvider resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "AuthProvider" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"query": { +"description": "Queries what all auth_providers are used by a given workload_id.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders:query", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.query", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned. A page token, received from a previous QueryAuthProviders call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryAuthProviders must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"workloadId": { +"description": "Required. The workload identifier to filter by.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+parent}/authProviders:query", +"response": { +"$ref": "QueryAuthProvidersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"queryWorkloads": { +"description": "Queries what all workloads are using a given auth_provider.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:queryWorkloads", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.queryWorkloads", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the auth_provider to query. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. When paginating, all other parameters provided to QueryWorkloads must match the call that provided the page token. If this field is omitted, the first page is returned.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}:queryWorkloads", +"response": { +"$ref": "QueryWorkloadsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"revokeAuthorization": { +"description": "Revokes all authorizations for a specific user on an AuthProvider. This deletes all authorization records associated with the user and AuthProvider, effectively revoking access across all agents.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:revokeAuthorization", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.revokeAuthorization", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the AuthProvider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:revokeAuthorization", +"request": { +"$ref": "RevokeAuthorizationRequest" +}, +"response": { +"$ref": "RevokeAuthorizationResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:setIamPolicy", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.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/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"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": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:testIamPermissions", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.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": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"undelete": { +"description": "Undeletes a single AuthProvider.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:undelete", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.undelete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:undelete", +"request": { +"$ref": "UndeleteAuthProviderRequest" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"authorizations": { +"methods": { +"delete": { +"description": "Deletes a single Authorization.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}", +"httpMethod": "DELETE", +"id": "agentidentity.projects.locations.authProviders.authorizations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Authorization to delete. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single Authorization.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.authorizations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Authorization" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Authorizations in a given project and location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.authorizations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter string to restrict the results. Currently supports filtering by `client_user_id` only. Format: `client_user_id=\"\"`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. This field is currently ignored. Defaults to ordering by authorization_id in ascending order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListAuthorizations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAuthorizations` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/authorizations", +"response": { +"$ref": "ListAuthorizationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +} +}, +"revision": "20260722", +"rootUrl": "https://agentidentity.googleapis.com/", +"schemas": { +"AccessSummary": { +"description": "Message describing AccessSummary object", +"id": "AccessSummary", +"properties": { +"authProvider": { +"description": "Output only. The auth_provider that this access summary is associated with.", +"readOnly": true, +"type": "string" +}, +"authProviderType": { +"description": "Output only. The type of the connector that was used to create this access summary.", +"enum": [ +"AUTH_PROVIDER_TYPE_UNSPECIFIED", +"AUTH_PROVIDER_TYPE_THREE_LEGGED_OAUTH", +"AUTH_PROVIDER_TYPE_TWO_LEGGED_OAUTH", +"AUTH_PROVIDER_TYPE_API_KEY", +"AUTH_PROVIDER_TYPE_GEMINI_ENTERPRISE" +], +"enumDescriptions": [ +"Unspecified auth-provider type.", +"Three Legged OAuth auth-provider type.", +"Two Legged OAuth auth-provider type.", +"API Key auth-provider type.", +"Gemini Enterprise auth-provider type." +], +"readOnly": true, +"type": "string" +}, +"firstAccessTime": { +"description": "Output only. The first time this user has interacted with this workload. Rounded to the previous hour.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"lastAccessTime": { +"description": "Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Identifier. Name of the AccessSummary", +"readOnly": true, +"type": "string" +}, +"purgeTime": { +"description": "Output only. The time when this access summary is permanently deleted.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"scopes": { +"description": "Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"tokenUrl": { +"description": "Output only. The url of the authentication server that was accessed.", +"readOnly": true, +"type": "string" +}, +"userId": { +"description": "Output only. The user_id provided by the workload application for this user. Not verified by Google.", +"readOnly": true, +"type": "string" +}, +"workloadId": { +"description": "Output only. The identity bound to the workload that this user interacted with to produce this AccessSummary. Will typically be an agentic spiffe id", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ApiKeyParams": { +"description": "Message describing ApiKeyParams object.", +"id": "ApiKeyParams", +"properties": { +"apiKey": { +"description": "Optional. Input only. The API key for this auth_provider.", +"type": "string" +} +}, +"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", +"properties": { +"auditLogConfigs": { +"description": "The configuration for logging of each type of permission.", +"items": { +"$ref": "AuditLogConfig" +}, +"type": "array" +}, +"service": { +"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", +"type": "string" +} +}, +"type": "object" +}, +"AuditLogConfig": { +"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", +"id": "AuditLogConfig", +"properties": { +"exemptedMembers": { +"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", +"items": { +"type": "string" +}, +"type": "array" +}, +"logType": { +"description": "The log type that this config enables.", +"enum": [ +"LOG_TYPE_UNSPECIFIED", +"ADMIN_READ", +"DATA_WRITE", +"DATA_READ" +], +"enumDescriptions": [ +"Default case. Should never be this.", +"Admin reads. Example: CloudIAM getIamPolicy", +"Data writes. Example: CloudSQL Users create", +"Data reads. Example: CloudSQL Users list" +], +"type": "string" +} +}, +"type": "object" +}, +"AuthProvider": { +"description": "Message describing AuthProvider object", +"id": "AuthProvider", +"properties": { +"allowedScopes": { +"description": "Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.", +"items": { +"type": "string" +}, +"type": "array" +}, +"authProviderTypeParams": { +"$ref": "AuthProviderTypeParams", +"description": "Required. AuthProvider type specific parameters." +}, +"blockedScopes": { +"description": "Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.", +"items": { +"type": "string" +}, +"type": "array" +}, +"createTime": { +"description": "Output only. [Output only] Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"deleted": { +"description": "Output only. This is set to true if the auth_provider is deleted.", +"readOnly": true, +"type": "boolean" +}, +"description": { +"description": "Optional. Description of the resource. Must be less than 256 characters.", +"type": "string" +}, +"expireTime": { +"description": "Output only. The time when the auth_provider will expire.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"name": { +"description": "Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"type": "string" +}, +"state": { +"description": "Output only. The state of the auth_provider.", +"enum": [ +"STATE_UNSPECIFIED", +"ENABLED", +"DISABLED" +], +"enumDescriptions": [ +"Unspecified state.", +"Enabled and can be used.", +"Disabled and cannot be used." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. [Output only] Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"workloadIds": { +"description": "Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AuthProviderTypeParams": { +"description": "AuthProvider type specific parameters. Required when creating an auth_provider.", +"id": "AuthProviderTypeParams", +"properties": { +"apiKey": { +"$ref": "ApiKeyParams", +"description": "ApiKey AuthProvider type parameters." +}, +"geAuthProvider": { +"$ref": "GeminiEnterpriseAuthProviderParams", +"description": "GeminiEnterprise auth_provider type parameters." +}, +"threeLeggedOauth": { +"$ref": "ThreeLeggedOAuth", +"description": "ThreeLeggedOAuth AuthProvider type parameters." +}, +"twoLeggedOauth": { +"$ref": "TwoLeggedOAuth", +"description": "TwoLeggedOAuth AuthProvider type parameters." +} +}, +"type": "object" +}, +"Authorization": { +"description": "Message describing Authorization object", +"id": "Authorization", +"properties": { +"clientUserId": { +"description": "Output only. The client_user_id provided by the client application for their end user. Not verified by Google.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. [Output only] Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. name of resource", +"type": "string" +}, +"scopes": { +"description": "Output only. The scopes actually granted by the end user during the consent flow.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"state": { +"description": "Output only. The state of the authorization.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"SUSPENDED" +], +"enumDescriptions": [ +"Unspecified state.", +"Active.", +"Suspended." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. [Output only] Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Binding": { +"description": "Associates `members`, or principals, with a `role`.", +"id": "Binding", +"properties": { +"condition": { +"$ref": "Expr", +"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." +}, +"members": { +"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"role": { +"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", +"type": "string" +} +}, +"type": "object" +}, +"DisableAuthProviderRequest": { +"description": "Message for disabling an AuthProvider", +"id": "DisableAuthProviderRequest", +"properties": { +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"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", +"properties": {}, +"type": "object" +}, +"EnableAuthProviderRequest": { +"description": "Message for enabling an AuthProvider", +"id": "EnableAuthProviderRequest", +"properties": { +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +} +}, +"type": "object" +}, +"Expr": { +"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", +"id": "Expr", +"properties": { +"description": { +"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", +"type": "string" +}, +"expression": { +"description": "Textual representation of an expression in Common Expression Language syntax.", +"type": "string" +}, +"location": { +"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", +"type": "string" +}, +"title": { +"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", +"type": "string" +} +}, +"type": "object" +}, +"GeminiEnterpriseAuthProviderParams": { +"description": "Message describing GeminiEnterpriseAuthProviderParams object.", +"id": "GeminiEnterpriseAuthProviderParams", +"properties": {}, +"type": "object" +}, +"ListAccessSummariesResponse": { +"description": "Message for response to listing AccessSummaries", +"id": "ListAccessSummariesResponse", +"properties": { +"accessSummaries": { +"description": "The list of AccessSummary", +"items": { +"$ref": "AccessSummary" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListAuthProvidersResponse": { +"description": "Message for response to listing AuthProviders", +"id": "ListAuthProvidersResponse", +"properties": { +"authProviders": { +"description": "The list of AuthProvider", +"items": { +"$ref": "AuthProvider" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListAuthorizationsResponse": { +"description": "Message for response to listing Authorizations", +"id": "ListAuthorizationsResponse", +"properties": { +"authorizations": { +"description": "The list of Authorization", +"items": { +"$ref": "Authorization" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListLocationsResponse": { +"description": "The response message for Locations.ListLocations.", +"id": "ListLocationsResponse", +"properties": { +"locations": { +"description": "A list of locations that matches the specified filter in the request.", +"items": { +"$ref": "Location" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +} +}, +"type": "object" +}, +"Location": { +"description": "A resource that represents a Google Cloud location.", +"id": "Location", +"properties": { +"displayName": { +"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", +"type": "object" +}, +"locationId": { +"description": "The canonical id for this location. For example: `\"us-east1\"`.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata. For example the available capacity at the given location.", +"type": "object" +}, +"name": { +"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", +"type": "string" +} +}, +"type": "object" +}, +"Policy": { +"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", +"id": "Policy", +"properties": { +"auditConfigs": { +"description": "Specifies cloud audit logging configuration for this policy.", +"items": { +"$ref": "AuditConfig" +}, +"type": "array" +}, +"bindings": { +"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", +"items": { +"$ref": "Binding" +}, +"type": "array" +}, +"etag": { +"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", +"format": "byte", +"type": "string" +}, +"version": { +"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"QueryAuthProvidersResponse": { +"description": "Response message for QueryAuthProviders.", +"id": "QueryAuthProvidersResponse", +"properties": { +"authProviderNames": { +"description": "The unique list of auth_provider resource names used by the workload.", +"items": { +"type": "string" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"QueryWorkloadsResponse": { +"description": "Response message for QueryWorkloads.", +"id": "QueryWorkloadsResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve the next page of results.", +"type": "string" +}, +"workloadIds": { +"description": "The unique list of workload identifiers (agents) that used the auth_provider.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"RevokeAuthorizationRequest": { +"description": "Request message for RevokeAuthorization.", +"id": "RevokeAuthorizationRequest", +"properties": { +"userId": { +"description": "Required. The identity of the user to revoke authorization for.", +"type": "string" +} +}, +"type": "object" +}, +"RevokeAuthorizationResponse": { +"description": "Response message for RevokeAuthorization.", +"id": "RevokeAuthorizationResponse", +"properties": {}, +"type": "object" +}, +"SetIamPolicyRequest": { +"description": "Request message for `SetIamPolicy` method.", +"id": "SetIamPolicyRequest", +"properties": { +"policy": { +"$ref": "Policy", +"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." +}, +"updateMask": { +"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, +"TestIamPermissionsRequest": { +"description": "Request message for `TestIamPermissions` method.", +"id": "TestIamPermissionsRequest", +"properties": { +"permissions": { +"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"TestIamPermissionsResponse": { +"description": "Response message for `TestIamPermissions` method.", +"id": "TestIamPermissionsResponse", +"properties": { +"permissions": { +"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ThreeLeggedOAuth": { +"description": "Message describing ThreeLeggedOAuth object.", +"id": "ThreeLeggedOAuth", +"properties": { +"authorizationUrl": { +"description": "Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. \"https://auth.atlassian.com/authorize\"", +"type": "string" +}, +"clientId": { +"description": "Optional. The client ID of the OAuth client.", +"type": "string" +}, +"clientSecret": { +"description": "Optional. Input only. The client secret of the OAuth client.", +"type": "string" +}, +"defaultContinueUri": { +"description": "Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.", +"type": "string" +}, +"enablePkce": { +"description": "Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.", +"type": "boolean" +}, +"redirectUrl": { +"description": "Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.", +"readOnly": true, +"type": "string" +}, +"tokenUrl": { +"description": "Optional. The token endpoint for requesting tokens on behalf of an end user. eg. \"https://auth.atlassian.com/oauth/token\"", +"type": "string" +} +}, +"type": "object" +}, +"TwoLeggedOAuth": { +"description": "Message describing TwoLeggedOAuth object.", +"id": "TwoLeggedOAuth", +"properties": { +"clientId": { +"description": "Optional. The client ID of the OAuth client.", +"type": "string" +}, +"clientSecret": { +"description": "Optional. Input only. The client secret of the OAuth client.", +"type": "string" +}, +"tokenUrl": { +"description": "Optional. The token endpoint of the OAuth client.", +"type": "string" +} +}, +"type": "object" +}, +"UndeleteAuthProviderRequest": { +"description": "Message for undeleting a AuthProvider", +"id": "UndeleteAuthProviderRequest", +"properties": { +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Agent Identity API", +"version": "v1alpha", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/agentidentity.v1beta.json b/googleapiclient/discovery_cache/documents/agentidentity.v1beta.json new file mode 100644 index 0000000000..3927b2582e --- /dev/null +++ b/googleapiclient/discovery_cache/documents/agentidentity.v1beta.json @@ -0,0 +1,1546 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"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." +} +} +} +}, +"basePath": "", +"baseUrl": "https://agentidentity.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Agent Identity", +"description": "", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/iam/docs/", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "agentidentity:v1beta", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://agentidentity.mtls.googleapis.com/", +"name": "agentidentity", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"projects": { +"resources": { +"locations": { +"methods": { +"get": { +"description": "Gets information about a location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Resource name for the location.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "Location" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"flatPath": "v1beta/projects/{projectsId}/locations", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"extraLocationTypes": { +"description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", +"location": "query", +"repeated": true, +"type": "string" +}, +"filter": { +"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"name": { +"description": "The resource that owns the locations collection, if applicable.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The maximum number of results to return. If not set, the service selects a default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}/locations", +"response": { +"$ref": "ListLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"accessSummaries": { +"methods": { +"get": { +"description": "Gets details of a single AccessSummary.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/accessSummaries/{accessSummariesId}", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.accessSummaries.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/accessSummaries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "AccessSummary" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists AccessSummaries in a given project and location. Supported Filters: - `workload_id`: Filter by the SPIFFE ID of the agent. Example: `workload_id=\"spiffe://example.com/ns/default/sa/my-agent\"`", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/accessSummaries", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.accessSummaries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter string to restrict the results. Currently supports filtering by `workload_id` or `auth_provider_name`. If no filter is provided, returns all access summaries for the requested project and location. Format: `workload_id=\"\"` or `auth_provider_name=\"\"`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/accessSummaries", +"response": { +"$ref": "ListAccessSummariesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"authProviders": { +"methods": { +"create": { +"description": "Creates a new AuthProvider in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"authProviderId": { +"description": "Required. The ID to use for the AuthProvider, which will become the final segment of the AuthProvider's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the AuthProvider is created. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/authProviders", +"request": { +"$ref": "AuthProvider" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single AuthProvider.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}", +"httpMethod": "DELETE", +"id": "agentidentity.projects.locations.authProviders.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"disable": { +"description": "Disables a single AuthProvider.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:disable", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.disable", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:disable", +"request": { +"$ref": "DisableAuthProviderRequest" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"enable": { +"description": "Enables a single AuthProvider.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:enable", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.enable", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:enable", +"request": { +"$ref": "EnableAuthProviderRequest" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single AuthProvider.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:getIamPolicy", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.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/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists AuthProviders in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter results. This field is currently ignored.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Currently ignored. Defaults to ordering by auth_provider_id in ascending order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"showDeleted": { +"description": "Optional. Deleted auth_providers will be kept with a soft-delete for 30 days before being purged. If this field is set to true, deleted auth_providers will also be returned.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta/{+parent}/authProviders", +"response": { +"$ref": "ListAuthProvidersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single AuthProvider.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}", +"httpMethod": "PATCH", +"id": "agentidentity.projects.locations.authProviders.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the AuthProvider resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "AuthProvider" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"query": { +"description": "Queries what all auth_providers are used by a given workload_id.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders:query", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.query", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned. A page token, received from a previous QueryAuthProviders call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryAuthProviders must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"workloadId": { +"description": "Required. The workload identifier to filter by.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/authProviders:query", +"response": { +"$ref": "QueryAuthProvidersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"queryWorkloads": { +"description": "Queries what all workloads are using a given auth_provider.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:queryWorkloads", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.queryWorkloads", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the auth_provider to query. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. When paginating, all other parameters provided to QueryWorkloads must match the call that provided the page token. If this field is omitted, the first page is returned.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}:queryWorkloads", +"response": { +"$ref": "QueryWorkloadsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"revokeAuthorization": { +"description": "Revokes all authorizations for a specific user on an AuthProvider. This deletes all authorization records associated with the user and AuthProvider, effectively revoking access across all agents.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:revokeAuthorization", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.revokeAuthorization", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the AuthProvider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:revokeAuthorization", +"request": { +"$ref": "RevokeAuthorizationRequest" +}, +"response": { +"$ref": "RevokeAuthorizationResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:setIamPolicy", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.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/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"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": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:testIamPermissions", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.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": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"undelete": { +"description": "Undeletes a single AuthProvider.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:undelete", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.undelete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:undelete", +"request": { +"$ref": "UndeleteAuthProviderRequest" +}, +"response": { +"$ref": "AuthProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"authorizations": { +"methods": { +"delete": { +"description": "Deletes a single Authorization.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}", +"httpMethod": "DELETE", +"id": "agentidentity.projects.locations.authProviders.authorizations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Authorization to delete. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single Authorization.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.authorizations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "Authorization" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Authorizations in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.authorizations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter string to restrict the results. Currently supports filtering by `client_user_id` only. Format: `client_user_id=\"\"`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. This field is currently ignored. Defaults to ordering by authorization_id in ascending order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListAuthorizations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAuthorizations` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/authorizations", +"response": { +"$ref": "ListAuthorizationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +} +}, +"revision": "20260722", +"rootUrl": "https://agentidentity.googleapis.com/", +"schemas": { +"AccessSummary": { +"description": "Message describing AccessSummary object", +"id": "AccessSummary", +"properties": { +"authProvider": { +"description": "Output only. The auth_provider that this access summary is associated with.", +"readOnly": true, +"type": "string" +}, +"authProviderType": { +"description": "Output only. The type of the connector that was used to create this access summary.", +"enum": [ +"AUTH_PROVIDER_TYPE_UNSPECIFIED", +"AUTH_PROVIDER_TYPE_THREE_LEGGED_OAUTH", +"AUTH_PROVIDER_TYPE_TWO_LEGGED_OAUTH", +"AUTH_PROVIDER_TYPE_API_KEY", +"AUTH_PROVIDER_TYPE_GEMINI_ENTERPRISE" +], +"enumDescriptions": [ +"Unspecified auth-provider type.", +"Three Legged OAuth auth-provider type.", +"Two Legged OAuth auth-provider type.", +"API Key auth-provider type.", +"Gemini Enterprise auth-provider type." +], +"readOnly": true, +"type": "string" +}, +"firstAccessTime": { +"description": "Output only. The first time this user has interacted with this workload. Rounded to the previous hour.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"lastAccessTime": { +"description": "Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Identifier. Name of the AccessSummary", +"readOnly": true, +"type": "string" +}, +"purgeTime": { +"description": "Output only. The time when this access summary is permanently deleted.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"scopes": { +"description": "Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"tokenUrl": { +"description": "Output only. The url of the authentication server that was accessed.", +"readOnly": true, +"type": "string" +}, +"userId": { +"description": "Output only. The user_id provided by the workload application for this user. Not verified by Google.", +"readOnly": true, +"type": "string" +}, +"workloadId": { +"description": "Output only. The identity bound to the workload that this user interacted with to produce this AccessSummary. Will typically be an agentic spiffe id", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ApiKeyParams": { +"description": "Message describing ApiKeyParams object.", +"id": "ApiKeyParams", +"properties": { +"apiKey": { +"description": "Optional. Input only. The API key for this auth_provider.", +"type": "string" +} +}, +"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", +"properties": { +"auditLogConfigs": { +"description": "The configuration for logging of each type of permission.", +"items": { +"$ref": "AuditLogConfig" +}, +"type": "array" +}, +"service": { +"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", +"type": "string" +} +}, +"type": "object" +}, +"AuditLogConfig": { +"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", +"id": "AuditLogConfig", +"properties": { +"exemptedMembers": { +"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", +"items": { +"type": "string" +}, +"type": "array" +}, +"logType": { +"description": "The log type that this config enables.", +"enum": [ +"LOG_TYPE_UNSPECIFIED", +"ADMIN_READ", +"DATA_WRITE", +"DATA_READ" +], +"enumDescriptions": [ +"Default case. Should never be this.", +"Admin reads. Example: CloudIAM getIamPolicy", +"Data writes. Example: CloudSQL Users create", +"Data reads. Example: CloudSQL Users list" +], +"type": "string" +} +}, +"type": "object" +}, +"AuthProvider": { +"description": "Message describing AuthProvider object", +"id": "AuthProvider", +"properties": { +"allowedScopes": { +"description": "Optional. List of scopes that are allowed to be requested for this auth_provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.", +"items": { +"type": "string" +}, +"type": "array" +}, +"authProviderTypeParams": { +"$ref": "AuthProviderTypeParams", +"description": "Required. AuthProvider type specific parameters." +}, +"blockedScopes": { +"description": "Optional. List of scopes that are blocked from being requested for this auth_provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.", +"items": { +"type": "string" +}, +"type": "array" +}, +"createTime": { +"description": "Output only. [Output only] Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"deleted": { +"description": "Output only. This is set to true if the auth_provider is deleted.", +"readOnly": true, +"type": "boolean" +}, +"description": { +"description": "Optional. Description of the resource. Must be less than 256 characters.", +"type": "string" +}, +"expireTime": { +"description": "Output only. The time when the auth_provider will expire.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"name": { +"description": "Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"type": "string" +}, +"state": { +"description": "Output only. The state of the auth_provider.", +"enum": [ +"STATE_UNSPECIFIED", +"ENABLED", +"DISABLED" +], +"enumDescriptions": [ +"Unspecified state.", +"Enabled and can be used.", +"Disabled and cannot be used." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. [Output only] Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"workloadIds": { +"description": "Optional. Input only. Represents the workload identity in IAM `principal://` format of the agent(s) that will use this AuthProvider. Example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AuthProviderTypeParams": { +"description": "AuthProvider type specific parameters. Required when creating an auth_provider.", +"id": "AuthProviderTypeParams", +"properties": { +"apiKey": { +"$ref": "ApiKeyParams", +"description": "ApiKey AuthProvider type parameters." +}, +"geAuthProvider": { +"$ref": "GeminiEnterpriseAuthProviderParams", +"description": "GeminiEnterprise auth_provider type parameters." +}, +"threeLeggedOauth": { +"$ref": "ThreeLeggedOAuth", +"description": "ThreeLeggedOAuth AuthProvider type parameters." +}, +"twoLeggedOauth": { +"$ref": "TwoLeggedOAuth", +"description": "TwoLeggedOAuth AuthProvider type parameters." +} +}, +"type": "object" +}, +"Authorization": { +"description": "Message describing Authorization object", +"id": "Authorization", +"properties": { +"clientUserId": { +"description": "Output only. The client_user_id provided by the client application for their end user. Not verified by Google.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. [Output only] Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. name of resource", +"type": "string" +}, +"scopes": { +"description": "Output only. The scopes actually granted by the end user during the consent flow.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"state": { +"description": "Output only. The state of the authorization.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"SUSPENDED" +], +"enumDescriptions": [ +"Unspecified state.", +"Active.", +"Suspended." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. [Output only] Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Binding": { +"description": "Associates `members`, or principals, with a `role`.", +"id": "Binding", +"properties": { +"condition": { +"$ref": "Expr", +"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." +}, +"members": { +"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"role": { +"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", +"type": "string" +} +}, +"type": "object" +}, +"DisableAuthProviderRequest": { +"description": "Message for disabling an AuthProvider", +"id": "DisableAuthProviderRequest", +"properties": { +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"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", +"properties": {}, +"type": "object" +}, +"EnableAuthProviderRequest": { +"description": "Message for enabling an AuthProvider", +"id": "EnableAuthProviderRequest", +"properties": { +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +} +}, +"type": "object" +}, +"Expr": { +"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", +"id": "Expr", +"properties": { +"description": { +"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", +"type": "string" +}, +"expression": { +"description": "Textual representation of an expression in Common Expression Language syntax.", +"type": "string" +}, +"location": { +"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", +"type": "string" +}, +"title": { +"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", +"type": "string" +} +}, +"type": "object" +}, +"GeminiEnterpriseAuthProviderParams": { +"description": "Message describing GeminiEnterpriseAuthProviderParams object.", +"id": "GeminiEnterpriseAuthProviderParams", +"properties": {}, +"type": "object" +}, +"ListAccessSummariesResponse": { +"description": "Message for response to listing AccessSummaries", +"id": "ListAccessSummariesResponse", +"properties": { +"accessSummaries": { +"description": "The list of AccessSummary", +"items": { +"$ref": "AccessSummary" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListAuthProvidersResponse": { +"description": "Message for response to listing AuthProviders", +"id": "ListAuthProvidersResponse", +"properties": { +"authProviders": { +"description": "The list of AuthProvider", +"items": { +"$ref": "AuthProvider" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListAuthorizationsResponse": { +"description": "Message for response to listing Authorizations", +"id": "ListAuthorizationsResponse", +"properties": { +"authorizations": { +"description": "The list of Authorization", +"items": { +"$ref": "Authorization" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListLocationsResponse": { +"description": "The response message for Locations.ListLocations.", +"id": "ListLocationsResponse", +"properties": { +"locations": { +"description": "A list of locations that matches the specified filter in the request.", +"items": { +"$ref": "Location" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +} +}, +"type": "object" +}, +"Location": { +"description": "A resource that represents a Google Cloud location.", +"id": "Location", +"properties": { +"displayName": { +"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", +"type": "object" +}, +"locationId": { +"description": "The canonical id for this location. For example: `\"us-east1\"`.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata. For example the available capacity at the given location.", +"type": "object" +}, +"name": { +"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", +"type": "string" +} +}, +"type": "object" +}, +"Policy": { +"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", +"id": "Policy", +"properties": { +"auditConfigs": { +"description": "Specifies cloud audit logging configuration for this policy.", +"items": { +"$ref": "AuditConfig" +}, +"type": "array" +}, +"bindings": { +"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", +"items": { +"$ref": "Binding" +}, +"type": "array" +}, +"etag": { +"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", +"format": "byte", +"type": "string" +}, +"version": { +"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"QueryAuthProvidersResponse": { +"description": "Response message for QueryAuthProviders.", +"id": "QueryAuthProvidersResponse", +"properties": { +"authProviderNames": { +"description": "The unique list of auth_provider resource names used by the workload.", +"items": { +"type": "string" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"QueryWorkloadsResponse": { +"description": "Response message for QueryWorkloads.", +"id": "QueryWorkloadsResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve the next page of results.", +"type": "string" +}, +"workloadIds": { +"description": "The unique list of workload identifiers (agents) that used the auth_provider.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"RevokeAuthorizationRequest": { +"description": "Request message for RevokeAuthorization.", +"id": "RevokeAuthorizationRequest", +"properties": { +"userId": { +"description": "Required. The identity of the user to revoke authorization for.", +"type": "string" +} +}, +"type": "object" +}, +"RevokeAuthorizationResponse": { +"description": "Response message for RevokeAuthorization.", +"id": "RevokeAuthorizationResponse", +"properties": {}, +"type": "object" +}, +"SetIamPolicyRequest": { +"description": "Request message for `SetIamPolicy` method.", +"id": "SetIamPolicyRequest", +"properties": { +"policy": { +"$ref": "Policy", +"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." +}, +"updateMask": { +"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, +"TestIamPermissionsRequest": { +"description": "Request message for `TestIamPermissions` method.", +"id": "TestIamPermissionsRequest", +"properties": { +"permissions": { +"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"TestIamPermissionsResponse": { +"description": "Response message for `TestIamPermissions` method.", +"id": "TestIamPermissionsResponse", +"properties": { +"permissions": { +"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ThreeLeggedOAuth": { +"description": "Message describing ThreeLeggedOAuth object.", +"id": "ThreeLeggedOAuth", +"properties": { +"authorizationUrl": { +"description": "Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. \"https://auth.atlassian.com/authorize\"", +"type": "string" +}, +"clientId": { +"description": "Optional. The client ID of the OAuth client.", +"type": "string" +}, +"clientSecret": { +"description": "Optional. Input only. The client secret of the OAuth client.", +"type": "string" +}, +"defaultContinueUri": { +"description": "Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.", +"type": "string" +}, +"enablePkce": { +"description": "Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.", +"type": "boolean" +}, +"redirectUrl": { +"description": "Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.", +"readOnly": true, +"type": "string" +}, +"tokenUrl": { +"description": "Optional. The token endpoint for requesting tokens on behalf of an end user. eg. \"https://auth.atlassian.com/oauth/token\"", +"type": "string" +} +}, +"type": "object" +}, +"TwoLeggedOAuth": { +"description": "Message describing TwoLeggedOAuth object.", +"id": "TwoLeggedOAuth", +"properties": { +"clientId": { +"description": "Optional. The client ID of the OAuth client.", +"type": "string" +}, +"clientSecret": { +"description": "Optional. Input only. The client secret of the OAuth client.", +"type": "string" +}, +"tokenUrl": { +"description": "Optional. The token endpoint of the OAuth client.", +"type": "string" +} +}, +"type": "object" +}, +"UndeleteAuthProviderRequest": { +"description": "Message for undeleting a AuthProvider", +"id": "UndeleteAuthProviderRequest", +"properties": { +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Agent Identity API", +"version": "v1beta", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/agentidentitycredentials.v1.json b/googleapiclient/discovery_cache/documents/agentidentitycredentials.v1.json new file mode 100644 index 0000000000..9cf35c8a7c --- /dev/null +++ b/googleapiclient/discovery_cache/documents/agentidentitycredentials.v1.json @@ -0,0 +1,325 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"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." +} +} +} +}, +"basePath": "", +"baseUrl": "https://agentidentitycredentials.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Agent Identity Credentials", +"description": "agentidentitycredentials.googleapis.com API.", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/iam/docs/", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "agentidentitycredentials:v1", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://agentidentitycredentials.mtls.googleapis.com/", +"name": "agentidentitycredentials", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"projects": { +"resources": { +"locations": { +"resources": { +"authProviders": { +"resources": { +"credentials": { +"methods": { +"finalize": { +"description": "Finalizes the credentials after a successful consent flow.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/credentials:finalize", +"httpMethod": "POST", +"id": "agentidentitycredentials.projects.locations.authProviders.credentials.finalize", +"parameterOrder": [ +"authProvider" +], +"parameters": { +"authProvider": { +"description": "Required. The resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+authProvider}/credentials:finalize", +"request": { +"$ref": "GoogleCloudAgentidentitycredentialsV1_FinalizeCredentialsRequest" +}, +"response": { +"$ref": "GoogleCloudAgentidentitycredentialsV1_FinalizeCredentialsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"retrieve": { +"description": "Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/credentials:retrieve", +"httpMethod": "POST", +"id": "agentidentitycredentials.projects.locations.authProviders.credentials.retrieve", +"parameterOrder": [ +"authProvider" +], +"parameters": { +"authProvider": { +"description": "Required. The parent resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+authProvider}/credentials:retrieve", +"request": { +"$ref": "GoogleCloudAgentidentitycredentialsV1_RetrieveCredentialsRequest" +}, +"response": { +"$ref": "GoogleCloudAgentidentitycredentialsV1_RetrieveCredentialsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +} +}, +"revision": "20260717", +"rootUrl": "https://agentidentitycredentials.googleapis.com/", +"schemas": { +"GoogleCloudAgentidentitycredentialsV1_ConsentRejected": { +"description": "Indicates the user has rejected the permission delegation or cancelled the request.", +"id": "GoogleCloudAgentidentitycredentialsV1_ConsentRejected", +"properties": {}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1_FinalizeCredentialsRequest": { +"description": "Request message for FinalizeCredentials.", +"id": "GoogleCloudAgentidentitycredentialsV1_FinalizeCredentialsRequest", +"properties": { +"consentNonce": { +"description": "Required. The same consent_nonce value that was provided during redirect in the UriConsentRequired metadata.", +"type": "string" +}, +"userId": { +"description": "Required. The identity of the end user.", +"type": "string" +}, +"userIdValidationState": { +"description": "Required. The encrypted state passed back from the consent flow.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1_FinalizeCredentialsResponse": { +"description": "Response message for FinalizeCredentials. Intentionally empty", +"id": "GoogleCloudAgentidentitycredentialsV1_FinalizeCredentialsResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1_Pending": { +"description": "Indicates that the credential retrieval is pending. The caller should retry the RetrieveCredentials request after some time.", +"id": "GoogleCloudAgentidentitycredentialsV1_Pending", +"properties": {}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1_RetrieveCredentialsRequest": { +"description": "Request message for RetrieveCredentials.", +"id": "GoogleCloudAgentidentitycredentialsV1_RetrieveCredentialsRequest", +"properties": { +"continueUri": { +"description": "Optional. The URI to redirect the user to after consent is completed. This field is required for authproviders using the 3-legged OAuth flow. For other authprovider types, this field is unused but not rejected.", +"type": "string" +}, +"forceRefreshToken": { +"description": "Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Will trigger a refresh of the access token with a stored refresh token, if possible, or a new consent flow.", +"type": "string" +}, +"scopes": { +"description": "Optional. The OAuth scopes required for this access.", +"items": { +"type": "string" +}, +"type": "array" +}, +"userId": { +"description": "Required. The identity of the end user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1_RetrieveCredentialsResponse": { +"description": "Response message for RetrieveCredentials. Contains the access tokens and related artifacts.", +"id": "GoogleCloudAgentidentitycredentialsV1_RetrieveCredentialsResponse", +"properties": { +"consentRejected": { +"$ref": "GoogleCloudAgentidentitycredentialsV1_ConsentRejected", +"description": "Message indicating consent was rejected." +}, +"pending": { +"$ref": "GoogleCloudAgentidentitycredentialsV1_Pending", +"description": "Message indicating credential retrieval is pending." +}, +"success": { +"$ref": "GoogleCloudAgentidentitycredentialsV1_Success", +"description": "Message indicating credentials were successfully retrieved." +}, +"uriConsentRequired": { +"$ref": "GoogleCloudAgentidentitycredentialsV1_UriConsentRequired", +"description": "Message indicating uri based consent is required." +} +}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1_Success": { +"description": "Message indicating successful retrieval of credentials.", +"id": "GoogleCloudAgentidentitycredentialsV1_Success", +"properties": { +"expireTime": { +"description": "The expiration time of the token. This does not guarantee that the token will be valid until this time, since the token could be revoked earlier. There could also be clock skew between the auth provider and the client so it may expire slightly earlier. If not set, the token might be permanent or it may be that the service does not (or cannot) know when it will expire.", +"format": "google-datetime", +"type": "string" +}, +"header": { +"description": "The HTTP header name where the token should be placed.", +"type": "string" +}, +"scopes": { +"description": "The scopes actually associated with the retrieved token. End users may have rejected some requested scopes, or the third-party authorization servers can return a different set of scopes than what was asked for. Callers should verify that all required scopes for their intended use are included in this list.", +"items": { +"type": "string" +}, +"type": "array" +}, +"token": { +"description": "The retrieved access token or credential for the end user. On MCPTool call, for an invalid token OAuth spec says this should return 401 or 403, but MCPServers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to RetrieveCredentials with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1_UriConsentRequired": { +"description": "Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback", +"id": "GoogleCloudAgentidentitycredentialsV1_UriConsentRequired", +"properties": { +"authorizationUri": { +"description": "Output only. The URL where the user should be redirected to grant consent. This will always be present.", +"readOnly": true, +"type": "string" +}, +"consentNonce": { +"description": "Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the FinalizeCredentials request to complete the OAuth exchange. This will always be present. Implemented per https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5", +"readOnly": true, +"type": "string" +}, +"uid": { +"description": "Output only. The unique ID of the credentials retrieval operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Agent Identity Credentials API", +"version": "v1", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/agentidentitycredentials.v1alpha.json b/googleapiclient/discovery_cache/documents/agentidentitycredentials.v1alpha.json new file mode 100644 index 0000000000..1aa35c4da9 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/agentidentitycredentials.v1alpha.json @@ -0,0 +1,325 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"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." +} +} +} +}, +"basePath": "", +"baseUrl": "https://agentidentitycredentials.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Agent Identity Credentials", +"description": "agentidentitycredentials.googleapis.com API.", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/iam/docs/", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "agentidentitycredentials:v1alpha", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://agentidentitycredentials.mtls.googleapis.com/", +"name": "agentidentitycredentials", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"projects": { +"resources": { +"locations": { +"resources": { +"authProviders": { +"resources": { +"credentials": { +"methods": { +"finalize": { +"description": "Finalizes the credentials after a successful consent flow.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/credentials:finalize", +"httpMethod": "POST", +"id": "agentidentitycredentials.projects.locations.authProviders.credentials.finalize", +"parameterOrder": [ +"authProvider" +], +"parameters": { +"authProvider": { +"description": "Required. The resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+authProvider}/credentials:finalize", +"request": { +"$ref": "GoogleCloudAgentidentitycredentialsV1alpha_FinalizeCredentialsRequest" +}, +"response": { +"$ref": "GoogleCloudAgentidentitycredentialsV1alpha_FinalizeCredentialsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"retrieve": { +"description": "Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/credentials:retrieve", +"httpMethod": "POST", +"id": "agentidentitycredentials.projects.locations.authProviders.credentials.retrieve", +"parameterOrder": [ +"authProvider" +], +"parameters": { +"authProvider": { +"description": "Required. The parent resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+authProvider}/credentials:retrieve", +"request": { +"$ref": "GoogleCloudAgentidentitycredentialsV1alpha_RetrieveCredentialsRequest" +}, +"response": { +"$ref": "GoogleCloudAgentidentitycredentialsV1alpha_RetrieveCredentialsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +} +}, +"revision": "20260717", +"rootUrl": "https://agentidentitycredentials.googleapis.com/", +"schemas": { +"GoogleCloudAgentidentitycredentialsV1alpha_ConsentRejected": { +"description": "Indicates the user has rejected the permission delegation or cancelled the request.", +"id": "GoogleCloudAgentidentitycredentialsV1alpha_ConsentRejected", +"properties": {}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1alpha_FinalizeCredentialsRequest": { +"description": "Request message for FinalizeCredentials.", +"id": "GoogleCloudAgentidentitycredentialsV1alpha_FinalizeCredentialsRequest", +"properties": { +"consentNonce": { +"description": "Required. The same consent_nonce value that was provided during redirect in the UriConsentRequired metadata.", +"type": "string" +}, +"userId": { +"description": "Required. The identity of the end user.", +"type": "string" +}, +"userIdValidationState": { +"description": "Required. The encrypted state passed back from the consent flow.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1alpha_FinalizeCredentialsResponse": { +"description": "Response message for FinalizeCredentials. Intentionally empty", +"id": "GoogleCloudAgentidentitycredentialsV1alpha_FinalizeCredentialsResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1alpha_Pending": { +"description": "Indicates that the credential retrieval is pending. The caller should retry the RetrieveCredentials request after some time.", +"id": "GoogleCloudAgentidentitycredentialsV1alpha_Pending", +"properties": {}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1alpha_RetrieveCredentialsRequest": { +"description": "Request message for RetrieveCredentials.", +"id": "GoogleCloudAgentidentitycredentialsV1alpha_RetrieveCredentialsRequest", +"properties": { +"continueUri": { +"description": "Optional. The URI to redirect the user to after consent is completed. This field is required for authproviders using the 3-legged OAuth flow. For other authprovider types, this field is unused but not rejected.", +"type": "string" +}, +"forceRefreshToken": { +"description": "Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Will trigger a refresh of the access token with a stored refresh token, if possible, or a new consent flow.", +"type": "string" +}, +"scopes": { +"description": "Optional. The OAuth scopes required for this access.", +"items": { +"type": "string" +}, +"type": "array" +}, +"userId": { +"description": "Required. The identity of the end user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1alpha_RetrieveCredentialsResponse": { +"description": "Response message for RetrieveCredentials. Contains the access tokens and related artifacts.", +"id": "GoogleCloudAgentidentitycredentialsV1alpha_RetrieveCredentialsResponse", +"properties": { +"consentRejected": { +"$ref": "GoogleCloudAgentidentitycredentialsV1alpha_ConsentRejected", +"description": "Message indicating consent was rejected." +}, +"pending": { +"$ref": "GoogleCloudAgentidentitycredentialsV1alpha_Pending", +"description": "Message indicating credential retrieval is pending." +}, +"success": { +"$ref": "GoogleCloudAgentidentitycredentialsV1alpha_Success", +"description": "Message indicating credentials were successfully retrieved." +}, +"uriConsentRequired": { +"$ref": "GoogleCloudAgentidentitycredentialsV1alpha_UriConsentRequired", +"description": "Message indicating uri based consent is required." +} +}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1alpha_Success": { +"description": "Message indicating successful retrieval of credentials.", +"id": "GoogleCloudAgentidentitycredentialsV1alpha_Success", +"properties": { +"expireTime": { +"description": "The expiration time of the token. This does not guarantee that the token will be valid until this time, since the token could be revoked earlier. There could also be clock skew between the auth provider and the client so it may expire slightly earlier. If not set, the token might be permanent or it may be that the service does not (or cannot) know when it will expire.", +"format": "google-datetime", +"type": "string" +}, +"header": { +"description": "The HTTP header name where the token should be placed.", +"type": "string" +}, +"scopes": { +"description": "The scopes actually associated with the retrieved token. End users may have rejected some requested scopes, or the third-party authorization servers can return a different set of scopes than what was asked for. Callers should verify that all required scopes for their intended use are included in this list.", +"items": { +"type": "string" +}, +"type": "array" +}, +"token": { +"description": "The retrieved access token or credential for the end user. On MCPTool call, for an invalid token OAuth spec says this should return 401 or 403, but MCPServers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to RetrieveCredentials with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1alpha_UriConsentRequired": { +"description": "Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback", +"id": "GoogleCloudAgentidentitycredentialsV1alpha_UriConsentRequired", +"properties": { +"authorizationUri": { +"description": "Output only. The URL where the user should be redirected to grant consent. This will always be present.", +"readOnly": true, +"type": "string" +}, +"consentNonce": { +"description": "Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the FinalizeCredentials request to complete the OAuth exchange. This will always be present. Implemented per https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5", +"readOnly": true, +"type": "string" +}, +"uid": { +"description": "Output only. The unique ID of the credentials retrieval operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Agent Identity Credentials API", +"version": "v1alpha", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/agentidentitycredentials.v1beta.json b/googleapiclient/discovery_cache/documents/agentidentitycredentials.v1beta.json new file mode 100644 index 0000000000..a499415de2 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/agentidentitycredentials.v1beta.json @@ -0,0 +1,325 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"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." +} +} +} +}, +"basePath": "", +"baseUrl": "https://agentidentitycredentials.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Agent Identity Credentials", +"description": "agentidentitycredentials.googleapis.com API.", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/iam/docs/", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "agentidentitycredentials:v1beta", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://agentidentitycredentials.mtls.googleapis.com/", +"name": "agentidentitycredentials", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"projects": { +"resources": { +"locations": { +"resources": { +"authProviders": { +"resources": { +"credentials": { +"methods": { +"finalize": { +"description": "Finalizes the credentials after a successful consent flow.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/credentials:finalize", +"httpMethod": "POST", +"id": "agentidentitycredentials.projects.locations.authProviders.credentials.finalize", +"parameterOrder": [ +"authProvider" +], +"parameters": { +"authProvider": { +"description": "Required. The resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+authProvider}/credentials:finalize", +"request": { +"$ref": "GoogleCloudAgentidentitycredentialsV1beta_FinalizeCredentialsRequest" +}, +"response": { +"$ref": "GoogleCloudAgentidentitycredentialsV1beta_FinalizeCredentialsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"retrieve": { +"description": "Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/credentials:retrieve", +"httpMethod": "POST", +"id": "agentidentitycredentials.projects.locations.authProviders.credentials.retrieve", +"parameterOrder": [ +"authProvider" +], +"parameters": { +"authProvider": { +"description": "Required. The parent resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+authProvider}/credentials:retrieve", +"request": { +"$ref": "GoogleCloudAgentidentitycredentialsV1beta_RetrieveCredentialsRequest" +}, +"response": { +"$ref": "GoogleCloudAgentidentitycredentialsV1beta_RetrieveCredentialsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +} +}, +"revision": "20260717", +"rootUrl": "https://agentidentitycredentials.googleapis.com/", +"schemas": { +"GoogleCloudAgentidentitycredentialsV1beta_ConsentRejected": { +"description": "Indicates the user has rejected the permission delegation or cancelled the request.", +"id": "GoogleCloudAgentidentitycredentialsV1beta_ConsentRejected", +"properties": {}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1beta_FinalizeCredentialsRequest": { +"description": "Request message for FinalizeCredentials.", +"id": "GoogleCloudAgentidentitycredentialsV1beta_FinalizeCredentialsRequest", +"properties": { +"consentNonce": { +"description": "Required. The same consent_nonce value that was provided during redirect in the UriConsentRequired metadata.", +"type": "string" +}, +"userId": { +"description": "Required. The identity of the end user.", +"type": "string" +}, +"userIdValidationState": { +"description": "Required. The encrypted state passed back from the consent flow.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1beta_FinalizeCredentialsResponse": { +"description": "Response message for FinalizeCredentials. Intentionally empty", +"id": "GoogleCloudAgentidentitycredentialsV1beta_FinalizeCredentialsResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1beta_Pending": { +"description": "Indicates that the credential retrieval is pending. The caller should retry the RetrieveCredentials request after some time.", +"id": "GoogleCloudAgentidentitycredentialsV1beta_Pending", +"properties": {}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1beta_RetrieveCredentialsRequest": { +"description": "Request message for RetrieveCredentials.", +"id": "GoogleCloudAgentidentitycredentialsV1beta_RetrieveCredentialsRequest", +"properties": { +"continueUri": { +"description": "Optional. The URI to redirect the user to after consent is completed. This field is required for authproviders using the 3-legged OAuth flow. For other authprovider types, this field is unused but not rejected.", +"type": "string" +}, +"forceRefreshToken": { +"description": "Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Will trigger a refresh of the access token with a stored refresh token, if possible, or a new consent flow.", +"type": "string" +}, +"scopes": { +"description": "Optional. The OAuth scopes required for this access.", +"items": { +"type": "string" +}, +"type": "array" +}, +"userId": { +"description": "Required. The identity of the end user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1beta_RetrieveCredentialsResponse": { +"description": "Response message for RetrieveCredentials. Contains the access tokens and related artifacts.", +"id": "GoogleCloudAgentidentitycredentialsV1beta_RetrieveCredentialsResponse", +"properties": { +"consentRejected": { +"$ref": "GoogleCloudAgentidentitycredentialsV1beta_ConsentRejected", +"description": "Message indicating consent was rejected." +}, +"pending": { +"$ref": "GoogleCloudAgentidentitycredentialsV1beta_Pending", +"description": "Message indicating credential retrieval is pending." +}, +"success": { +"$ref": "GoogleCloudAgentidentitycredentialsV1beta_Success", +"description": "Message indicating credentials were successfully retrieved." +}, +"uriConsentRequired": { +"$ref": "GoogleCloudAgentidentitycredentialsV1beta_UriConsentRequired", +"description": "Message indicating uri based consent is required." +} +}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1beta_Success": { +"description": "Message indicating successful retrieval of credentials.", +"id": "GoogleCloudAgentidentitycredentialsV1beta_Success", +"properties": { +"expireTime": { +"description": "The expiration time of the token. This does not guarantee that the token will be valid until this time, since the token could be revoked earlier. There could also be clock skew between the auth provider and the client so it may expire slightly earlier. If not set, the token might be permanent or it may be that the service does not (or cannot) know when it will expire.", +"format": "google-datetime", +"type": "string" +}, +"header": { +"description": "The HTTP header name where the token should be placed.", +"type": "string" +}, +"scopes": { +"description": "The scopes actually associated with the retrieved token. End users may have rejected some requested scopes, or the third-party authorization servers can return a different set of scopes than what was asked for. Callers should verify that all required scopes for their intended use are included in this list.", +"items": { +"type": "string" +}, +"type": "array" +}, +"token": { +"description": "The retrieved access token or credential for the end user. On MCPTool call, for an invalid token OAuth spec says this should return 401 or 403, but MCPServers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to RetrieveCredentials with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAgentidentitycredentialsV1beta_UriConsentRequired": { +"description": "Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback", +"id": "GoogleCloudAgentidentitycredentialsV1beta_UriConsentRequired", +"properties": { +"authorizationUri": { +"description": "Output only. The URL where the user should be redirected to grant consent. This will always be present.", +"readOnly": true, +"type": "string" +}, +"consentNonce": { +"description": "Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the FinalizeCredentials request to complete the OAuth exchange. This will always be present. Implemented per https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5", +"readOnly": true, +"type": "string" +}, +"uid": { +"description": "Output only. The unique ID of the credentials retrieval operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Agent Identity Credentials API", +"version": "v1beta", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json index cdb2093706..7d61d08639 100644 --- a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json @@ -423,7 +423,7 @@ } } }, -"revision": "20260706", +"revision": "20260727", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AbuseDetected": { @@ -2010,7 +2010,8 @@ "CHROME_URL_VISITED", "CHROMEOS_FILE_TRANSFER", "GEMINI_ACCESS", -"AGENT_EXECUTION" +"AGENT_EXECUTION", +"CHROME_DATA_COPIED" ], "enumDescriptions": [ "Trigger is unspecified.", @@ -2025,7 +2026,8 @@ "A URL is visited within Chrome.", "A file being transferred (copy or moved) between different file systems on ChromeOS.", "Gemini access.", -"Agent execution." +"Agent execution.", +"Text copied from Chrome." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index a48f04d4eb..00c4a7efa4 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -2725,7 +2725,7 @@ } } }, -"revision": "20260701", +"revision": "20260715", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -3999,7 +3999,7 @@ "id": "BackupVault", "properties": { "accessRestriction": { -"description": "Optional. Note: This field is added for future use case and will not be supported in the current release. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.", +"description": "Optional. Restricts access to certain sources and destinations for data being sent into, or restored from, the backup vault. Defaults to WITHIN_ORGANIZATION if not provided during creation.", "enum": [ "ACCESS_RESTRICTION_UNSPECIFIED", "WITHIN_PROJECT", diff --git a/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v2.json b/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v2.json index b4135523e0..cd9c49cc1e 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v2.json @@ -429,7 +429,7 @@ } } }, -"revision": "20260415", +"revision": "20260722", "rootUrl": "https://bigquerydatapolicy.googleapis.com/", "schemas": { "AddGranteesRequest": { @@ -532,7 +532,7 @@ "type": "object" }, "DataGovernanceTag": { -"description": "Data Governance tag This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`.", +"description": "This is a namespaced name specifying the key and the value. For example: `project-id/pii/sensitive`.", "id": "DataGovernanceTag", "properties": { "key": { diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 71ceef40b5..a4017f5647 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -875,7 +875,7 @@ ] }, "queryUrlVisits": { -"description": "Returns a high-level summary of URL visits for a given customer.", +"description": "Returns a high-level summary of URL visits for a given customer. Requires a Chrome Enterprise Premium subscription. If the customer does not have this subscription, query results will be empty.", "flatPath": "v1/customers/{customersId}/enterprise/securityInsights:queryUrlVisits", "httpMethod": "GET", "id": "chromemanagement.customers.enterprise.securityInsights.queryUrlVisits", @@ -906,7 +906,7 @@ ] }, "queryUrlVisitsBreakdowns": { -"description": "Returns summaries of URL visits for a given metric and breakdown dimension.", +"description": "Returns summaries of URL visits for a given metric and breakdown dimension. Requires a Chrome Enterprise Premium subscription. If the customer does not have this subscription, query results will be empty.", "flatPath": "v1/customers/{customersId}/enterprise/securityInsights:queryUrlVisitsBreakdowns", "httpMethod": "GET", "id": "chromemanagement.customers.enterprise.securityInsights.queryUrlVisitsBreakdowns", @@ -2409,7 +2409,7 @@ } } }, -"revision": "20260709", +"revision": "20260715", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { diff --git a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json index 712ca71ef5..a7f6327c06 100644 --- a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json +++ b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json @@ -557,7 +557,7 @@ } } }, -"revision": "20250504", +"revision": "20260726", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "GoogleChromePolicyVersionsV1AdditionalTargetKeyName": { @@ -1789,7 +1789,7 @@ "properties": { "editionDeprecated": { "deprecated": true, -"description": "copybara:strip_begin TODO(b/297898292) Deprecate and remove this field in favor of enums. copybara:strip_end", +"description": "copybara:strip_begin TODO(b/538805613) Deprecate and remove this field in favor of enums. copybara:strip_end", "type": "string" }, "enumType": { diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index 6111973d57..29120768ab 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -343,7 +343,7 @@ "type": "string" }, "updateMask": { -"description": "Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` * `levels` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`", +"description": "Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` * `learningStandardSettings` * `levels` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4376,7 +4376,7 @@ } } }, -"revision": "20260610", +"revision": "20260708", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json index d2f4ef47f4..89dcef5d33 100644 --- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json @@ -3058,7 +3058,7 @@ } } }, -"revision": "20260702", +"revision": "20260709", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AddQuorumMember": { @@ -6103,7 +6103,7 @@ false "type": "string" }, "keyPortabilityEnabled": { -"description": "Optional. Immutable. Indicates whether key portability is enabled for the SingleTenantHsmInstance. This can only be set at creation time. Key portability features are disabled by default and not yet available in GA.", +"description": "Optional. Immutable. Indicates whether key portability is enabled for the SingleTenantHsmInstance. This can only be set at creation time. Key portability features are disabled by default.", "type": "boolean" }, "name": { diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v1.json b/googleapiclient/discovery_cache/documents/cloudtrace.v1.json index 9d2cb98d9f..1783487fdc 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v1.json @@ -409,7 +409,7 @@ ], "parameters": { "endTime": { -"description": "End of the time interval (inclusive) during which the trace data was collected from the application.", +"description": "Required. End of the time interval (inclusive) during which the trace data was collected from the application.", "format": "google-datetime", "location": "query", "type": "string" @@ -431,7 +431,7 @@ "type": "integer" }, "pageToken": { -"description": "Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request.", +"description": "Optional. Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request.", "location": "query", "type": "string" }, @@ -442,7 +442,7 @@ "type": "string" }, "startTime": { -"description": "Start of the time interval (inclusive) during which the trace data was collected from the application.", +"description": "Required. Start of the time interval (inclusive) during which the trace data was collected from the application.", "format": "google-datetime", "location": "query", "type": "string" @@ -479,7 +479,7 @@ } } }, -"revision": "20260612", +"revision": "20260724", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { @@ -511,7 +511,7 @@ "id": "Trace", "properties": { "projectId": { -"description": "Project ID of the Cloud project where the trace data is stored.", +"description": "Required. Project ID of the Cloud project where the trace data is stored.", "type": "string" }, "spans": { @@ -522,7 +522,7 @@ "type": "array" }, "traceId": { -"description": "Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string. For example, `382d4f4c6b7bb2f4a972559d9085001d`. The numeric value should not be zero.", +"description": "Required. Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string. For example, `382d4f4c6b7bb2f4a972559d9085001d`. The numeric value should not be zero.", "type": "string" } }, @@ -533,12 +533,12 @@ "id": "TraceSpan", "properties": { "endTime": { -"description": "End time of the span in seconds and nanoseconds from the UNIX epoch.", +"description": "Required. End time of the span in seconds and nanoseconds from the UNIX epoch.", "format": "google-datetime", "type": "string" }, "kind": { -"description": "Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span.", +"description": "Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span.", "enum": [ "SPAN_KIND_UNSPECIFIED", "RPC_SERVER", @@ -555,11 +555,11 @@ "additionalProperties": { "type": "string" }, -"description": "Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own. For more information, see [Cloud Trace labels](https://cloud.google.com/trace/docs/trace-labels).", +"description": "Optional. Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own. For more information, see [Cloud Trace labels](https://cloud.google.com/trace/docs/trace-labels).", "type": "object" }, "name": { -"description": "Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.", +"description": "Required. Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.", "type": "string" }, "parentSpanId": { @@ -568,12 +568,12 @@ "type": "string" }, "spanId": { -"description": "Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, `2205310701640571284`.", +"description": "Required. Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, `2205310701640571284`.", "format": "uint64", "type": "string" }, "startTime": { -"description": "Start time of the span in seconds and nanoseconds from the UNIX epoch.", +"description": "Required. Start time of the span in seconds and nanoseconds from the UNIX epoch.", "format": "google-datetime", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v2.json b/googleapiclient/discovery_cache/documents/cloudtrace.v2.json index 5499d7735b..a8a5e07c17 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v2.json @@ -377,7 +377,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. .", +"description": "Identifier. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. .", "location": "path", "pattern": "^projects/[^/]+/traces/[^/]+/spans/[^/]+$", "required": true, @@ -403,7 +403,7 @@ } } }, -"revision": "20260612", +"revision": "20260724", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Annotation": { @@ -412,11 +412,11 @@ "properties": { "attributes": { "$ref": "Attributes", -"description": "A set of attributes on the annotation. You can have up to 4 attributes per Annotation." +"description": "Optional. A set of attributes on the annotation. You can have up to 4 attributes per Annotation." }, "description": { "$ref": "TruncatableString", -"description": "A user-supplied message describing the event. The maximum length for the description is 256 bytes." +"description": "Optional. A user-supplied message describing the event. The maximum length for the description is 256 bytes." } }, "type": "object" @@ -426,17 +426,17 @@ "id": "AttributeValue", "properties": { "boolValue": { -"description": "A Boolean value represented by `true` or `false`.", +"description": "Optional. A Boolean value represented by `true` or `false`.", "type": "boolean" }, "intValue": { -"description": "A 64-bit signed integer.", +"description": "Optional. A 64-bit signed integer.", "format": "int64", "type": "string" }, "stringValue": { "$ref": "TruncatableString", -"description": "A string up to 256 bytes long." +"description": "Optional. A string up to 256 bytes long." } }, "type": "object" @@ -449,11 +449,11 @@ "additionalProperties": { "$ref": "AttributeValue" }, -"description": "A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: \"/instance_id\": { \"string_value\": { \"value\": \"my-instance\" } } \"/http/request_bytes\": { \"int_value\": 300 } \"example.com/myattribute\": { \"bool_value\": false }", +"description": "Optional. A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: \"/instance_id\": { \"string_value\": { \"value\": \"my-instance\" } } \"/http/request_bytes\": { \"int_value\": 300 } \"example.com/myattribute\": { \"bool_value\": false }", "type": "object" }, "droppedAttributesCount": { -"description": "The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid.", +"description": "Optional. The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid.", "format": "int32", "type": "integer" } @@ -486,18 +486,18 @@ "properties": { "attributes": { "$ref": "Attributes", -"description": "A set of attributes on the link. Up to 32 attributes can be specified per link." +"description": "Optional. A set of attributes on the link. Up to 32 attributes can be specified per link." }, "spanId": { -"description": "The `[SPAN_ID]` for a span within a trace.", +"description": "Optional. The `[SPAN_ID]` for a span within a trace.", "type": "string" }, "traceId": { -"description": "The `[TRACE_ID]` for a trace within a project.", +"description": "Optional. The `[TRACE_ID]` for a trace within a project.", "type": "string" }, "type": { -"description": "The relationship of the current span relative to the linked span.", +"description": "Optional. The relationship of the current span relative to the linked span.", "enum": [ "TYPE_UNSPECIFIED", "CHILD_LINKED_SPAN", @@ -518,12 +518,12 @@ "id": "Links", "properties": { "droppedLinksCount": { -"description": "The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.", +"description": "Optional. The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.", "format": "int32", "type": "integer" }, "link": { -"description": "A collection of links.", +"description": "Optional. A collection of links.", "items": { "$ref": "Link" }, @@ -537,17 +537,17 @@ "id": "MessageEvent", "properties": { "compressedSizeBytes": { -"description": "The number of compressed bytes sent or received. If missing, the compressed size is assumed to be the same size as the uncompressed size.", +"description": "Optional. The number of compressed bytes sent or received. If missing, the compressed size is assumed to be the same size as the uncompressed size.", "format": "int64", "type": "string" }, "id": { -"description": "An identifier for the MessageEvent's message that can be used to match `SENT` and `RECEIVED` MessageEvents.", +"description": "Optional. An identifier for the MessageEvent's message that can be used to match `SENT` and `RECEIVED` MessageEvents.", "format": "int64", "type": "string" }, "type": { -"description": "Type of MessageEvent. Indicates whether the message was sent or received.", +"description": "Optional. Type of MessageEvent. Indicates whether the message was sent or received.", "enum": [ "TYPE_UNSPECIFIED", "SENT", @@ -561,7 +561,7 @@ "type": "string" }, "uncompressedSizeBytes": { -"description": "The number of uncompressed bytes sent or received.", +"description": "Optional. The number of uncompressed bytes sent or received.", "format": "int64", "type": "string" } @@ -574,11 +574,11 @@ "properties": { "buildId": { "$ref": "TruncatableString", -"description": "A unique identifier for the module, usually a hash of its contents (up to 128 bytes)." +"description": "Optional. A unique identifier for the module, usually a hash of its contents (up to 128 bytes)." }, "module": { "$ref": "TruncatableString", -"description": "For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes)." +"description": "Optional. For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes)." } }, "type": "object" @@ -589,7 +589,7 @@ "properties": { "attributes": { "$ref": "Attributes", -"description": "A set of attributes on the span. You can have up to 32 attributes per span." +"description": "Optional. A set of attributes on the span. You can have up to 32 attributes per span." }, "childSpanCount": { "description": "Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.", @@ -607,14 +607,14 @@ }, "links": { "$ref": "Links", -"description": "Links associated with the span. You can have up to 128 links per Span." +"description": "Optional. Links associated with the span. You can have up to 128 links per Span." }, "name": { -"description": "Required. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. .", +"description": "Identifier. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. .", "type": "string" }, "parentSpanId": { -"description": "The `[SPAN_ID]` of this span's parent span. If this is a root span, then this field must be empty.", +"description": "Optional. The `[SPAN_ID]` of this span's parent span. If this is a root span, then this field must be empty.", "type": "string" }, "sameProcessAsParentSpan": { @@ -647,7 +647,7 @@ }, "stackTrace": { "$ref": "StackTrace", -"description": "Stack trace captured at the start of the span." +"description": "Optional. Stack trace captured at the start of the span." }, "startTime": { "description": "Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.", @@ -660,7 +660,7 @@ }, "timeEvents": { "$ref": "TimeEvents", -"description": "A set of time events. You can have up to 32 annotations and 128 message events per span." +"description": "Optional. A set of time events. You can have up to 32 annotations and 128 message events per span." } }, "type": "object" @@ -670,34 +670,34 @@ "id": "StackFrame", "properties": { "columnNumber": { -"description": "The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions.", +"description": "Optional. The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions.", "format": "int64", "type": "string" }, "fileName": { "$ref": "TruncatableString", -"description": "The name of the source file where the function call appears (up to 256 bytes)." +"description": "Optional. The name of the source file where the function call appears (up to 256 bytes)." }, "functionName": { "$ref": "TruncatableString", -"description": "The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes)." +"description": "Optional. The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes)." }, "lineNumber": { -"description": "The line number in `file_name` where the function call appears.", +"description": "Optional. The line number in `file_name` where the function call appears.", "format": "int64", "type": "string" }, "loadModule": { "$ref": "Module", -"description": "The binary module from where the code was loaded." +"description": "Optional. The binary module from where the code was loaded." }, "originalFunctionName": { "$ref": "TruncatableString", -"description": "An un-mangled function name, if `function_name` is mangled. To get information about name mangling, run [this search](https://www.google.com/search?q=cxx+name+mangling). The name can be fully-qualified (up to 1024 bytes)." +"description": "Optional. An un-mangled function name, if `function_name` is mangled. To get information about name mangling, run [this search](https://www.google.com/search?q=cxx+name+mangling). The name can be fully-qualified (up to 1024 bytes)." }, "sourceVersion": { "$ref": "TruncatableString", -"description": "The version of the deployed source code (up to 128 bytes)." +"description": "Optional. The version of the deployed source code (up to 128 bytes)." } }, "type": "object" @@ -707,12 +707,12 @@ "id": "StackFrames", "properties": { "droppedFramesCount": { -"description": "The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped.", +"description": "Optional. The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped.", "format": "int32", "type": "integer" }, "frame": { -"description": "Stack frames in this call stack.", +"description": "Optional. Stack frames in this call stack.", "items": { "$ref": "StackFrame" }, @@ -727,10 +727,10 @@ "properties": { "stackFrames": { "$ref": "StackFrames", -"description": "Stack frames in this stack trace. A maximum of 128 frames are allowed." +"description": "Optional. Stack frames in this stack trace. A maximum of 128 frames are allowed." }, "stackTraceHashId": { -"description": "The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both the `stackFrame` content and a value in `stackTraceHashId`. Subsequent spans within the same request can refer to that stack trace by only setting `stackTraceHashId`.", +"description": "Optional. The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both the `stackFrame` content and a value in `stackTraceHashId`. Subsequent spans within the same request can refer to that stack trace by only setting `stackTraceHashId`.", "format": "int64", "type": "string" } @@ -777,7 +777,7 @@ "description": "An event describing a message sent/received between Spans." }, "time": { -"description": "The timestamp indicating the time the event occurred.", +"description": "Optional. The timestamp indicating the time the event occurred.", "format": "google-datetime", "type": "string" } @@ -789,17 +789,17 @@ "id": "TimeEvents", "properties": { "droppedAnnotationsCount": { -"description": "The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped.", +"description": "Optional. The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped.", "format": "int32", "type": "integer" }, "droppedMessageEventsCount": { -"description": "The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped.", +"description": "Optional. The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped.", "format": "int32", "type": "integer" }, "timeEvent": { -"description": "A collection of `TimeEvent`s.", +"description": "Optional. A collection of `TimeEvent`s.", "items": { "$ref": "TimeEvent" }, @@ -813,12 +813,12 @@ "id": "TruncatableString", "properties": { "truncatedByteCount": { -"description": "The number of bytes removed from the original string. If this value is 0, then the string was not shortened.", +"description": "Optional. The number of bytes removed from the original string. If this value is 0, then the string was not shortened.", "format": "int32", "type": "integer" }, "value": { -"description": "The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.", +"description": "Optional. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/config.v1.json b/googleapiclient/discovery_cache/documents/config.v1.json index d8c9cf2d03..212fbd679b 100644 --- a/googleapiclient/discovery_cache/documents/config.v1.json +++ b/googleapiclient/discovery_cache/documents/config.v1.json @@ -1788,7 +1788,7 @@ } } }, -"revision": "20260623", +"revision": "20260722", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { @@ -3133,7 +3133,7 @@ "type": "string" }, "deployment": { -"description": "Optional. Optional deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request.", +"description": "Optional. Deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request.", "type": "string" }, "errorCode": { diff --git a/googleapiclient/discovery_cache/documents/css.v1.json b/googleapiclient/discovery_cache/documents/css.v1.json index a64519505a..09059aee73 100644 --- a/googleapiclient/discovery_cache/documents/css.v1.json +++ b/googleapiclient/discovery_cache/documents/css.v1.json @@ -547,7 +547,7 @@ } } }, -"revision": "20260310", +"revision": "20260713", "rootUrl": "https://css.googleapis.com/", "schemas": { "Account": { @@ -1417,7 +1417,7 @@ "type": "string" }, "quotaUsage": { -"description": "Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at at 12:00 PM midday UTC.", +"description": "Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at 12:00 PM midday UTC.", "format": "int64", "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/dns.v1.json b/googleapiclient/discovery_cache/documents/dns.v1.json index 29c6920f19..3bc3f1599d 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1.json +++ b/googleapiclient/discovery_cache/documents/dns.v1.json @@ -117,7 +117,7 @@ "changes": { "methods": { "create": { -"description": "Atomically updates the ResourceRecordSet collection.", +"description": "Atomically updates the ResourceRecordSet collection. Note: While `dns.changes.create` is the baseline permission required to invoke this method, additional permissions are checked depending on the specific additions or deletions contained in the payload.", "flatPath": "dns/v1/projects/{project}/managedZones/{managedZone}/changes", "httpMethod": "POST", "id": "dns.changes.create", @@ -483,7 +483,7 @@ "managedZones": { "methods": { "create": { -"description": "Creates a new ManagedZone.", +"description": "Creates a new ManagedZone. Note: While `dns.managedZones.create` is the baseline permission required to invoke this method, additional permissions are required if the managed zone configuration references other resources.", "flatPath": "dns/v1/projects/{project}/managedZones", "httpMethod": "POST", "id": "dns.managedZones.create", @@ -1829,7 +1829,7 @@ } } }, -"revision": "20260616", +"revision": "20260714", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { diff --git a/googleapiclient/discovery_cache/documents/dns.v1beta2.json b/googleapiclient/discovery_cache/documents/dns.v1beta2.json index 1735a26fc1..cba633df56 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/dns.v1beta2.json @@ -117,7 +117,7 @@ "changes": { "methods": { "create": { -"description": "Atomically updates the ResourceRecordSet collection.", +"description": "Atomically updates the ResourceRecordSet collection. Note: While `dns.changes.create` is the baseline permission required to invoke this method, additional permissions are checked depending on the specific additions or deletions contained in the payload.", "flatPath": "dns/v1beta2/projects/{project}/managedZones/{managedZone}/changes", "httpMethod": "POST", "id": "dns.changes.create", @@ -483,7 +483,7 @@ "managedZones": { "methods": { "create": { -"description": "Creates a new ManagedZone.", +"description": "Creates a new ManagedZone. Note: While `dns.managedZones.create` is the baseline permission required to invoke this method, additional permissions are required if the managed zone configuration references other resources.", "flatPath": "dns/v1beta2/projects/{project}/managedZones", "httpMethod": "POST", "id": "dns.managedZones.create", @@ -1826,7 +1826,7 @@ } } }, -"revision": "20260616", +"revision": "20260714", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { diff --git a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json index dac096ac37..6a3811a923 100644 --- a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json @@ -154,7 +154,7 @@ } } }, -"revision": "20240707", +"revision": "20260726", "rootUrl": "https://fcmdata.googleapis.com/", "schemas": { "GoogleFirebaseFcmDataV1beta1AndroidDeliveryData": { @@ -228,7 +228,7 @@ "type": "number" }, "delayedMessageThrottled": { -"description": "The percentage of accepted messages that were delayed due to message throttling, such as [collapsible message throttling](https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_throttling) or [maximum message rate throttling](https://firebase.google.com/docs/cloud-messaging/concept-options#device_throttling).", +"description": "The percentage of accepted messages that were delayed due to message throttling, such as [collapsible message throttling](https://firebase.google.com/docs/cloud-messaging/concept-options#collapsible_throttling).", "format": "float", "type": "number" }, diff --git a/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json b/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json index 17cf27c549..e2b97f0a43 100644 --- a/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json @@ -325,7 +325,7 @@ } } }, -"revision": "20251031", +"revision": "20260717", "rootUrl": "https://firebasestorage.googleapis.com/", "schemas": { "AddFirebaseRequest": { @@ -356,7 +356,7 @@ "readOnly": true }, "location": { -"description": "Immutable. Location of the default bucket.", +"description": "Required. Immutable. Location of the default bucket.", "type": "string" }, "name": { diff --git a/googleapiclient/discovery_cache/documents/looker.v1.json b/googleapiclient/discovery_cache/documents/looker.v1.json index 2c80fe5523..2743053869 100644 --- a/googleapiclient/discovery_cache/documents/looker.v1.json +++ b/googleapiclient/discovery_cache/documents/looker.v1.json @@ -748,7 +748,7 @@ } } }, -"revision": "20260609", +"revision": "20260726", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -1391,14 +1391,14 @@ "id": "ListInstancesResponse", "properties": { "instances": { -"description": "The list of instances matching the request filters, up to the requested ListInstancesRequest.pageSize.", +"description": "The list of instances matching the request filters, up to the requested `pageSize`.", "items": { "$ref": "Instance" }, "type": "array" }, "nextPageToken": { -"description": "If provided, a page token that can look up the next ListInstancesRequest.pageSize results. If empty, the results list is exhausted.", +"description": "If provided, a page token that can look up the next `pageSize` results. If empty, the results list is exhausted.", "type": "string" }, "unreachable": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json index 171e945ae7..2c87b6df57 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json @@ -198,12 +198,12 @@ "parameterOrder": [], "parameters": { "categoryName": { -"description": "The primary category stable ID to find available attributes. Must be of the format categories/{category_id}.", +"description": "Optional. The primary category stable ID to find available attributes. Must be of the format `categories/{category_id}` (e.g., `categories/gcid:restaurant`). Required if `parent` is not set and `show_all` is false.", "location": "query", "type": "string" }, "languageCode": { -"description": "The BCP 47 code of language to get attribute display names in. If this language is not available, they will be provided in English.", +"description": "Optional. The BCP 47 code of language to get attribute display names in. If this language is not available, they will be provided in English.", "location": "query", "type": "string" }, @@ -219,17 +219,17 @@ "type": "string" }, "parent": { -"description": "Resource name of the location to look up available attributes. If this field is set, category_name, region_code, language_code and show_all are not required and must not be set.", +"description": "Optional. Resource name of the location to look up available attributes. If this field is set, `category_name`, `region_code`, `language_code` and `show_all` are not required and must not be set. Format: `locations/{location_id}` (e.g., `locations/1234567890`).", "location": "query", "type": "string" }, "regionCode": { -"description": "The ISO 3166-1 alpha-2 country code to find available attributes.", +"description": "Optional. The ISO 3166-1 alpha-2 country code to find available attributes. Required if `parent` is not set.", "location": "query", "type": "string" }, "showAll": { -"description": "Metadata for all available attributes are returned when this field is set to true, disregarding parent and category_name fields. language_code and region_code are required when show_all is set to true.", +"description": "Optional. If set to true, metadata for all available attributes are returned, disregarding `parent` and `category_name` fields. `language_code` and `region_code` are required when `show_all` is set to true.", "location": "query", "type": "boolean" } @@ -612,7 +612,7 @@ } } }, -"revision": "20260707", +"revision": "20260726", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { diff --git a/googleapiclient/discovery_cache/documents/notebooks.v2.json b/googleapiclient/discovery_cache/documents/notebooks.v2.json index 1e4f2e35aa..18c8ce5025 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v2.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v2.json @@ -511,7 +511,7 @@ "type": "string" }, "updateMask": { -"description": "Required. Mask used to update an instance. Updatable fields: * `labels` * `gce_setup.min_cpu_platform` * `gce_setup.metadata` * `gce_setup.machine_type` * `gce_setup.accelerator_configs` * `gce_setup.accelerator_configs.type` * `gce_setup.accelerator_configs.core_count` * `gce_setup.gpu_driver_config` * `gce_setup.gpu_driver_config.enable_gpu_driver` * `gce_setup.gpu_driver_config.custom_gpu_driver_path` * `gce_setup.shielded_instance_config` * `gce_setup.shielded_instance_config.enable_secure_boot` * `gce_setup.shielded_instance_config.enable_vtpm` * `gce_setup.shielded_instance_config.enable_integrity_monitoring` * `gce_setup.reservation_affinity` * `gce_setup.reservation_affinity.consume_reservation_type` * `gce_setup.reservation_affinity.key` * `gce_setup.reservation_affinity.values` * `gce_setup.tags` * `gce_setup.container_image` * `gce_setup.container_image.repository` * `gce_setup.container_image.tag` * `gce_setup.disable_public_ip` * `disable_proxy_access`", +"description": "Required. Mask used to update an instance. Updatable fields: * `labels` * `gce_setup.min_cpu_platform` * `gce_setup.metadata` * `gce_setup.machine_type` * `gce_setup.accelerator_configs` * `gce_setup.accelerator_configs.type` * `gce_setup.accelerator_configs.core_count` * `gce_setup.gpu_driver_config` * `gce_setup.gpu_driver_config.enable_gpu_driver` * `gce_setup.gpu_driver_config.custom_gpu_driver_path` * `gce_setup.shielded_instance_config` * `gce_setup.shielded_instance_config.enable_secure_boot` * `gce_setup.shielded_instance_config.enable_vtpm` * `gce_setup.shielded_instance_config.enable_integrity_monitoring` * `gce_setup.reservation_affinity` * `gce_setup.reservation_affinity.consume_reservation_type` * `gce_setup.reservation_affinity.key` * `gce_setup.reservation_affinity.values` * `gce_setup.tags` * `gce_setup.container_image` * `gce_setup.container_image.repository` * `gce_setup.container_image.tag` * `gce_setup.disable_public_ip` * `disable_proxy_access` Note: `gce_setup.disable_public_ip` and `disable_proxy_access` are one-way on update -- they can only be used to *disable* the feature (set the field to `true`). Requests that set either field back to `false` (re-enabling the external IP or proxy access) are rejected with `INVALID_ARGUMENT`.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -971,7 +971,7 @@ } } }, -"revision": "20260610", +"revision": "20260722", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1031,7 +1031,7 @@ "id": "AccessConfig", "properties": { "externalIp": { -"description": "An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.", +"description": "Optional. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.", "type": "string" } }, @@ -1064,7 +1064,7 @@ "id": "BootDisk", "properties": { "diskEncryption": { -"description": "Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.", +"description": "Optional. Disk encryption method used on the boot and data disks, defaults to GMEK.", "enum": [ "DISK_ENCRYPTION_UNSPECIFIED", "GMEK", @@ -1111,7 +1111,7 @@ "type": "string" }, "kmsKey": { -"description": "Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys.", +"description": "Optional. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys.", "type": "string" } }, @@ -1250,7 +1250,7 @@ "id": "DataDisk", "properties": { "diskEncryption": { -"description": "Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.", +"description": "Optional. Disk encryption method used on the boot and data disks, defaults to GMEK.", "enum": [ "DISK_ENCRYPTION_UNSPECIFIED", "GMEK", @@ -1297,7 +1297,7 @@ "type": "string" }, "kmsKey": { -"description": "Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys.", +"description": "Optional. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys.", "type": "string" }, "resourcePolicies": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1.json b/googleapiclient/discovery_cache/documents/policysimulator.v1.json index 19499d2eaf..21d893233f 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1.json @@ -1061,7 +1061,7 @@ } } }, -"revision": "20260423", +"revision": "20260716", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -1170,7 +1170,7 @@ "type": "string" }, "name": { -"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", +"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", "type": "string" }, "spec": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json index edb77c9a12..adada176c0 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json @@ -640,7 +640,7 @@ } } }, -"revision": "20260423", +"revision": "20260716", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -749,7 +749,7 @@ "type": "string" }, "name": { -"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", +"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", "type": "string" }, "spec": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json index f8f1cd86a8..352e0a730f 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json @@ -1197,7 +1197,7 @@ } } }, -"revision": "20260423", +"revision": "20260716", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -1306,7 +1306,7 @@ "type": "string" }, "name": { -"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", +"description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint that this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_number}/policies/{constraint_name}` * `organizations/{organization_number}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", "type": "string" }, "spec": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1.json b/googleapiclient/discovery_cache/documents/pubsub.v1.json index f7c64188af..aad691ee2c 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json @@ -1798,7 +1798,7 @@ } } }, -"revision": "20260609", +"revision": "20260716", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AIInference": { @@ -2029,7 +2029,7 @@ "id": "BigQueryConfig", "properties": { "dropUnknownFields": { -"description": "Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.", +"description": "Optional. If true and `use_topic_schema` is true, drops any fields that are part of the topic schema that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. If true and `use_table_schema` is true, drops any fields in the message that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the write to BigQuery will fail.", "type": "boolean" }, "serviceAccountEmail": { diff --git a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json index d2c15e518e..42a309dfa6 100644 --- a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json +++ b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json @@ -207,7 +207,7 @@ } } }, -"revision": "20250611", +"revision": "20260719", "rootUrl": "https://readerrevenuesubscriptionlinking.googleapis.com/", "schemas": { "DeleteReaderResponse": { @@ -225,7 +225,7 @@ "type": "string" }, "expireTime": { -"description": "Required. Expiration time of the entitlement. Entitlements that have expired over 30 days will be purged. The max expire_time is 398 days from now().", +"description": "Optional. Expiration time of the entitlement. If unset, the entitlement does not expire (indefinite entitlement). We need to support indefinite entitlements for platform publishers. dd: go/rrm-sl-notedotcom Entitlements that have expired over 30 days will be purged.", "format": "google-datetime", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json index d60d0c638a..65dac49ac1 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2.json +++ b/googleapiclient/discovery_cache/documents/retail.v2.json @@ -2050,7 +2050,7 @@ "userEvents": { "methods": { "collect": { -"description": "Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", +"description": "Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the AI Commerce Search API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:collect", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.userEvents.collect", @@ -2353,7 +2353,7 @@ } } }, -"revision": "20260507", +"revision": "20260723", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4952,7 +4952,7 @@ "type": "string" }, "sizes": { -"description": "The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in \"US:MENS:M\", \"US\" represents size system; \"MENS\" represents size type; \"M\" represents size value. In \"GIRLS:27\", size system is empty; \"GIRLS\" represents size type; \"27\" represents size value. In \"32 inches\", both size system and size type are empty, while size value is \"32 inches\". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size).", +"description": "The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in \"US:MENS:M\", \"US\" represents size system; \"MENS\" represents size type; \"M\" represents size value. In \"GIRLS:27\", size system is empty; \"GIRLS\" represents size type; \"27\" represents size value. In \"32 inches\", both size system and size type are empty, while size value is \"32 inches\". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size).", "items": { "type": "string" }, @@ -6688,14 +6688,14 @@ "type": "object" }, "GoogleCloudRetailV2UserEvent": { -"description": "UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.", +"description": "UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website.", "id": "GoogleCloudRetailV2UserEvent", "properties": { "attributes": { "additionalProperties": { "$ref": "GoogleCloudRetailV2CustomAttribute" }, -"description": "Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", +"description": "Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", "type": "object" }, "attributionToken": { @@ -6724,7 +6724,7 @@ "type": "string" }, "experimentIds": { -"description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models).", +"description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models).", "items": { "type": "string" }, @@ -6950,7 +6950,7 @@ "id": "GoogleCloudRetailV2alphaEnrollSolutionResponse", "properties": { "enrolledSolution": { -"description": "Retail API solution that the project has enrolled.", +"description": "AI Commerce Search API solution that the project has enrolled.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index cb6b490006..859200c4a3 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -108,7 +108,7 @@ "projects": { "methods": { "enrollSolution": { -"description": "The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables Retail API, so you don't need to call the enrollSolution method for recommendations.", +"description": "The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables AI Commerce Search API, so you don't need to call the enrollSolution method for recommendations.", "flatPath": "v2alpha/projects/{projectsId}:enrollSolution", "httpMethod": "POST", "id": "retail.projects.enrollSolution", @@ -186,7 +186,7 @@ ] }, "getRetailProject": { -"description": "Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the Retail API service.", +"description": "Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the AI Commerce Search API service.", "flatPath": "v2alpha/projects/{projectsId}/retailProject", "httpMethod": "GET", "id": "retail.projects.getRetailProject", @@ -211,7 +211,7 @@ ] }, "listEnrolledSolutions": { -"description": "Lists all the retail API solutions the project has enrolled.", +"description": "Lists all the AI Commerce Search API solutions the project has enrolled.", "flatPath": "v2alpha/projects/{projectsId}:enrolledSolutions", "httpMethod": "GET", "id": "retail.projects.listEnrolledSolutions", @@ -2511,7 +2511,7 @@ "userEvents": { "methods": { "collect": { -"description": "Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", +"description": "Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the AI Commerce Search API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:collect", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.userEvents.collect", @@ -2874,7 +2874,7 @@ } } }, -"revision": "20260507", +"revision": "20260723", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5007,7 +5007,7 @@ "id": "GoogleCloudRetailV2alphaEnrollSolutionResponse", "properties": { "enrolledSolution": { -"description": "Retail API solution that the project has enrolled.", +"description": "AI Commerce Search API solution that the project has enrolled.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -5710,7 +5710,7 @@ "id": "GoogleCloudRetailV2alphaListEnrolledSolutionsResponse", "properties": { "enrolledSolutions": { -"description": "Retail API solutions that the project has enrolled.", +"description": "AI Commerce Search API solutions that the project has enrolled.", "items": { "enum": [ "SOLUTION_TYPE_UNSPECIFIED", @@ -6802,7 +6802,7 @@ "type": "string" }, "sizes": { -"description": "The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in \"US:MENS:M\", \"US\" represents size system; \"MENS\" represents size type; \"M\" represents size value. In \"GIRLS:27\", size system is empty; \"GIRLS\" represents size type; \"27\" represents size value. In \"32 inches\", both size system and size type are empty, while size value is \"32 inches\". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size).", +"description": "The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in \"US:MENS:M\", \"US\" represents size system; \"MENS\" represents size type; \"M\" represents size value. In \"GIRLS:27\", size system is empty; \"GIRLS\" represents size type; \"27\" represents size value. In \"32 inches\", both size system and size type are empty, while size value is \"32 inches\". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size).", "items": { "type": "string" }, @@ -6954,7 +6954,7 @@ "id": "GoogleCloudRetailV2alphaProject", "properties": { "enrolledSolutions": { -"description": "Output only. Retail API solutions that the project has enrolled.", +"description": "Output only. AI Commerce Search API solutions that the project has enrolled.", "items": { "enum": [ "SOLUTION_TYPE_UNSPECIFIED", @@ -8607,14 +8607,14 @@ "type": "object" }, "GoogleCloudRetailV2alphaUserEvent": { -"description": "UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.", +"description": "UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website.", "id": "GoogleCloudRetailV2alphaUserEvent", "properties": { "attributes": { "additionalProperties": { "$ref": "GoogleCloudRetailV2alphaCustomAttribute" }, -"description": "Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", +"description": "Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", "type": "object" }, "attributionToken": { @@ -8643,7 +8643,7 @@ "type": "string" }, "experimentIds": { -"description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models).", +"description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models).", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index cff1019ce4..e2a689e782 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -2167,7 +2167,7 @@ "userEvents": { "methods": { "collect": { -"description": "Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", +"description": "Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the AI Commerce Search API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:collect", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.userEvents.collect", @@ -2498,7 +2498,7 @@ } } }, -"revision": "20260507", +"revision": "20260723", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3294,7 +3294,7 @@ "id": "GoogleCloudRetailV2alphaEnrollSolutionResponse", "properties": { "enrolledSolution": { -"description": "Retail API solution that the project has enrolled.", +"description": "AI Commerce Search API solution that the project has enrolled.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -6762,7 +6762,7 @@ "type": "string" }, "sizes": { -"description": "The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in \"US:MENS:M\", \"US\" represents size system; \"MENS\" represents size type; \"M\" represents size value. In \"GIRLS:27\", size system is empty; \"GIRLS\" represents size type; \"27\" represents size value. In \"32 inches\", both size system and size type are empty, while size value is \"32 inches\". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size).", +"description": "The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in \"US:MENS:M\", \"US\" represents size system; \"MENS\" represents size type; \"M\" represents size value. In \"GIRLS:27\", size system is empty; \"GIRLS\" represents size type; \"27\" represents size value. In \"32 inches\", both size system and size type are empty, while size value is \"32 inches\". A maximum of 20 values are allowed per Product by default. This limit can be increased using dynamic override configurations. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size).", "items": { "type": "string" }, @@ -8498,14 +8498,14 @@ "type": "object" }, "GoogleCloudRetailV2betaUserEvent": { -"description": "UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.", +"description": "UserEvent captures all metadata information AI Commerce Search API needs to know about how end users interact with customers' website.", "id": "GoogleCloudRetailV2betaUserEvent", "properties": { "attributes": { "additionalProperties": { "$ref": "GoogleCloudRetailV2betaCustomAttribute" }, -"description": "Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", +"description": "Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", "type": "object" }, "attributionToken": { @@ -8534,7 +8534,7 @@ "type": "string" }, "experimentIds": { -"description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models).", +"description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models).", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json index 2e3c9613ab..222118cf0f 100644 --- a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json @@ -1248,7 +1248,7 @@ } } }, -"revision": "20260602", +"revision": "20260708", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -1260,7 +1260,7 @@ "type": "string" }, "domain": { -"description": "Optional. Human readable form of a domain such as \u201cgoogle.com\u201d.", +"description": "Optional. Human readable form of a domain such as `example.com`.", "type": "string" }, "domainUsername": {